Gleanex.Indexing.Permissions (Gleanex v0.1.0)

Copy Markdown View Source

Provides API endpoints related to permissions

Summary

Functions

betausers(body, opts \\ [])

Beta users

bulkindexgroups(body, opts \\ [])

Bulk index groups

bulkindexmemberships(body, opts \\ [])

Bulk index memberships for a group

bulkindexusers(body, opts \\ [])

Bulk index users

deletegroup(body, opts \\ [])

Delete group

deletemembership(body, opts \\ [])

Delete membership

deleteuser(body, opts \\ [])

Delete user

indexgroup(body, opts \\ [])

Index group

indexmembership(body, opts \\ [])

Index membership

indexuser(body, opts \\ [])

Index user

processallmemberships(body, opts \\ [])

Schedules the processing of group memberships

Functions

betausers(body, opts \\ [])

@spec betausers(body :: Gleanex.Indexing.GreenlistUsersRequest.t(), opts :: keyword()) ::
  :ok | {:error, Gleanex.Error.t()}

Beta users

Allow the datasource be visible to the specified beta users. The default behaviour is datasource being visible to all users if it is enabled and not visible to any user if it is not enabled.

Request Body

Content Types: application/json

bulkindexgroups(body, opts \\ [])

@spec bulkindexgroups(
  body :: Gleanex.Indexing.BulkIndexGroupsRequest.t(),
  opts :: keyword()
) ::
  :ok | {:error, Gleanex.Error.t()}

Bulk index groups

Replaces the groups in a datasource using paginated batch API calls. Please refer to the bulk indexing documentation for an explanation of how to use bulk endpoints. Note: Any groups deleted from the existing set will have their associated memberships deleted as well.

Request Body

Content Types: application/json

bulkindexmemberships(body, opts \\ [])

@spec bulkindexmemberships(
  body :: Gleanex.Indexing.BulkIndexMembershipsRequest.t(),
  opts :: keyword()
) :: :ok | {:error, Gleanex.Error.t()}

Bulk index memberships for a group

Replaces the memberships for a group in a datasource using paginated batch API calls. Please refer to the bulk indexing documentation for an explanation of how to use bulk endpoints.

Request Body

Content Types: application/json

bulkindexusers(body, opts \\ [])

@spec bulkindexusers(
  body :: Gleanex.Indexing.BulkIndexUsersRequest.t(),
  opts :: keyword()
) ::
  :ok | {:error, Gleanex.Error.t()}

Bulk index users

Replaces the users in a datasource using paginated batch API calls. Please refer to the bulk indexing documentation for an explanation of how to use bulk endpoints. Note: Any users deleted from the existing set will have their associated memberships deleted as well.

Request Body

Content Types: application/json

deletegroup(body, opts \\ [])

@spec deletegroup(body :: Gleanex.Indexing.DeleteGroupRequest.t(), opts :: keyword()) ::
  :ok | {:error, Gleanex.Error.t()}

Delete group

Delete group from the datasource. Silently succeeds if group is not present. Note: All memberships associated with the deleted group will also be deleted.

Request Body

Content Types: application/json

deletemembership(body, opts \\ [])

@spec deletemembership(
  body :: Gleanex.Indexing.DeleteMembershipRequest.t(),
  opts :: keyword()
) ::
  :ok | {:error, Gleanex.Error.t()}

Delete membership

Delete membership to a group in the specified datasource. Silently succeeds if membership is not present.

Request Body

Content Types: application/json

deleteuser(body, opts \\ [])

@spec deleteuser(body :: Gleanex.Indexing.DeleteUserRequest.t(), opts :: keyword()) ::
  :ok | {:error, Gleanex.Error.t()}

Delete user

Delete the user from the datasource. Silently succeeds if user is not present. Note: All memberships associated with the deleted user will also be deleted.

Request Body

Content Types: application/json

indexgroup(body, opts \\ [])

@spec indexgroup(body :: Gleanex.Indexing.IndexGroupRequest.t(), opts :: keyword()) ::
  :ok | {:error, Gleanex.Error.t()}

Index group

Add or update a group in the datasource.

Request Body

Content Types: application/json

indexmembership(body, opts \\ [])

@spec indexmembership(
  body :: Gleanex.Indexing.IndexMembershipRequest.t(),
  opts :: keyword()
) ::
  :ok | {:error, Gleanex.Error.t()}

Index membership

Add the memberships of a group in the datasource.

Request Body

Content Types: application/json

indexuser(body, opts \\ [])

@spec indexuser(body :: Gleanex.Indexing.IndexUserRequest.t(), opts :: keyword()) ::
  :ok | {:error, Gleanex.Error.t()}

Index user

Adds a datasource user or updates an existing user.

Request Body

Content Types: application/json

processallmemberships(body, opts \\ [])

@spec processallmemberships(
  body :: Gleanex.Indexing.ProcessAllMembershipsRequest.t(),
  opts :: keyword()
) :: :ok | {:error, Gleanex.Error.t()}

Schedules the processing of group memberships

Schedules the immediate processing of all group memberships uploaded through the indexing API. By default the uploaded group memberships will be processed asynchronously but this API can be used to schedule processing of all memberships on demand.

Request Body

Content Types: application/json