Package com.mypurecloud.sdk.v2.api
Class AuthorizationApiAsync
java.lang.Object
com.mypurecloud.sdk.v2.api.AuthorizationApiAsync
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptiondeleteAuthorizationDivisionAsync(DeleteAuthorizationDivisionRequest request, AsyncApiCallback<Void> callback) Delete a division.deleteAuthorizationDivisionAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Void>> callback) Delete a division.deleteAuthorizationPoliciesTargetSubjectSubjectIdAsync(DeleteAuthorizationPoliciesTargetSubjectSubjectIdRequest request, AsyncApiCallback<Void> callback) Delete an access control policydeleteAuthorizationPoliciesTargetSubjectSubjectIdAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Void>> callback) Delete an access control policydeleteAuthorizationRoleAsync(DeleteAuthorizationRoleRequest request, AsyncApiCallback<Void> callback) Delete an organization role.deleteAuthorizationRoleAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Void>> callback) Delete an organization role.deleteAuthorizationSubjectDivisionRoleAsync(DeleteAuthorizationSubjectDivisionRoleRequest request, AsyncApiCallback<Void> callback) Delete a grant of a role in a divisiondeleteAuthorizationSubjectDivisionRoleAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Void>> callback) Delete a grant of a role in a divisiongetAuthorizationDivisionAsync(GetAuthorizationDivisionRequest request, AsyncApiCallback<AuthzDivision> callback) Returns an authorization division.getAuthorizationDivisionAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<AuthzDivision>> callback) Returns an authorization division.getAuthorizationDivisionGrantsAsync(GetAuthorizationDivisionGrantsRequest request, AsyncApiCallback<AuthzDivisionGrantEntityListing> callback) Gets all grants for a given division.getAuthorizationDivisionGrantsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<AuthzDivisionGrantEntityListing>> callback) Gets all grants for a given division.getAuthorizationDivisionsAsync(GetAuthorizationDivisionsRequest request, AsyncApiCallback<AuthzDivisionEntityListing> callback) Retrieve a list of all divisions defined for the organization Request specific divisions by id using a query param \"id\", e.g. ?getAuthorizationDivisionsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<AuthzDivisionEntityListing>> callback) Retrieve a list of all divisions defined for the organization Request specific divisions by id using a query param \"id\", e.g. ?getAuthorizationDivisionsDeletedAsync(GetAuthorizationDivisionsDeletedRequest request, AsyncApiCallback<AuthzDivisionEntityListing> callback) Get a list of soft deleted divisions for the orggetAuthorizationDivisionsDeletedAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<AuthzDivisionEntityListing>> callback) Get a list of soft deleted divisions for the orggetAuthorizationDivisionsHomeAsync(GetAuthorizationDivisionsHomeRequest request, AsyncApiCallback<AuthzDivision> callback) Retrieve the home division for the organization.getAuthorizationDivisionsHomeAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<AuthzDivision>> callback) Retrieve the home division for the organization.getAuthorizationDivisionsLimitAsync(GetAuthorizationDivisionsLimitRequest request, AsyncApiCallback<Integer> callback) Returns the maximum allowed number of divisions.getAuthorizationDivisionsLimitAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Integer>> callback) Returns the maximum allowed number of divisions.getAuthorizationDivisionspermittedMeAsync(GetAuthorizationDivisionspermittedMeRequest request, AsyncApiCallback<List<AuthzDivision>> callback) Deprecated.getAuthorizationDivisionspermittedMeAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<List<AuthzDivision>>> callback) Deprecated.getAuthorizationDivisionspermittedPagedMeAsync(GetAuthorizationDivisionspermittedPagedMeRequest request, AsyncApiCallback<DivsPermittedEntityListing> callback) Returns which divisions the current user has the given permission in.getAuthorizationDivisionspermittedPagedMeAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<DivsPermittedEntityListing>> callback) Returns which divisions the current user has the given permission in.getAuthorizationDivisionspermittedPagedSubjectIdAsync(GetAuthorizationDivisionspermittedPagedSubjectIdRequest request, AsyncApiCallback<DivsPermittedEntityListing> callback) Deprecated.getAuthorizationDivisionspermittedPagedSubjectIdAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<DivsPermittedEntityListing>> callback) Deprecated.getAuthorizationDivisionsQueryAsync(GetAuthorizationDivisionsQueryRequest request, AsyncApiCallback<AuthzDivisionCursorListing> callback) Retrieve a list of all divisions defined for the organization with cursor Use \"after\" and \"before\" param to fetch next/previous page}getAuthorizationDivisionsQueryAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<AuthzDivisionCursorListing>> callback) Retrieve a list of all divisions defined for the organization with cursor Use \"after\" and \"before\" param to fetch next/previous page}getAuthorizationPermissionsAsync(GetAuthorizationPermissionsRequest request, AsyncApiCallback<PermissionCollectionEntityListing> callback) Get all permissions.getAuthorizationPermissionsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<PermissionCollectionEntityListing>> callback) Get all permissions.getAuthorizationPoliciesAsync(GetAuthorizationPoliciesRequest request, AsyncApiCallback<AuthorizationPolicyEntityListing> callback) Get a page of access policies for an organizationgetAuthorizationPoliciesAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<AuthorizationPolicyEntityListing>> callback) Get a page of access policies for an organizationgetAuthorizationPoliciesSubjectSubjectIdAsync(GetAuthorizationPoliciesSubjectSubjectIdRequest request, AsyncApiCallback<AuthorizationPolicyEntityListing> callback) Get a page of access policies for a given subjectgetAuthorizationPoliciesSubjectSubjectIdAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<AuthorizationPolicyEntityListing>> callback) Get a page of access policies for a given subjectgetAuthorizationPoliciesTargetAsync(GetAuthorizationPoliciesTargetRequest request, AsyncApiCallback<AuthorizationPolicyEntityListing> callback) Get a page of access policies for a given policy targetgetAuthorizationPoliciesTargetAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<AuthorizationPolicyEntityListing>> callback) Get a page of access policies for a given policy targetgetAuthorizationPoliciesTargetsAsync(GetAuthorizationPoliciesTargetsRequest request, AsyncApiCallback<TargetAttributes> callback) Get a map of policy targets to valid attributes for those targetsgetAuthorizationPoliciesTargetsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<TargetAttributes>> callback) Get a map of policy targets to valid attributes for those targetsgetAuthorizationPoliciesTargetSubjectSubjectIdAsync(GetAuthorizationPoliciesTargetSubjectSubjectIdRequest request, AsyncApiCallback<AuthorizationPolicy> callback) Get an access control policy for a specified resource target and subjectgetAuthorizationPoliciesTargetSubjectSubjectIdAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<AuthorizationPolicy>> callback) Get an access control policy for a specified resource target and subjectgetAuthorizationPolicyAsync(GetAuthorizationPolicyRequest request, AsyncApiCallback<AuthorizationPolicy> callback) Get an access control policy with the specified policy IDgetAuthorizationPolicyAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<AuthorizationPolicy>> callback) Get an access control policy with the specified policy IDgetAuthorizationPolicyAttributesAsync(GetAuthorizationPolicyAttributesRequest request, AsyncApiCallback<PolicyAttributeSet> callback) Get the list of attributes used to evaluate an access control policy with the specified policy IDgetAuthorizationPolicyAttributesAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<PolicyAttributeSet>> callback) Get the list of attributes used to evaluate an access control policy with the specified policy IDgetAuthorizationProductsAsync(GetAuthorizationProductsRequest request, AsyncApiCallback<OrganizationProductEntityListing> callback) Get the list of enabled products Gets the list of enabled products.getAuthorizationProductsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<OrganizationProductEntityListing>> callback) Get the list of enabled products Gets the list of enabled products.getAuthorizationRoleAsync(GetAuthorizationRoleRequest request, AsyncApiCallback<DomainOrganizationRole> callback) Get a single organization role.getAuthorizationRoleAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<DomainOrganizationRole>> callback) Get a single organization role.getAuthorizationRoleComparedefaultRightRoleIdAsync(GetAuthorizationRoleComparedefaultRightRoleIdRequest request, AsyncApiCallback<DomainOrgRoleDifference> callback) Get an org role to default role comparison Compares any organization role to a default role id and show differencesgetAuthorizationRoleComparedefaultRightRoleIdAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<DomainOrgRoleDifference>> callback) Get an org role to default role comparison Compares any organization role to a default role id and show differencesgetAuthorizationRolesAsync(GetAuthorizationRolesRequest request, AsyncApiCallback<OrganizationRoleEntityListing> callback) Retrieve a list of all roles defined for the organizationgetAuthorizationRolesAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<OrganizationRoleEntityListing>> callback) Retrieve a list of all roles defined for the organizationgetAuthorizationRolesSettingsAsync(GetAuthorizationRolesSettingsRequest request, AsyncApiCallback<RoleSettings> callback) Get authorization role settingsgetAuthorizationRolesSettingsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<RoleSettings>> callback) Get authorization role settingsgetAuthorizationRoleSubjectgrantsAsync(GetAuthorizationRoleSubjectgrantsRequest request, AsyncApiCallback<SubjectDivisionGrantsEntityListing> callback) Get the subjects' granted divisions in the specified role.getAuthorizationRoleSubjectgrantsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<SubjectDivisionGrantsEntityListing>> callback) Get the subjects' granted divisions in the specified role.getAuthorizationRoleUsersAsync(GetAuthorizationRoleUsersRequest request, AsyncApiCallback<UserReferenceEntityListing> callback) Get a list of the users in a specified role.getAuthorizationRoleUsersAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<UserReferenceEntityListing>> callback) Get a list of the users in a specified role.getAuthorizationSettingsAsync(GetAuthorizationSettingsRequest request, AsyncApiCallback<AuthorizationSettings> callback) Get authorization settingsgetAuthorizationSettingsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<AuthorizationSettings>> callback) Get authorization settingsgetAuthorizationSubjectAsync(GetAuthorizationSubjectRequest request, AsyncApiCallback<AuthzSubject> callback) Returns a listing of roles and permissions for a user.getAuthorizationSubjectAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<AuthzSubject>> callback) Returns a listing of roles and permissions for a user.getAuthorizationSubjectsMeAsync(GetAuthorizationSubjectsMeRequest request, AsyncApiCallback<AuthzSubject> callback) Returns a listing of roles and permissions for the currently authenticated user.getAuthorizationSubjectsMeAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<AuthzSubject>> callback) Returns a listing of roles and permissions for the currently authenticated user.getAuthorizationSubjectsRolecountsAsync(GetAuthorizationSubjectsRolecountsRequest request, AsyncApiCallback<Map<String, Object>> callback) Get the count of roles granted to a list of subjectsgetAuthorizationSubjectsRolecountsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Map<String, Object>>> callback) Get the count of roles granted to a list of subjectsgetUserRolesAsync(GetUserRolesRequest request, AsyncApiCallback<UserAuthorization> callback) Returns a listing of roles and permissions for a user.getUserRolesAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<UserAuthorization>> callback) Returns a listing of roles and permissions for a user.patchAuthorizationRoleAsync(PatchAuthorizationRoleRequest request, AsyncApiCallback<DomainOrganizationRole> callback) Patch Organization Role for needsUpdate Field Patch Organization Role for needsUpdate FieldpatchAuthorizationRoleAsync(ApiRequest<DomainOrganizationRole> request, AsyncApiCallback<ApiResponse<DomainOrganizationRole>> callback) Patch Organization Role for needsUpdate Field Patch Organization Role for needsUpdate FieldpatchAuthorizationSettingsAsync(PatchAuthorizationSettingsRequest request, AsyncApiCallback<AuthorizationSettings> callback) Change authorization settings Change authorization settingspatchAuthorizationSettingsAsync(ApiRequest<AuthorizationSettings> request, AsyncApiCallback<ApiResponse<AuthorizationSettings>> callback) Change authorization settings Change authorization settingspostAuthorizationDivisionObjectAsync(PostAuthorizationDivisionObjectRequest request, AsyncApiCallback<Void> callback) Assign a list of objects to a division Set the division of a specified list of objects.postAuthorizationDivisionObjectAsync(ApiRequest<List<String>> request, AsyncApiCallback<ApiResponse<Void>> callback) Assign a list of objects to a division Set the division of a specified list of objects.postAuthorizationDivisionRestoreAsync(PostAuthorizationDivisionRestoreRequest request, AsyncApiCallback<AuthzDivision> callback) Recreate a previously deleted division.postAuthorizationDivisionRestoreAsync(ApiRequest<AuthzDivision> request, AsyncApiCallback<ApiResponse<AuthzDivision>> callback) Recreate a previously deleted division.postAuthorizationDivisionsAsync(PostAuthorizationDivisionsRequest request, AsyncApiCallback<AuthzDivision> callback) Create a division.postAuthorizationDivisionsAsync(ApiRequest<AuthzDivision> request, AsyncApiCallback<ApiResponse<AuthzDivision>> callback) Create a division.postAuthorizationPoliciesTargetAsync(PostAuthorizationPoliciesTargetRequest request, AsyncApiCallback<AuthorizationPolicy> callback) Add an access control policy for a specified resource target and subjectpostAuthorizationPoliciesTargetAsync(ApiRequest<AuthorizationPolicy> request, AsyncApiCallback<ApiResponse<AuthorizationPolicy>> callback) Add an access control policy for a specified resource target and subjectpostAuthorizationPoliciesTargetValidateAsync(PostAuthorizationPoliciesTargetValidateRequest request, AsyncApiCallback<ValidationErrorListing> callback) Validate the conditions and attributes of an access control policy for a specified resource targetpostAuthorizationPoliciesTargetValidateAsync(ApiRequest<AuthorizationPolicy> request, AsyncApiCallback<ApiResponse<ValidationErrorListing>> callback) Validate the conditions and attributes of an access control policy for a specified resource targetpostAuthorizationPolicySimulateAsync(PostAuthorizationPolicySimulateRequest request, AsyncApiCallback<PolicyTestResult> callback) Simulate a request and evaluate the specified policy ID against the provided valuespostAuthorizationPolicySimulateAsync(ApiRequest<PolicyTestPayload> request, AsyncApiCallback<ApiResponse<PolicyTestResult>> callback) Simulate a request and evaluate the specified policy ID against the provided valuespostAuthorizationRoleAsync(PostAuthorizationRoleRequest request, AsyncApiCallback<Void> callback) Bulk-grant subjects and divisions with an organization role.postAuthorizationRoleAsync(ApiRequest<SubjectDivisions> request, AsyncApiCallback<ApiResponse<Void>> callback) Bulk-grant subjects and divisions with an organization role.postAuthorizationRoleComparedefaultRightRoleIdAsync(PostAuthorizationRoleComparedefaultRightRoleIdRequest request, AsyncApiCallback<DomainOrgRoleDifference> callback) Get an unsaved org role to default role comparison Allows users to compare their existing roles in an unsaved state to its default rolepostAuthorizationRoleComparedefaultRightRoleIdAsync(ApiRequest<DomainOrganizationRole> request, AsyncApiCallback<ApiResponse<DomainOrgRoleDifference>> callback) Get an unsaved org role to default role comparison Allows users to compare their existing roles in an unsaved state to its default rolepostAuthorizationRolesAsync(PostAuthorizationRolesRequest request, AsyncApiCallback<DomainOrganizationRole> callback) Create an organization role.postAuthorizationRolesAsync(ApiRequest<DomainOrganizationRoleCreate> request, AsyncApiCallback<ApiResponse<DomainOrganizationRole>> callback) Create an organization role.postAuthorizationRolesDefaultAsync(PostAuthorizationRolesDefaultRequest request, AsyncApiCallback<OrganizationRoleEntityListing> callback) Restores all default roles This endpoint serves several purposes. 1.postAuthorizationRolesDefaultAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<OrganizationRoleEntityListing>> callback) Restores all default roles This endpoint serves several purposes. 1.postAuthorizationSubjectBulkaddAsync(PostAuthorizationSubjectBulkaddRequest request, AsyncApiCallback<Void> callback) Bulk-grant roles and divisions to a subject.postAuthorizationSubjectBulkaddAsync(ApiRequest<RoleDivisionGrants> request, AsyncApiCallback<ApiResponse<Void>> callback) Bulk-grant roles and divisions to a subject.postAuthorizationSubjectBulkremoveAsync(PostAuthorizationSubjectBulkremoveRequest request, AsyncApiCallback<Void> callback) Bulk-remove grants from a subject.postAuthorizationSubjectBulkremoveAsync(ApiRequest<RoleDivisionGrants> request, AsyncApiCallback<ApiResponse<Void>> callback) Bulk-remove grants from a subject.postAuthorizationSubjectBulkreplaceAsync(PostAuthorizationSubjectBulkreplaceRequest request, AsyncApiCallback<Void> callback) Replace subject's roles and divisions with the exact list supplied in the request.postAuthorizationSubjectBulkreplaceAsync(ApiRequest<RoleDivisionGrants> request, AsyncApiCallback<ApiResponse<Void>> callback) Replace subject's roles and divisions with the exact list supplied in the request.postAuthorizationSubjectDivisionRoleAsync(PostAuthorizationSubjectDivisionRoleRequest request, AsyncApiCallback<Void> callback) Make a grant of a role in a divisionpostAuthorizationSubjectDivisionRoleAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Void>> callback) Make a grant of a role in a divisionputAuthorizationDivisionAsync(PutAuthorizationDivisionRequest request, AsyncApiCallback<AuthzDivision> callback) Update a division.putAuthorizationDivisionAsync(ApiRequest<AuthzDivision> request, AsyncApiCallback<ApiResponse<AuthzDivision>> callback) Update a division.putAuthorizationPoliciesTargetAsync(PutAuthorizationPoliciesTargetRequest request, AsyncApiCallback<AuthorizationPolicy> callback) Add an access control policy for a specified resource target and subject, overwriting any existing policyputAuthorizationPoliciesTargetAsync(ApiRequest<AuthorizationPolicy> request, AsyncApiCallback<ApiResponse<AuthorizationPolicy>> callback) Add an access control policy for a specified resource target and subject, overwriting any existing policyputAuthorizationPolicyAsync(PutAuthorizationPolicyRequest request, AsyncApiCallback<AuthorizationPolicy> callback) Update an access control policy with a given IDputAuthorizationPolicyAsync(ApiRequest<AuthorizationPolicy> request, AsyncApiCallback<ApiResponse<AuthorizationPolicy>> callback) Update an access control policy with a given IDputAuthorizationRoleAsync(PutAuthorizationRoleRequest request, AsyncApiCallback<DomainOrganizationRole> callback) Update an organization role.putAuthorizationRoleAsync(ApiRequest<DomainOrganizationRoleUpdate> request, AsyncApiCallback<ApiResponse<DomainOrganizationRole>> callback) Update an organization role.putAuthorizationRolesDefaultAsync(PutAuthorizationRolesDefaultRequest request, AsyncApiCallback<OrganizationRoleEntityListing> callback) Restore specified default rolesputAuthorizationRolesDefaultAsync(ApiRequest<List<DomainOrganizationRole>> request, AsyncApiCallback<ApiResponse<OrganizationRoleEntityListing>> callback) Restore specified default rolesputAuthorizationRolesSettingsAsync(PutAuthorizationRolesSettingsRequest request, AsyncApiCallback<RoleSettings> callback) Change authorization role settings Change role settingsputAuthorizationRolesSettingsAsync(ApiRequest<RoleSettings> request, AsyncApiCallback<ApiResponse<RoleSettings>> callback) Change authorization role settings Change role settingsputAuthorizationRoleUsersAddAsync(PutAuthorizationRoleUsersAddRequest request, AsyncApiCallback<List<String>> callback) Sets the users for the roleputAuthorizationRoleUsersAddAsync(ApiRequest<List<String>> request, AsyncApiCallback<ApiResponse<List<String>>> callback) Sets the users for the roleputAuthorizationRoleUsersRemoveAsync(PutAuthorizationRoleUsersRemoveRequest request, AsyncApiCallback<List<String>> callback) Removes the users from the roleputAuthorizationRoleUsersRemoveAsync(ApiRequest<List<String>> request, AsyncApiCallback<ApiResponse<List<String>>> callback) Removes the users from the roleputUserRolesAsync(PutUserRolesRequest request, AsyncApiCallback<UserAuthorization> callback) Sets the user's rolesputUserRolesAsync(ApiRequest<List<String>> request, AsyncApiCallback<ApiResponse<UserAuthorization>> callback) Sets the user's roles
-
Constructor Details
-
AuthorizationApiAsync
public AuthorizationApiAsync() -
AuthorizationApiAsync
-
-
Method Details
-
deleteAuthorizationDivisionAsync
public Future<Void> deleteAuthorizationDivisionAsync(DeleteAuthorizationDivisionRequest request, AsyncApiCallback<Void> callback) Delete a division.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
deleteAuthorizationDivisionAsync
public Future<ApiResponse<Void>> deleteAuthorizationDivisionAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Void>> callback) Delete a division.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
deleteAuthorizationPoliciesTargetSubjectSubjectIdAsync
public Future<Void> deleteAuthorizationPoliciesTargetSubjectSubjectIdAsync(DeleteAuthorizationPoliciesTargetSubjectSubjectIdRequest request, AsyncApiCallback<Void> callback) Delete an access control policy- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
deleteAuthorizationPoliciesTargetSubjectSubjectIdAsync
public Future<ApiResponse<Void>> deleteAuthorizationPoliciesTargetSubjectSubjectIdAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Void>> callback) Delete an access control policy- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
deleteAuthorizationRoleAsync
public Future<Void> deleteAuthorizationRoleAsync(DeleteAuthorizationRoleRequest request, AsyncApiCallback<Void> callback) Delete an organization role.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
deleteAuthorizationRoleAsync
public Future<ApiResponse<Void>> deleteAuthorizationRoleAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Void>> callback) Delete an organization role.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
deleteAuthorizationSubjectDivisionRoleAsync
public Future<Void> deleteAuthorizationSubjectDivisionRoleAsync(DeleteAuthorizationSubjectDivisionRoleRequest request, AsyncApiCallback<Void> callback) Delete a grant of a role in a division- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
deleteAuthorizationSubjectDivisionRoleAsync
public Future<ApiResponse<Void>> deleteAuthorizationSubjectDivisionRoleAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Void>> callback) Delete a grant of a role in a division- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationDivisionAsync
public Future<AuthzDivision> getAuthorizationDivisionAsync(GetAuthorizationDivisionRequest request, AsyncApiCallback<AuthzDivision> callback) Returns an authorization division.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationDivisionAsync
public Future<ApiResponse<AuthzDivision>> getAuthorizationDivisionAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<AuthzDivision>> callback) Returns an authorization division.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationDivisionGrantsAsync
public Future<AuthzDivisionGrantEntityListing> getAuthorizationDivisionGrantsAsync(GetAuthorizationDivisionGrantsRequest request, AsyncApiCallback<AuthzDivisionGrantEntityListing> callback) Gets all grants for a given division. Returns all grants assigned to a given division. Maximum page size is 500.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationDivisionGrantsAsync
public Future<ApiResponse<AuthzDivisionGrantEntityListing>> getAuthorizationDivisionGrantsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<AuthzDivisionGrantEntityListing>> callback) Gets all grants for a given division. Returns all grants assigned to a given division. Maximum page size is 500.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationDivisionsAsync
public Future<AuthzDivisionEntityListing> getAuthorizationDivisionsAsync(GetAuthorizationDivisionsRequest request, AsyncApiCallback<AuthzDivisionEntityListing> callback) Retrieve a list of all divisions defined for the organization Request specific divisions by id using a query param \"id\", e.g. ?id=5f777167-63be-4c24-ad41-374155d9e28b&id=72e9fb25-c484-488d-9312-7acba82435b3- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationDivisionsAsync
public Future<ApiResponse<AuthzDivisionEntityListing>> getAuthorizationDivisionsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<AuthzDivisionEntityListing>> callback) Retrieve a list of all divisions defined for the organization Request specific divisions by id using a query param \"id\", e.g. ?id=5f777167-63be-4c24-ad41-374155d9e28b&id=72e9fb25-c484-488d-9312-7acba82435b3- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationDivisionsDeletedAsync
public Future<AuthzDivisionEntityListing> getAuthorizationDivisionsDeletedAsync(GetAuthorizationDivisionsDeletedRequest request, AsyncApiCallback<AuthzDivisionEntityListing> callback) Get a list of soft deleted divisions for the org- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationDivisionsDeletedAsync
public Future<ApiResponse<AuthzDivisionEntityListing>> getAuthorizationDivisionsDeletedAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<AuthzDivisionEntityListing>> callback) Get a list of soft deleted divisions for the org- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationDivisionsHomeAsync
public Future<AuthzDivision> getAuthorizationDivisionsHomeAsync(GetAuthorizationDivisionsHomeRequest request, AsyncApiCallback<AuthzDivision> callback) Retrieve the home division for the organization. Will not include object counts.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationDivisionsHomeAsync
public Future<ApiResponse<AuthzDivision>> getAuthorizationDivisionsHomeAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<AuthzDivision>> callback) Retrieve the home division for the organization. Will not include object counts.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationDivisionsLimitAsync
public Future<Integer> getAuthorizationDivisionsLimitAsync(GetAuthorizationDivisionsLimitRequest request, AsyncApiCallback<Integer> callback) Returns the maximum allowed number of divisions.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationDivisionsLimitAsync
public Future<ApiResponse<Integer>> getAuthorizationDivisionsLimitAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Integer>> callback) Returns the maximum allowed number of divisions.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationDivisionsQueryAsync
public Future<AuthzDivisionCursorListing> getAuthorizationDivisionsQueryAsync(GetAuthorizationDivisionsQueryRequest request, AsyncApiCallback<AuthzDivisionCursorListing> callback) Retrieve a list of all divisions defined for the organization with cursor Use \"after\" and \"before\" param to fetch next/previous page}- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationDivisionsQueryAsync
public Future<ApiResponse<AuthzDivisionCursorListing>> getAuthorizationDivisionsQueryAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<AuthzDivisionCursorListing>> callback) Retrieve a list of all divisions defined for the organization with cursor Use \"after\" and \"before\" param to fetch next/previous page}- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationDivisionspermittedMeAsync
public Future<List<AuthzDivision>> getAuthorizationDivisionspermittedMeAsync(GetAuthorizationDivisionspermittedMeRequest request, AsyncApiCallback<List<AuthzDivision>> callback) Deprecated.Returns which divisions the current user has the given permission in. This route is deprecated, use authorization/divisionspermitted/paged/me instead.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationDivisionspermittedMeAsync
public Future<ApiResponse<List<AuthzDivision>>> getAuthorizationDivisionspermittedMeAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<List<AuthzDivision>>> callback) Deprecated.Returns which divisions the current user has the given permission in. This route is deprecated, use authorization/divisionspermitted/paged/me instead.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationDivisionspermittedPagedMeAsync
public Future<DivsPermittedEntityListing> getAuthorizationDivisionspermittedPagedMeAsync(GetAuthorizationDivisionspermittedPagedMeRequest request, AsyncApiCallback<DivsPermittedEntityListing> callback) Returns which divisions the current user has the given permission in.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationDivisionspermittedPagedMeAsync
public Future<ApiResponse<DivsPermittedEntityListing>> getAuthorizationDivisionspermittedPagedMeAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<DivsPermittedEntityListing>> callback) Returns which divisions the current user has the given permission in.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationDivisionspermittedPagedSubjectIdAsync
public Future<DivsPermittedEntityListing> getAuthorizationDivisionspermittedPagedSubjectIdAsync(GetAuthorizationDivisionspermittedPagedSubjectIdRequest request, AsyncApiCallback<DivsPermittedEntityListing> callback) Deprecated.Returns which divisions the specified user has the given permission in. This route is deprecated, use authorization/divisionspermitted/paged/me instead.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationDivisionspermittedPagedSubjectIdAsync
public Future<ApiResponse<DivsPermittedEntityListing>> getAuthorizationDivisionspermittedPagedSubjectIdAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<DivsPermittedEntityListing>> callback) Deprecated.Returns which divisions the specified user has the given permission in. This route is deprecated, use authorization/divisionspermitted/paged/me instead.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationPermissionsAsync
public Future<PermissionCollectionEntityListing> getAuthorizationPermissionsAsync(GetAuthorizationPermissionsRequest request, AsyncApiCallback<PermissionCollectionEntityListing> callback) Get all permissions. Retrieve a list of all permission defined in the system.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationPermissionsAsync
public Future<ApiResponse<PermissionCollectionEntityListing>> getAuthorizationPermissionsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<PermissionCollectionEntityListing>> callback) Get all permissions. Retrieve a list of all permission defined in the system.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationPoliciesAsync
public Future<AuthorizationPolicyEntityListing> getAuthorizationPoliciesAsync(GetAuthorizationPoliciesRequest request, AsyncApiCallback<AuthorizationPolicyEntityListing> callback) Get a page of access policies for an organization- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationPoliciesAsync
public Future<ApiResponse<AuthorizationPolicyEntityListing>> getAuthorizationPoliciesAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<AuthorizationPolicyEntityListing>> callback) Get a page of access policies for an organization- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationPoliciesSubjectSubjectIdAsync
public Future<AuthorizationPolicyEntityListing> getAuthorizationPoliciesSubjectSubjectIdAsync(GetAuthorizationPoliciesSubjectSubjectIdRequest request, AsyncApiCallback<AuthorizationPolicyEntityListing> callback) Get a page of access policies for a given subject- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationPoliciesSubjectSubjectIdAsync
public Future<ApiResponse<AuthorizationPolicyEntityListing>> getAuthorizationPoliciesSubjectSubjectIdAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<AuthorizationPolicyEntityListing>> callback) Get a page of access policies for a given subject- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationPoliciesTargetAsync
public Future<AuthorizationPolicyEntityListing> getAuthorizationPoliciesTargetAsync(GetAuthorizationPoliciesTargetRequest request, AsyncApiCallback<AuthorizationPolicyEntityListing> callback) Get a page of access policies for a given policy target- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationPoliciesTargetAsync
public Future<ApiResponse<AuthorizationPolicyEntityListing>> getAuthorizationPoliciesTargetAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<AuthorizationPolicyEntityListing>> callback) Get a page of access policies for a given policy target- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationPoliciesTargetSubjectSubjectIdAsync
public Future<AuthorizationPolicy> getAuthorizationPoliciesTargetSubjectSubjectIdAsync(GetAuthorizationPoliciesTargetSubjectSubjectIdRequest request, AsyncApiCallback<AuthorizationPolicy> callback) Get an access control policy for a specified resource target and subject- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationPoliciesTargetSubjectSubjectIdAsync
public Future<ApiResponse<AuthorizationPolicy>> getAuthorizationPoliciesTargetSubjectSubjectIdAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<AuthorizationPolicy>> callback) Get an access control policy for a specified resource target and subject- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationPoliciesTargetsAsync
public Future<TargetAttributes> getAuthorizationPoliciesTargetsAsync(GetAuthorizationPoliciesTargetsRequest request, AsyncApiCallback<TargetAttributes> callback) Get a map of policy targets to valid attributes for those targets- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationPoliciesTargetsAsync
public Future<ApiResponse<TargetAttributes>> getAuthorizationPoliciesTargetsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<TargetAttributes>> callback) Get a map of policy targets to valid attributes for those targets- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationPolicyAsync
public Future<AuthorizationPolicy> getAuthorizationPolicyAsync(GetAuthorizationPolicyRequest request, AsyncApiCallback<AuthorizationPolicy> callback) Get an access control policy with the specified policy ID- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationPolicyAsync
public Future<ApiResponse<AuthorizationPolicy>> getAuthorizationPolicyAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<AuthorizationPolicy>> callback) Get an access control policy with the specified policy ID- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationPolicyAttributesAsync
public Future<PolicyAttributeSet> getAuthorizationPolicyAttributesAsync(GetAuthorizationPolicyAttributesRequest request, AsyncApiCallback<PolicyAttributeSet> callback) Get the list of attributes used to evaluate an access control policy with the specified policy ID- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationPolicyAttributesAsync
public Future<ApiResponse<PolicyAttributeSet>> getAuthorizationPolicyAttributesAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<PolicyAttributeSet>> callback) Get the list of attributes used to evaluate an access control policy with the specified policy ID- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationProductsAsync
public Future<OrganizationProductEntityListing> getAuthorizationProductsAsync(GetAuthorizationProductsRequest request, AsyncApiCallback<OrganizationProductEntityListing> callback) Get the list of enabled products Gets the list of enabled products. Some example product names are: collaborateFree, collaboratePro, communicate, and engage.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationProductsAsync
public Future<ApiResponse<OrganizationProductEntityListing>> getAuthorizationProductsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<OrganizationProductEntityListing>> callback) Get the list of enabled products Gets the list of enabled products. Some example product names are: collaborateFree, collaboratePro, communicate, and engage.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationRoleAsync
public Future<DomainOrganizationRole> getAuthorizationRoleAsync(GetAuthorizationRoleRequest request, AsyncApiCallback<DomainOrganizationRole> callback) Get a single organization role. Get the organization role specified by its ID.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationRoleAsync
public Future<ApiResponse<DomainOrganizationRole>> getAuthorizationRoleAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<DomainOrganizationRole>> callback) Get a single organization role. Get the organization role specified by its ID.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationRoleComparedefaultRightRoleIdAsync
public Future<DomainOrgRoleDifference> getAuthorizationRoleComparedefaultRightRoleIdAsync(GetAuthorizationRoleComparedefaultRightRoleIdRequest request, AsyncApiCallback<DomainOrgRoleDifference> callback) Get an org role to default role comparison Compares any organization role to a default role id and show differences- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationRoleComparedefaultRightRoleIdAsync
public Future<ApiResponse<DomainOrgRoleDifference>> getAuthorizationRoleComparedefaultRightRoleIdAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<DomainOrgRoleDifference>> callback) Get an org role to default role comparison Compares any organization role to a default role id and show differences- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationRoleSubjectgrantsAsync
public Future<SubjectDivisionGrantsEntityListing> getAuthorizationRoleSubjectgrantsAsync(GetAuthorizationRoleSubjectgrantsRequest request, AsyncApiCallback<SubjectDivisionGrantsEntityListing> callback) Get the subjects' granted divisions in the specified role. Includes the divisions for which the subject has a grant.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationRoleSubjectgrantsAsync
public Future<ApiResponse<SubjectDivisionGrantsEntityListing>> getAuthorizationRoleSubjectgrantsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<SubjectDivisionGrantsEntityListing>> callback) Get the subjects' granted divisions in the specified role. Includes the divisions for which the subject has a grant.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationRoleUsersAsync
public Future<UserReferenceEntityListing> getAuthorizationRoleUsersAsync(GetAuthorizationRoleUsersRequest request, AsyncApiCallback<UserReferenceEntityListing> callback) Get a list of the users in a specified role. Get an array of the UUIDs of the users in the specified role.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationRoleUsersAsync
public Future<ApiResponse<UserReferenceEntityListing>> getAuthorizationRoleUsersAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<UserReferenceEntityListing>> callback) Get a list of the users in a specified role. Get an array of the UUIDs of the users in the specified role.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationRolesAsync
public Future<OrganizationRoleEntityListing> getAuthorizationRolesAsync(GetAuthorizationRolesRequest request, AsyncApiCallback<OrganizationRoleEntityListing> callback) Retrieve a list of all roles defined for the organization- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationRolesAsync
public Future<ApiResponse<OrganizationRoleEntityListing>> getAuthorizationRolesAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<OrganizationRoleEntityListing>> callback) Retrieve a list of all roles defined for the organization- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationRolesSettingsAsync
public Future<RoleSettings> getAuthorizationRolesSettingsAsync(GetAuthorizationRolesSettingsRequest request, AsyncApiCallback<RoleSettings> callback) Get authorization role settings- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationRolesSettingsAsync
public Future<ApiResponse<RoleSettings>> getAuthorizationRolesSettingsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<RoleSettings>> callback) Get authorization role settings- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationSettingsAsync
public Future<AuthorizationSettings> getAuthorizationSettingsAsync(GetAuthorizationSettingsRequest request, AsyncApiCallback<AuthorizationSettings> callback) Get authorization settings- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationSettingsAsync
public Future<ApiResponse<AuthorizationSettings>> getAuthorizationSettingsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<AuthorizationSettings>> callback) Get authorization settings- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationSubjectAsync
public Future<AuthzSubject> getAuthorizationSubjectAsync(GetAuthorizationSubjectRequest request, AsyncApiCallback<AuthzSubject> callback) Returns a listing of roles and permissions for a user.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationSubjectAsync
public Future<ApiResponse<AuthzSubject>> getAuthorizationSubjectAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<AuthzSubject>> callback) Returns a listing of roles and permissions for a user.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationSubjectsMeAsync
public Future<AuthzSubject> getAuthorizationSubjectsMeAsync(GetAuthorizationSubjectsMeRequest request, AsyncApiCallback<AuthzSubject> callback) Returns a listing of roles and permissions for the currently authenticated user.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationSubjectsMeAsync
public Future<ApiResponse<AuthzSubject>> getAuthorizationSubjectsMeAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<AuthzSubject>> callback) Returns a listing of roles and permissions for the currently authenticated user.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationSubjectsRolecountsAsync
public Future<Map<String,Object>> getAuthorizationSubjectsRolecountsAsync(GetAuthorizationSubjectsRolecountsRequest request, AsyncApiCallback<Map<String, Object>> callback) Get the count of roles granted to a list of subjects- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getAuthorizationSubjectsRolecountsAsync
public Future<ApiResponse<Map<String,Object>>> getAuthorizationSubjectsRolecountsAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Map<String, Object>>> callback) Get the count of roles granted to a list of subjects- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getUserRolesAsync
public Future<UserAuthorization> getUserRolesAsync(GetUserRolesRequest request, AsyncApiCallback<UserAuthorization> callback) Returns a listing of roles and permissions for a user.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
getUserRolesAsync
public Future<ApiResponse<UserAuthorization>> getUserRolesAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<UserAuthorization>> callback) Returns a listing of roles and permissions for a user.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
patchAuthorizationRoleAsync
public Future<DomainOrganizationRole> patchAuthorizationRoleAsync(PatchAuthorizationRoleRequest request, AsyncApiCallback<DomainOrganizationRole> callback) Patch Organization Role for needsUpdate Field Patch Organization Role for needsUpdate Field- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
patchAuthorizationRoleAsync
public Future<ApiResponse<DomainOrganizationRole>> patchAuthorizationRoleAsync(ApiRequest<DomainOrganizationRole> request, AsyncApiCallback<ApiResponse<DomainOrganizationRole>> callback) Patch Organization Role for needsUpdate Field Patch Organization Role for needsUpdate Field- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
patchAuthorizationSettingsAsync
public Future<AuthorizationSettings> patchAuthorizationSettingsAsync(PatchAuthorizationSettingsRequest request, AsyncApiCallback<AuthorizationSettings> callback) Change authorization settings Change authorization settings- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
patchAuthorizationSettingsAsync
public Future<ApiResponse<AuthorizationSettings>> patchAuthorizationSettingsAsync(ApiRequest<AuthorizationSettings> request, AsyncApiCallback<ApiResponse<AuthorizationSettings>> callback) Change authorization settings Change authorization settings- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
postAuthorizationDivisionObjectAsync
public Future<Void> postAuthorizationDivisionObjectAsync(PostAuthorizationDivisionObjectRequest request, AsyncApiCallback<Void> callback) Assign a list of objects to a division Set the division of a specified list of objects. The objects must all be of the same type, one of: CAMPAIGN, MANAGEMENTUNIT, FLOW, QUEUE, DATATABLES or USER. The body of the request is a list of object IDs, which are expected to be GUIDs, e.g. [\"206ce31f-61ec-40ed-a8b1-be6f06303998\",\"250a754e-f5e4-4f51-800f-a92f09d3bf8c\"]- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
postAuthorizationDivisionObjectAsync
public Future<ApiResponse<Void>> postAuthorizationDivisionObjectAsync(ApiRequest<List<String>> request, AsyncApiCallback<ApiResponse<Void>> callback) Assign a list of objects to a division Set the division of a specified list of objects. The objects must all be of the same type, one of: CAMPAIGN, MANAGEMENTUNIT, FLOW, QUEUE, DATATABLES or USER. The body of the request is a list of object IDs, which are expected to be GUIDs, e.g. [\"206ce31f-61ec-40ed-a8b1-be6f06303998\",\"250a754e-f5e4-4f51-800f-a92f09d3bf8c\"]- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
postAuthorizationDivisionRestoreAsync
public Future<AuthzDivision> postAuthorizationDivisionRestoreAsync(PostAuthorizationDivisionRestoreRequest request, AsyncApiCallback<AuthzDivision> callback) Recreate a previously deleted division.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
postAuthorizationDivisionRestoreAsync
public Future<ApiResponse<AuthzDivision>> postAuthorizationDivisionRestoreAsync(ApiRequest<AuthzDivision> request, AsyncApiCallback<ApiResponse<AuthzDivision>> callback) Recreate a previously deleted division.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
postAuthorizationDivisionsAsync
public Future<AuthzDivision> postAuthorizationDivisionsAsync(PostAuthorizationDivisionsRequest request, AsyncApiCallback<AuthzDivision> callback) Create a division.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
postAuthorizationDivisionsAsync
public Future<ApiResponse<AuthzDivision>> postAuthorizationDivisionsAsync(ApiRequest<AuthzDivision> request, AsyncApiCallback<ApiResponse<AuthzDivision>> callback) Create a division.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
postAuthorizationPoliciesTargetAsync
public Future<AuthorizationPolicy> postAuthorizationPoliciesTargetAsync(PostAuthorizationPoliciesTargetRequest request, AsyncApiCallback<AuthorizationPolicy> callback) Add an access control policy for a specified resource target and subject- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
postAuthorizationPoliciesTargetAsync
public Future<ApiResponse<AuthorizationPolicy>> postAuthorizationPoliciesTargetAsync(ApiRequest<AuthorizationPolicy> request, AsyncApiCallback<ApiResponse<AuthorizationPolicy>> callback) Add an access control policy for a specified resource target and subject- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
postAuthorizationPoliciesTargetValidateAsync
public Future<ValidationErrorListing> postAuthorizationPoliciesTargetValidateAsync(PostAuthorizationPoliciesTargetValidateRequest request, AsyncApiCallback<ValidationErrorListing> callback) Validate the conditions and attributes of an access control policy for a specified resource target- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
postAuthorizationPoliciesTargetValidateAsync
public Future<ApiResponse<ValidationErrorListing>> postAuthorizationPoliciesTargetValidateAsync(ApiRequest<AuthorizationPolicy> request, AsyncApiCallback<ApiResponse<ValidationErrorListing>> callback) Validate the conditions and attributes of an access control policy for a specified resource target- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
postAuthorizationPolicySimulateAsync
public Future<PolicyTestResult> postAuthorizationPolicySimulateAsync(PostAuthorizationPolicySimulateRequest request, AsyncApiCallback<PolicyTestResult> callback) Simulate a request and evaluate the specified policy ID against the provided values- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
postAuthorizationPolicySimulateAsync
public Future<ApiResponse<PolicyTestResult>> postAuthorizationPolicySimulateAsync(ApiRequest<PolicyTestPayload> request, AsyncApiCallback<ApiResponse<PolicyTestResult>> callback) Simulate a request and evaluate the specified policy ID against the provided values- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
postAuthorizationRoleAsync
public Future<Void> postAuthorizationRoleAsync(PostAuthorizationRoleRequest request, AsyncApiCallback<Void> callback) Bulk-grant subjects and divisions with an organization role.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
postAuthorizationRoleAsync
public Future<ApiResponse<Void>> postAuthorizationRoleAsync(ApiRequest<SubjectDivisions> request, AsyncApiCallback<ApiResponse<Void>> callback) Bulk-grant subjects and divisions with an organization role.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
postAuthorizationRoleComparedefaultRightRoleIdAsync
public Future<DomainOrgRoleDifference> postAuthorizationRoleComparedefaultRightRoleIdAsync(PostAuthorizationRoleComparedefaultRightRoleIdRequest request, AsyncApiCallback<DomainOrgRoleDifference> callback) Get an unsaved org role to default role comparison Allows users to compare their existing roles in an unsaved state to its default role- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
postAuthorizationRoleComparedefaultRightRoleIdAsync
public Future<ApiResponse<DomainOrgRoleDifference>> postAuthorizationRoleComparedefaultRightRoleIdAsync(ApiRequest<DomainOrganizationRole> request, AsyncApiCallback<ApiResponse<DomainOrgRoleDifference>> callback) Get an unsaved org role to default role comparison Allows users to compare their existing roles in an unsaved state to its default role- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
postAuthorizationRolesAsync
public Future<DomainOrganizationRole> postAuthorizationRolesAsync(PostAuthorizationRolesRequest request, AsyncApiCallback<DomainOrganizationRole> callback) Create an organization role.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
postAuthorizationRolesAsync
public Future<ApiResponse<DomainOrganizationRole>> postAuthorizationRolesAsync(ApiRequest<DomainOrganizationRoleCreate> request, AsyncApiCallback<ApiResponse<DomainOrganizationRole>> callback) Create an organization role.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
postAuthorizationRolesDefaultAsync
public Future<OrganizationRoleEntityListing> postAuthorizationRolesDefaultAsync(PostAuthorizationRolesDefaultRequest request, AsyncApiCallback<OrganizationRoleEntityListing> callback) Restores all default roles This endpoint serves several purposes. 1. It provides the org with default roles. This is important for default roles that will be added after go-live (they can retroactively add the new default-role). Note: When not using a query param of force=true, it only adds the default roles not configured for the org; it does not overwrite roles. 2. Using the query param force=true, you can restore all default roles. Note: This does not have an effect on custom roles.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
postAuthorizationRolesDefaultAsync
public Future<ApiResponse<OrganizationRoleEntityListing>> postAuthorizationRolesDefaultAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<OrganizationRoleEntityListing>> callback) Restores all default roles This endpoint serves several purposes. 1. It provides the org with default roles. This is important for default roles that will be added after go-live (they can retroactively add the new default-role). Note: When not using a query param of force=true, it only adds the default roles not configured for the org; it does not overwrite roles. 2. Using the query param force=true, you can restore all default roles. Note: This does not have an effect on custom roles.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
postAuthorizationSubjectBulkaddAsync
public Future<Void> postAuthorizationSubjectBulkaddAsync(PostAuthorizationSubjectBulkaddRequest request, AsyncApiCallback<Void> callback) Bulk-grant roles and divisions to a subject.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
postAuthorizationSubjectBulkaddAsync
public Future<ApiResponse<Void>> postAuthorizationSubjectBulkaddAsync(ApiRequest<RoleDivisionGrants> request, AsyncApiCallback<ApiResponse<Void>> callback) Bulk-grant roles and divisions to a subject.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
postAuthorizationSubjectBulkremoveAsync
public Future<Void> postAuthorizationSubjectBulkremoveAsync(PostAuthorizationSubjectBulkremoveRequest request, AsyncApiCallback<Void> callback) Bulk-remove grants from a subject.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
postAuthorizationSubjectBulkremoveAsync
public Future<ApiResponse<Void>> postAuthorizationSubjectBulkremoveAsync(ApiRequest<RoleDivisionGrants> request, AsyncApiCallback<ApiResponse<Void>> callback) Bulk-remove grants from a subject.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
postAuthorizationSubjectBulkreplaceAsync
public Future<Void> postAuthorizationSubjectBulkreplaceAsync(PostAuthorizationSubjectBulkreplaceRequest request, AsyncApiCallback<Void> callback) Replace subject's roles and divisions with the exact list supplied in the request. This operation will not remove grants that are inherited from group membership. It will only set the grants directly applied to the subject.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
postAuthorizationSubjectBulkreplaceAsync
public Future<ApiResponse<Void>> postAuthorizationSubjectBulkreplaceAsync(ApiRequest<RoleDivisionGrants> request, AsyncApiCallback<ApiResponse<Void>> callback) Replace subject's roles and divisions with the exact list supplied in the request. This operation will not remove grants that are inherited from group membership. It will only set the grants directly applied to the subject.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
postAuthorizationSubjectDivisionRoleAsync
public Future<Void> postAuthorizationSubjectDivisionRoleAsync(PostAuthorizationSubjectDivisionRoleRequest request, AsyncApiCallback<Void> callback) Make a grant of a role in a division- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
postAuthorizationSubjectDivisionRoleAsync
public Future<ApiResponse<Void>> postAuthorizationSubjectDivisionRoleAsync(ApiRequest<Void> request, AsyncApiCallback<ApiResponse<Void>> callback) Make a grant of a role in a division- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
putAuthorizationDivisionAsync
public Future<AuthzDivision> putAuthorizationDivisionAsync(PutAuthorizationDivisionRequest request, AsyncApiCallback<AuthzDivision> callback) Update a division.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
putAuthorizationDivisionAsync
public Future<ApiResponse<AuthzDivision>> putAuthorizationDivisionAsync(ApiRequest<AuthzDivision> request, AsyncApiCallback<ApiResponse<AuthzDivision>> callback) Update a division.- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
putAuthorizationPoliciesTargetAsync
public Future<AuthorizationPolicy> putAuthorizationPoliciesTargetAsync(PutAuthorizationPoliciesTargetRequest request, AsyncApiCallback<AuthorizationPolicy> callback) Add an access control policy for a specified resource target and subject, overwriting any existing policy- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
putAuthorizationPoliciesTargetAsync
public Future<ApiResponse<AuthorizationPolicy>> putAuthorizationPoliciesTargetAsync(ApiRequest<AuthorizationPolicy> request, AsyncApiCallback<ApiResponse<AuthorizationPolicy>> callback) Add an access control policy for a specified resource target and subject, overwriting any existing policy- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
putAuthorizationPolicyAsync
public Future<AuthorizationPolicy> putAuthorizationPolicyAsync(PutAuthorizationPolicyRequest request, AsyncApiCallback<AuthorizationPolicy> callback) Update an access control policy with a given ID- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
putAuthorizationPolicyAsync
public Future<ApiResponse<AuthorizationPolicy>> putAuthorizationPolicyAsync(ApiRequest<AuthorizationPolicy> request, AsyncApiCallback<ApiResponse<AuthorizationPolicy>> callback) Update an access control policy with a given ID- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
putAuthorizationRoleAsync
public Future<DomainOrganizationRole> putAuthorizationRoleAsync(PutAuthorizationRoleRequest request, AsyncApiCallback<DomainOrganizationRole> callback) Update an organization role. Update- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
putAuthorizationRoleAsync
public Future<ApiResponse<DomainOrganizationRole>> putAuthorizationRoleAsync(ApiRequest<DomainOrganizationRoleUpdate> request, AsyncApiCallback<ApiResponse<DomainOrganizationRole>> callback) Update an organization role. Update- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
putAuthorizationRoleUsersAddAsync
public Future<List<String>> putAuthorizationRoleUsersAddAsync(PutAuthorizationRoleUsersAddRequest request, AsyncApiCallback<List<String>> callback) Sets the users for the role- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
putAuthorizationRoleUsersAddAsync
public Future<ApiResponse<List<String>>> putAuthorizationRoleUsersAddAsync(ApiRequest<List<String>> request, AsyncApiCallback<ApiResponse<List<String>>> callback) Sets the users for the role- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
putAuthorizationRoleUsersRemoveAsync
public Future<List<String>> putAuthorizationRoleUsersRemoveAsync(PutAuthorizationRoleUsersRemoveRequest request, AsyncApiCallback<List<String>> callback) Removes the users from the role- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
putAuthorizationRoleUsersRemoveAsync
public Future<ApiResponse<List<String>>> putAuthorizationRoleUsersRemoveAsync(ApiRequest<List<String>> request, AsyncApiCallback<ApiResponse<List<String>>> callback) Removes the users from the role- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
putAuthorizationRolesDefaultAsync
public Future<OrganizationRoleEntityListing> putAuthorizationRolesDefaultAsync(PutAuthorizationRolesDefaultRequest request, AsyncApiCallback<OrganizationRoleEntityListing> callback) Restore specified default roles- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
putAuthorizationRolesDefaultAsync
public Future<ApiResponse<OrganizationRoleEntityListing>> putAuthorizationRolesDefaultAsync(ApiRequest<List<DomainOrganizationRole>> request, AsyncApiCallback<ApiResponse<OrganizationRoleEntityListing>> callback) Restore specified default roles- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
putAuthorizationRolesSettingsAsync
public Future<RoleSettings> putAuthorizationRolesSettingsAsync(PutAuthorizationRolesSettingsRequest request, AsyncApiCallback<RoleSettings> callback) Change authorization role settings Change role settings- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
putAuthorizationRolesSettingsAsync
public Future<ApiResponse<RoleSettings>> putAuthorizationRolesSettingsAsync(ApiRequest<RoleSettings> request, AsyncApiCallback<ApiResponse<RoleSettings>> callback) Change authorization role settings Change role settings- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
putUserRolesAsync
public Future<UserAuthorization> putUserRolesAsync(PutUserRolesRequest request, AsyncApiCallback<UserAuthorization> callback) Sets the user's roles- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-
putUserRolesAsync
public Future<ApiResponse<UserAuthorization>> putUserRolesAsync(ApiRequest<List<String>> request, AsyncApiCallback<ApiResponse<UserAuthorization>> callback) Sets the user's roles- Parameters:
request- the request objectcallback- the action to perform when the request is completed- Returns:
- the future indication when the request has completed
-