Package com.mypurecloud.sdk.v2.api

Class AuthorizationApi

java.lang.Object
com.mypurecloud.sdk.v2.api.AuthorizationApi
public class AuthorizationApi extends Object

  • Constructor Details

    • AuthorizationApi

      public AuthorizationApi()

    • AuthorizationApi

      public AuthorizationApi(ApiClient apiClient)

  • Method Details

    • deleteAuthorizationDivision

      public void deleteAuthorizationDivision(String divisionId, Boolean force) throws IOException, ApiException
      Delete a division.
      Parameters:
      divisionId - Division ID (required)
      force - DEPRECATED - Force delete this division. Warning: This option may cause any remaining objects in this division to be inaccessible. (optional, default to false)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteAuthorizationDivisionWithHttpInfo

      public ApiResponse<Void> deleteAuthorizationDivisionWithHttpInfo(String divisionId, Boolean force) throws IOException
      Delete a division.
      Parameters:
      divisionId - Division ID (required)
      force - DEPRECATED - Force delete this division. Warning: This option may cause any remaining objects in this division to be inaccessible. (optional, default to false)
      Throws:
      IOException - if the request fails to be processed

    • deleteAuthorizationDivision

      public void deleteAuthorizationDivision(DeleteAuthorizationDivisionRequest request) throws IOException, ApiException
      Delete a division.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteAuthorizationDivision

      public ApiResponse<Void> deleteAuthorizationDivision(ApiRequest<Void> request) throws IOException
      Delete a division.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteAuthorizationPoliciesTargetSubjectSubjectId

      public void deleteAuthorizationPoliciesTargetSubjectSubjectId(String targetName, String subjectId) throws IOException, ApiException
      Delete an access control policy
      Parameters:
      targetName - The domain:entity:action target to which the policy is applied (required)
      subjectId - The ID of the subject to which the policy is applied (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteAuthorizationPoliciesTargetSubjectSubjectIdWithHttpInfo

      public ApiResponse<Void> deleteAuthorizationPoliciesTargetSubjectSubjectIdWithHttpInfo(String targetName, String subjectId) throws IOException
      Delete an access control policy
      Parameters:
      targetName - The domain:entity:action target to which the policy is applied (required)
      subjectId - The ID of the subject to which the policy is applied (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteAuthorizationPoliciesTargetSubjectSubjectId

      public void deleteAuthorizationPoliciesTargetSubjectSubjectId(DeleteAuthorizationPoliciesTargetSubjectSubjectIdRequest request) throws IOException, ApiException
      Delete an access control policy
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteAuthorizationPoliciesTargetSubjectSubjectId

      public ApiResponse<Void> deleteAuthorizationPoliciesTargetSubjectSubjectId(ApiRequest<Void> request) throws IOException
      Delete an access control policy
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteAuthorizationRole

      public void deleteAuthorizationRole(String roleId) throws IOException, ApiException
      Delete an organization role.
      Parameters:
      roleId - Role ID (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteAuthorizationRoleWithHttpInfo

      public ApiResponse<Void> deleteAuthorizationRoleWithHttpInfo(String roleId) throws IOException
      Delete an organization role.
      Parameters:
      roleId - Role ID (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteAuthorizationRole

      public void deleteAuthorizationRole(DeleteAuthorizationRoleRequest request) throws IOException, ApiException
      Delete an organization role.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteAuthorizationRole

      public ApiResponse<Void> deleteAuthorizationRole(ApiRequest<Void> request) throws IOException
      Delete an organization role.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • deleteAuthorizationSubjectDivisionRole

      public void deleteAuthorizationSubjectDivisionRole(String subjectId, String divisionId, String roleId) throws IOException, ApiException
      Delete a grant of a role in a division
      Parameters:
      subjectId - Subject ID (user or group) (required)
      divisionId - the id of the division of the grant (required)
      roleId - the id of the role of the grant (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteAuthorizationSubjectDivisionRoleWithHttpInfo

      public ApiResponse<Void> deleteAuthorizationSubjectDivisionRoleWithHttpInfo(String subjectId, String divisionId, String roleId) throws IOException
      Delete a grant of a role in a division
      Parameters:
      subjectId - Subject ID (user or group) (required)
      divisionId - the id of the division of the grant (required)
      roleId - the id of the role of the grant (required)
      Throws:
      IOException - if the request fails to be processed

    • deleteAuthorizationSubjectDivisionRole

      public void deleteAuthorizationSubjectDivisionRole(DeleteAuthorizationSubjectDivisionRoleRequest request) throws IOException, ApiException
      Delete a grant of a role in a division
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteAuthorizationSubjectDivisionRole

      public ApiResponse<Void> deleteAuthorizationSubjectDivisionRole(ApiRequest<Void> request) throws IOException
      Delete a grant of a role in a division
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationDivision

      public AuthzDivision getAuthorizationDivision(String divisionId, Boolean objectCount) throws IOException, ApiException
      Returns an authorization division.
      Parameters:
      divisionId - Division ID (required)
      objectCount - Get count of objects in this division, grouped by type (optional, default to false)
      Returns:
      AuthzDivision
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationDivisionWithHttpInfo

      public ApiResponse<AuthzDivision> getAuthorizationDivisionWithHttpInfo(String divisionId, Boolean objectCount) throws IOException
      Returns an authorization division.
      Parameters:
      divisionId - Division ID (required)
      objectCount - Get count of objects in this division, grouped by type (optional, default to false)
      Returns:
      AuthzDivision
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationDivision

      public AuthzDivision getAuthorizationDivision(GetAuthorizationDivisionRequest request) throws IOException, ApiException
      Returns an authorization division.
      Parameters:
      request - The request object
      Returns:
      AuthzDivision
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationDivision

      public ApiResponse<AuthzDivision> getAuthorizationDivision(ApiRequest<Void> request) throws IOException
      Returns an authorization division.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationDivisionGrants

      public AuthzDivisionGrantEntityListing getAuthorizationDivisionGrants(String divisionId, Integer pageNumber, Integer pageSize) throws IOException, ApiException
      Gets all grants for a given division. Returns all grants assigned to a given division. Maximum page size is 500.
      Parameters:
      divisionId - Division ID (required)
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      Returns:
      AuthzDivisionGrantEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationDivisionGrantsWithHttpInfo

      public ApiResponse<AuthzDivisionGrantEntityListing> getAuthorizationDivisionGrantsWithHttpInfo(String divisionId, Integer pageNumber, Integer pageSize) throws IOException
      Gets all grants for a given division. Returns all grants assigned to a given division. Maximum page size is 500.
      Parameters:
      divisionId - Division ID (required)
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      Returns:
      AuthzDivisionGrantEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationDivisionGrants

      public AuthzDivisionGrantEntityListing getAuthorizationDivisionGrants(GetAuthorizationDivisionGrantsRequest request) throws IOException, ApiException
      Gets all grants for a given division. Returns all grants assigned to a given division. Maximum page size is 500.
      Parameters:
      request - The request object
      Returns:
      AuthzDivisionGrantEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationDivisionGrants

      public ApiResponse<AuthzDivisionGrantEntityListing> getAuthorizationDivisionGrants(ApiRequest<Void> request) throws IOException
      Gets all grants for a given division. Returns all grants assigned to a given division. Maximum page size is 500.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationDivisions

      public AuthzDivisionEntityListing getAuthorizationDivisions(Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage, Boolean objectCount, List<String> id, String name) throws IOException, ApiException
      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:
      pageSize - The total page size requested (optional, default to 25)
      pageNumber - The page number requested (optional, default to 1)
      sortBy - variable name requested to sort by (optional)
      expand - variable name requested by expand list (optional)
      nextPage - next page token (optional)
      previousPage - Previous page token (optional)
      objectCount - Include the count of objects contained in the division (optional, default to false)
      id - Optionally request specific divisions by their IDs (optional)
      name - Search term to filter by division name (optional)
      Returns:
      AuthzDivisionEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationDivisionsWithHttpInfo

      public ApiResponse<AuthzDivisionEntityListing> getAuthorizationDivisionsWithHttpInfo(Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage, Boolean objectCount, List<String> id, String name) throws IOException
      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:
      pageSize - The total page size requested (optional, default to 25)
      pageNumber - The page number requested (optional, default to 1)
      sortBy - variable name requested to sort by (optional)
      expand - variable name requested by expand list (optional)
      nextPage - next page token (optional)
      previousPage - Previous page token (optional)
      objectCount - Include the count of objects contained in the division (optional, default to false)
      id - Optionally request specific divisions by their IDs (optional)
      name - Search term to filter by division name (optional)
      Returns:
      AuthzDivisionEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationDivisions

      public AuthzDivisionEntityListing getAuthorizationDivisions(GetAuthorizationDivisionsRequest request) throws IOException, ApiException
      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 object
      Returns:
      AuthzDivisionEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationDivisions

      public ApiResponse<AuthzDivisionEntityListing> getAuthorizationDivisions(ApiRequest<Void> request) throws IOException
      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 object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationDivisionsDeleted

      public AuthzDivisionEntityListing getAuthorizationDivisionsDeleted(Integer pageNumber, Integer pageSize) throws IOException, ApiException
      Get a list of soft deleted divisions for the org
      Parameters:
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      Returns:
      AuthzDivisionEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationDivisionsDeletedWithHttpInfo

      public ApiResponse<AuthzDivisionEntityListing> getAuthorizationDivisionsDeletedWithHttpInfo(Integer pageNumber, Integer pageSize) throws IOException
      Get a list of soft deleted divisions for the org
      Parameters:
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      Returns:
      AuthzDivisionEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationDivisionsDeleted

      public AuthzDivisionEntityListing getAuthorizationDivisionsDeleted(GetAuthorizationDivisionsDeletedRequest request) throws IOException, ApiException
      Get a list of soft deleted divisions for the org
      Parameters:
      request - The request object
      Returns:
      AuthzDivisionEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationDivisionsDeleted

      public ApiResponse<AuthzDivisionEntityListing> getAuthorizationDivisionsDeleted(ApiRequest<Void> request) throws IOException
      Get a list of soft deleted divisions for the org
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationDivisionsHome

      public AuthzDivision getAuthorizationDivisionsHome() throws IOException, ApiException
      Retrieve the home division for the organization. Will not include object counts.
      Returns:
      AuthzDivision
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationDivisionsHomeWithHttpInfo

      public ApiResponse<AuthzDivision> getAuthorizationDivisionsHomeWithHttpInfo() throws IOException
      Retrieve the home division for the organization. Will not include object counts.
      Returns:
      AuthzDivision
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationDivisionsHome

      public AuthzDivision getAuthorizationDivisionsHome(GetAuthorizationDivisionsHomeRequest request) throws IOException, ApiException
      Retrieve the home division for the organization. Will not include object counts.
      Parameters:
      request - The request object
      Returns:
      AuthzDivision
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationDivisionsHome

      public ApiResponse<AuthzDivision> getAuthorizationDivisionsHome(ApiRequest<Void> request) throws IOException
      Retrieve the home division for the organization. Will not include object counts.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationDivisionsLimit

      public Integer getAuthorizationDivisionsLimit() throws IOException, ApiException
      Returns the maximum allowed number of divisions.
      Returns:
      Integer
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationDivisionsLimitWithHttpInfo

      public ApiResponse<Integer> getAuthorizationDivisionsLimitWithHttpInfo() throws IOException
      Returns the maximum allowed number of divisions.
      Returns:
      Integer
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationDivisionsLimit

      public Integer getAuthorizationDivisionsLimit(GetAuthorizationDivisionsLimitRequest request) throws IOException, ApiException
      Returns the maximum allowed number of divisions.
      Parameters:
      request - The request object
      Returns:
      Integer
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationDivisionsLimit

      public ApiResponse<Integer> getAuthorizationDivisionsLimit(ApiRequest<Void> request) throws IOException
      Returns the maximum allowed number of divisions.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationDivisionsQuery

      public AuthzDivisionCursorListing getAuthorizationDivisionsQuery(String before, String after, String pageSize, List<String> id, String name) throws IOException, ApiException
      Retrieve a list of all divisions defined for the organization with cursor Use \"after\" and \"before\" param to fetch next/previous page}
      Parameters:
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Page size (max 200, default 25) (optional, default to 25)
      id - Optionally request specific divisions by their IDs (optional)
      name - Optionally request specific divisions by division name (optional)
      Returns:
      AuthzDivisionCursorListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationDivisionsQueryWithHttpInfo

      public ApiResponse<AuthzDivisionCursorListing> getAuthorizationDivisionsQueryWithHttpInfo(String before, String after, String pageSize, List<String> id, String name) throws IOException
      Retrieve a list of all divisions defined for the organization with cursor Use \"after\" and \"before\" param to fetch next/previous page}
      Parameters:
      before - The cursor that points to the start of the set of entities that has been returned. (optional)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Page size (max 200, default 25) (optional, default to 25)
      id - Optionally request specific divisions by their IDs (optional)
      name - Optionally request specific divisions by division name (optional)
      Returns:
      AuthzDivisionCursorListing
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationDivisionsQuery

      public AuthzDivisionCursorListing getAuthorizationDivisionsQuery(GetAuthorizationDivisionsQueryRequest request) throws IOException, ApiException
      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 object
      Returns:
      AuthzDivisionCursorListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationDivisionsQuery

      public ApiResponse<AuthzDivisionCursorListing> getAuthorizationDivisionsQuery(ApiRequest<Void> request) throws IOException
      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 object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationDivisionspermittedMe

      public List<AuthzDivision> getAuthorizationDivisionspermittedMe(String permission, String name) throws IOException, ApiException
      Deprecated.
      Returns which divisions the current user has the given permission in. This route is deprecated, use authorization/divisionspermitted/paged/me instead.
      Parameters:
      permission - The permission string, including the object to access, e.g. routing:queue:view (required)
      name - Search term to filter by division name (optional)
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationDivisionspermittedMeWithHttpInfo

      public ApiResponse<List<AuthzDivision>> getAuthorizationDivisionspermittedMeWithHttpInfo(String permission, String name) throws IOException
      Deprecated.
      Returns which divisions the current user has the given permission in. This route is deprecated, use authorization/divisionspermitted/paged/me instead.
      Parameters:
      permission - The permission string, including the object to access, e.g. routing:queue:view (required)
      name - Search term to filter by division name (optional)
      Returns:
      List
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationDivisionspermittedMe

      public List<AuthzDivision> getAuthorizationDivisionspermittedMe(GetAuthorizationDivisionspermittedMeRequest request) throws IOException, ApiException
      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 object
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationDivisionspermittedMe

      public ApiResponse<List<AuthzDivision>> getAuthorizationDivisionspermittedMe(ApiRequest<Void> request) throws IOException
      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 object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationDivisionspermittedPagedMe

      public DivsPermittedEntityListing getAuthorizationDivisionspermittedPagedMe(String permission, Integer pageNumber, Integer pageSize) throws IOException, ApiException
      Returns which divisions the current user has the given permission in.
      Parameters:
      permission - The permission string, including the object to access, e.g. routing:queue:view (required)
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      Returns:
      DivsPermittedEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationDivisionspermittedPagedMeWithHttpInfo

      public ApiResponse<DivsPermittedEntityListing> getAuthorizationDivisionspermittedPagedMeWithHttpInfo(String permission, Integer pageNumber, Integer pageSize) throws IOException
      Returns which divisions the current user has the given permission in.
      Parameters:
      permission - The permission string, including the object to access, e.g. routing:queue:view (required)
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      Returns:
      DivsPermittedEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationDivisionspermittedPagedMe

      public DivsPermittedEntityListing getAuthorizationDivisionspermittedPagedMe(GetAuthorizationDivisionspermittedPagedMeRequest request) throws IOException, ApiException
      Returns which divisions the current user has the given permission in.
      Parameters:
      request - The request object
      Returns:
      DivsPermittedEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationDivisionspermittedPagedMe

      public ApiResponse<DivsPermittedEntityListing> getAuthorizationDivisionspermittedPagedMe(ApiRequest<Void> request) throws IOException
      Returns which divisions the current user has the given permission in.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationDivisionspermittedPagedSubjectId

      public DivsPermittedEntityListing getAuthorizationDivisionspermittedPagedSubjectId(String subjectId, String permission, Integer pageNumber, Integer pageSize) throws IOException, ApiException
      Deprecated.
      Returns which divisions the specified user has the given permission in. This route is deprecated, use authorization/divisionspermitted/paged/me instead.
      Parameters:
      subjectId - Subject ID (user or group) (required)
      permission - The permission string, including the object to access, e.g. routing:queue:view (required)
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      Returns:
      DivsPermittedEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationDivisionspermittedPagedSubjectIdWithHttpInfo

      public ApiResponse<DivsPermittedEntityListing> getAuthorizationDivisionspermittedPagedSubjectIdWithHttpInfo(String subjectId, String permission, Integer pageNumber, Integer pageSize) throws IOException
      Deprecated.
      Returns which divisions the specified user has the given permission in. This route is deprecated, use authorization/divisionspermitted/paged/me instead.
      Parameters:
      subjectId - Subject ID (user or group) (required)
      permission - The permission string, including the object to access, e.g. routing:queue:view (required)
      pageNumber - Page number (optional, default to 1)
      pageSize - Page size (optional, default to 25)
      Returns:
      DivsPermittedEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationDivisionspermittedPagedSubjectId

      public DivsPermittedEntityListing getAuthorizationDivisionspermittedPagedSubjectId(GetAuthorizationDivisionspermittedPagedSubjectIdRequest request) throws IOException, ApiException
      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 object
      Returns:
      DivsPermittedEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationDivisionspermittedPagedSubjectId

      public ApiResponse<DivsPermittedEntityListing> getAuthorizationDivisionspermittedPagedSubjectId(ApiRequest<Void> request) throws IOException
      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 object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationPermissions

      public PermissionCollectionEntityListing getAuthorizationPermissions(Integer pageSize, Integer pageNumber, String queryType, String query) throws IOException, ApiException
      Get all permissions. Retrieve a list of all permission defined in the system.
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      queryType - Query filter type (optional)
      query - Comma-separated list of permissions or domains to query (optional)
      Returns:
      PermissionCollectionEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationPermissionsWithHttpInfo

      public ApiResponse<PermissionCollectionEntityListing> getAuthorizationPermissionsWithHttpInfo(Integer pageSize, Integer pageNumber, String queryType, String query) throws IOException
      Get all permissions. Retrieve a list of all permission defined in the system.
      Parameters:
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      queryType - Query filter type (optional)
      query - Comma-separated list of permissions or domains to query (optional)
      Returns:
      PermissionCollectionEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationPermissions

      public PermissionCollectionEntityListing getAuthorizationPermissions(GetAuthorizationPermissionsRequest request) throws IOException, ApiException
      Get all permissions. Retrieve a list of all permission defined in the system.
      Parameters:
      request - The request object
      Returns:
      PermissionCollectionEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationPermissions

      public ApiResponse<PermissionCollectionEntityListing> getAuthorizationPermissions(ApiRequest<Void> request) throws IOException
      Get all permissions. Retrieve a list of all permission defined in the system.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationPolicies

      public AuthorizationPolicyEntityListing getAuthorizationPolicies(String after, Integer pageSize) throws IOException, ApiException
      Get a page of access policies for an organization
      Parameters:
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional, default to 25)
      Returns:
      AuthorizationPolicyEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationPoliciesWithHttpInfo

      public ApiResponse<AuthorizationPolicyEntityListing> getAuthorizationPoliciesWithHttpInfo(String after, Integer pageSize) throws IOException
      Get a page of access policies for an organization
      Parameters:
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional, default to 25)
      Returns:
      AuthorizationPolicyEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationPolicies

      public AuthorizationPolicyEntityListing getAuthorizationPolicies(GetAuthorizationPoliciesRequest request) throws IOException, ApiException
      Get a page of access policies for an organization
      Parameters:
      request - The request object
      Returns:
      AuthorizationPolicyEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationPolicies

      public ApiResponse<AuthorizationPolicyEntityListing> getAuthorizationPolicies(ApiRequest<Void> request) throws IOException
      Get a page of access policies for an organization
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationPoliciesSubjectSubjectId

      public AuthorizationPolicyEntityListing getAuthorizationPoliciesSubjectSubjectId(String subjectId, String after, Integer pageSize) throws IOException, ApiException
      Get a page of access policies for a given subject
      Parameters:
      subjectId - The ID of the subject to which policies are applied (required)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional, default to 25)
      Returns:
      AuthorizationPolicyEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationPoliciesSubjectSubjectIdWithHttpInfo

      public ApiResponse<AuthorizationPolicyEntityListing> getAuthorizationPoliciesSubjectSubjectIdWithHttpInfo(String subjectId, String after, Integer pageSize) throws IOException
      Get a page of access policies for a given subject
      Parameters:
      subjectId - The ID of the subject to which policies are applied (required)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional, default to 25)
      Returns:
      AuthorizationPolicyEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationPoliciesSubjectSubjectId

      public AuthorizationPolicyEntityListing getAuthorizationPoliciesSubjectSubjectId(GetAuthorizationPoliciesSubjectSubjectIdRequest request) throws IOException, ApiException
      Get a page of access policies for a given subject
      Parameters:
      request - The request object
      Returns:
      AuthorizationPolicyEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationPoliciesSubjectSubjectId

      public ApiResponse<AuthorizationPolicyEntityListing> getAuthorizationPoliciesSubjectSubjectId(ApiRequest<Void> request) throws IOException
      Get a page of access policies for a given subject
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationPoliciesTarget

      public AuthorizationPolicyEntityListing getAuthorizationPoliciesTarget(String targetName, String after, Integer pageSize) throws IOException, ApiException
      Get a page of access policies for a given policy target
      Parameters:
      targetName - The domain:entity:action resource target to which policies are applied (required)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional, default to 25)
      Returns:
      AuthorizationPolicyEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationPoliciesTargetWithHttpInfo

      public ApiResponse<AuthorizationPolicyEntityListing> getAuthorizationPoliciesTargetWithHttpInfo(String targetName, String after, Integer pageSize) throws IOException
      Get a page of access policies for a given policy target
      Parameters:
      targetName - The domain:entity:action resource target to which policies are applied (required)
      after - The cursor that points to the end of the set of entities that has been returned. (optional)
      pageSize - Number of entities to return. Maximum of 200. (optional, default to 25)
      Returns:
      AuthorizationPolicyEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationPoliciesTarget

      public AuthorizationPolicyEntityListing getAuthorizationPoliciesTarget(GetAuthorizationPoliciesTargetRequest request) throws IOException, ApiException
      Get a page of access policies for a given policy target
      Parameters:
      request - The request object
      Returns:
      AuthorizationPolicyEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationPoliciesTarget

      public ApiResponse<AuthorizationPolicyEntityListing> getAuthorizationPoliciesTarget(ApiRequest<Void> request) throws IOException
      Get a page of access policies for a given policy target
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationPoliciesTargetSubjectSubjectId

      public AuthorizationPolicy getAuthorizationPoliciesTargetSubjectSubjectId(String targetName, String subjectId) throws IOException, ApiException
      Get an access control policy for a specified resource target and subject
      Parameters:
      targetName - The domain:entity:action resource target to which the policy is applied (required)
      subjectId - The ID of the subject to which the policy is applied (required)
      Returns:
      AuthorizationPolicy
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationPoliciesTargetSubjectSubjectIdWithHttpInfo

      public ApiResponse<AuthorizationPolicy> getAuthorizationPoliciesTargetSubjectSubjectIdWithHttpInfo(String targetName, String subjectId) throws IOException
      Get an access control policy for a specified resource target and subject
      Parameters:
      targetName - The domain:entity:action resource target to which the policy is applied (required)
      subjectId - The ID of the subject to which the policy is applied (required)
      Returns:
      AuthorizationPolicy
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationPoliciesTargetSubjectSubjectId

      public AuthorizationPolicy getAuthorizationPoliciesTargetSubjectSubjectId(GetAuthorizationPoliciesTargetSubjectSubjectIdRequest request) throws IOException, ApiException
      Get an access control policy for a specified resource target and subject
      Parameters:
      request - The request object
      Returns:
      AuthorizationPolicy
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationPoliciesTargetSubjectSubjectId

      public ApiResponse<AuthorizationPolicy> getAuthorizationPoliciesTargetSubjectSubjectId(ApiRequest<Void> request) throws IOException
      Get an access control policy for a specified resource target and subject
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationPoliciesTargets

      public TargetAttributes getAuthorizationPoliciesTargets() throws IOException, ApiException
      Get a map of policy targets to valid attributes for those targets
      Returns:
      TargetAttributes
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationPoliciesTargetsWithHttpInfo

      public ApiResponse<TargetAttributes> getAuthorizationPoliciesTargetsWithHttpInfo() throws IOException
      Get a map of policy targets to valid attributes for those targets
      Returns:
      TargetAttributes
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationPoliciesTargets

      public TargetAttributes getAuthorizationPoliciesTargets(GetAuthorizationPoliciesTargetsRequest request) throws IOException, ApiException
      Get a map of policy targets to valid attributes for those targets
      Parameters:
      request - The request object
      Returns:
      TargetAttributes
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationPoliciesTargets

      public ApiResponse<TargetAttributes> getAuthorizationPoliciesTargets(ApiRequest<Void> request) throws IOException
      Get a map of policy targets to valid attributes for those targets
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationPolicy

      public AuthorizationPolicy getAuthorizationPolicy(String policyId) throws IOException, ApiException
      Get an access control policy with the specified policy ID
      Parameters:
      policyId - The ID of the policy to retrieve (required)
      Returns:
      AuthorizationPolicy
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationPolicyWithHttpInfo

      public ApiResponse<AuthorizationPolicy> getAuthorizationPolicyWithHttpInfo(String policyId) throws IOException
      Get an access control policy with the specified policy ID
      Parameters:
      policyId - The ID of the policy to retrieve (required)
      Returns:
      AuthorizationPolicy
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationPolicy

      public AuthorizationPolicy getAuthorizationPolicy(GetAuthorizationPolicyRequest request) throws IOException, ApiException
      Get an access control policy with the specified policy ID
      Parameters:
      request - The request object
      Returns:
      AuthorizationPolicy
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationPolicy

      public ApiResponse<AuthorizationPolicy> getAuthorizationPolicy(ApiRequest<Void> request) throws IOException
      Get an access control policy with the specified policy ID
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationPolicyAttributes

      public PolicyAttributeSet getAuthorizationPolicyAttributes(String policyId) throws IOException, ApiException
      Get the list of attributes used to evaluate an access control policy with the specified policy ID
      Parameters:
      policyId - The ID of the policy to retrieve attributes (required)
      Returns:
      PolicyAttributeSet
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationPolicyAttributesWithHttpInfo

      public ApiResponse<PolicyAttributeSet> getAuthorizationPolicyAttributesWithHttpInfo(String policyId) throws IOException
      Get the list of attributes used to evaluate an access control policy with the specified policy ID
      Parameters:
      policyId - The ID of the policy to retrieve attributes (required)
      Returns:
      PolicyAttributeSet
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationPolicyAttributes

      public PolicyAttributeSet getAuthorizationPolicyAttributes(GetAuthorizationPolicyAttributesRequest request) throws IOException, ApiException
      Get the list of attributes used to evaluate an access control policy with the specified policy ID
      Parameters:
      request - The request object
      Returns:
      PolicyAttributeSet
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationPolicyAttributes

      public ApiResponse<PolicyAttributeSet> getAuthorizationPolicyAttributes(ApiRequest<Void> request) throws IOException
      Get the list of attributes used to evaluate an access control policy with the specified policy ID
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationProducts

      public OrganizationProductEntityListing getAuthorizationProducts() throws IOException, ApiException
      Get the list of enabled products Gets the list of enabled products. Some example product names are: collaborateFree, collaboratePro, communicate, and engage.
      Returns:
      OrganizationProductEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationProductsWithHttpInfo

      public ApiResponse<OrganizationProductEntityListing> getAuthorizationProductsWithHttpInfo() throws IOException
      Get the list of enabled products Gets the list of enabled products. Some example product names are: collaborateFree, collaboratePro, communicate, and engage.
      Returns:
      OrganizationProductEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationProducts

      public OrganizationProductEntityListing getAuthorizationProducts(GetAuthorizationProductsRequest request) throws IOException, ApiException
      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 object
      Returns:
      OrganizationProductEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationProducts

      public ApiResponse<OrganizationProductEntityListing> getAuthorizationProducts(ApiRequest<Void> request) throws IOException
      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 object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationRole

      public DomainOrganizationRole getAuthorizationRole(String roleId, Boolean userCount, List<String> expand) throws IOException, ApiException
      Get a single organization role. Get the organization role specified by its ID.
      Parameters:
      roleId - Role ID (required)
      userCount - Fetch the count of users who have this role granted in at least one division. Setting this value or defaulting to 'true' can lead to slower load times or timeouts for role queries with large member counts. (optional, default to true)
      expand - Which fields, if any, to expand. \"unusedPermissions\" returns the permissions not used for the role (optional)
      Returns:
      DomainOrganizationRole
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationRoleWithHttpInfo

      public ApiResponse<DomainOrganizationRole> getAuthorizationRoleWithHttpInfo(String roleId, Boolean userCount, List<String> expand) throws IOException
      Get a single organization role. Get the organization role specified by its ID.
      Parameters:
      roleId - Role ID (required)
      userCount - Fetch the count of users who have this role granted in at least one division. Setting this value or defaulting to 'true' can lead to slower load times or timeouts for role queries with large member counts. (optional, default to true)
      expand - Which fields, if any, to expand. \"unusedPermissions\" returns the permissions not used for the role (optional)
      Returns:
      DomainOrganizationRole
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationRole

      public DomainOrganizationRole getAuthorizationRole(GetAuthorizationRoleRequest request) throws IOException, ApiException
      Get a single organization role. Get the organization role specified by its ID.
      Parameters:
      request - The request object
      Returns:
      DomainOrganizationRole
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationRole

      public ApiResponse<DomainOrganizationRole> getAuthorizationRole(ApiRequest<Void> request) throws IOException
      Get a single organization role. Get the organization role specified by its ID.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationRoleComparedefaultRightRoleId

      public DomainOrgRoleDifference getAuthorizationRoleComparedefaultRightRoleId(String leftRoleId, String rightRoleId) throws IOException, ApiException
      Get an org role to default role comparison Compares any organization role to a default role id and show differences
      Parameters:
      leftRoleId - Left Role ID (required)
      rightRoleId - Right Role id (required)
      Returns:
      DomainOrgRoleDifference
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationRoleComparedefaultRightRoleIdWithHttpInfo

      public ApiResponse<DomainOrgRoleDifference> getAuthorizationRoleComparedefaultRightRoleIdWithHttpInfo(String leftRoleId, String rightRoleId) throws IOException
      Get an org role to default role comparison Compares any organization role to a default role id and show differences
      Parameters:
      leftRoleId - Left Role ID (required)
      rightRoleId - Right Role id (required)
      Returns:
      DomainOrgRoleDifference
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationRoleComparedefaultRightRoleId

      public DomainOrgRoleDifference getAuthorizationRoleComparedefaultRightRoleId(GetAuthorizationRoleComparedefaultRightRoleIdRequest request) throws IOException, ApiException
      Get an org role to default role comparison Compares any organization role to a default role id and show differences
      Parameters:
      request - The request object
      Returns:
      DomainOrgRoleDifference
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationRoleComparedefaultRightRoleId

      public ApiResponse<DomainOrgRoleDifference> getAuthorizationRoleComparedefaultRightRoleId(ApiRequest<Void> request) throws IOException
      Get an org role to default role comparison Compares any organization role to a default role id and show differences
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationRoleSubjectgrants

      public SubjectDivisionGrantsEntityListing getAuthorizationRoleSubjectgrants(String roleId, Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage) throws IOException, ApiException
      Get the subjects' granted divisions in the specified role. Includes the divisions for which the subject has a grant.
      Parameters:
      roleId - Role ID (required)
      pageSize - The total page size requested (optional, default to 25)
      pageNumber - The page number requested (optional, default to 1)
      sortBy - variable name requested to sort by (optional)
      expand - variable name requested by expand list (optional)
      nextPage - next page token (optional)
      previousPage - Previous page token (optional)
      Returns:
      SubjectDivisionGrantsEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationRoleSubjectgrantsWithHttpInfo

      public ApiResponse<SubjectDivisionGrantsEntityListing> getAuthorizationRoleSubjectgrantsWithHttpInfo(String roleId, Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage) throws IOException
      Get the subjects' granted divisions in the specified role. Includes the divisions for which the subject has a grant.
      Parameters:
      roleId - Role ID (required)
      pageSize - The total page size requested (optional, default to 25)
      pageNumber - The page number requested (optional, default to 1)
      sortBy - variable name requested to sort by (optional)
      expand - variable name requested by expand list (optional)
      nextPage - next page token (optional)
      previousPage - Previous page token (optional)
      Returns:
      SubjectDivisionGrantsEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationRoleSubjectgrants

      public SubjectDivisionGrantsEntityListing getAuthorizationRoleSubjectgrants(GetAuthorizationRoleSubjectgrantsRequest request) throws IOException, ApiException
      Get the subjects' granted divisions in the specified role. Includes the divisions for which the subject has a grant.
      Parameters:
      request - The request object
      Returns:
      SubjectDivisionGrantsEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationRoleSubjectgrants

      public ApiResponse<SubjectDivisionGrantsEntityListing> getAuthorizationRoleSubjectgrants(ApiRequest<Void> request) throws IOException
      Get the subjects' granted divisions in the specified role. Includes the divisions for which the subject has a grant.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationRoleUsers

      public UserReferenceEntityListing getAuthorizationRoleUsers(String roleId, Integer pageSize, Integer pageNumber) throws IOException, ApiException
      Get a list of the users in a specified role. Get an array of the UUIDs of the users in the specified role.
      Parameters:
      roleId - Role ID (required)
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      Returns:
      UserReferenceEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationRoleUsersWithHttpInfo

      public ApiResponse<UserReferenceEntityListing> getAuthorizationRoleUsersWithHttpInfo(String roleId, Integer pageSize, Integer pageNumber) throws IOException
      Get a list of the users in a specified role. Get an array of the UUIDs of the users in the specified role.
      Parameters:
      roleId - Role ID (required)
      pageSize - Page size (optional, default to 25)
      pageNumber - Page number (optional, default to 1)
      Returns:
      UserReferenceEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationRoleUsers

      public UserReferenceEntityListing getAuthorizationRoleUsers(GetAuthorizationRoleUsersRequest request) throws IOException, ApiException
      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 object
      Returns:
      UserReferenceEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationRoleUsers

      public ApiResponse<UserReferenceEntityListing> getAuthorizationRoleUsers(ApiRequest<Void> request) throws IOException
      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 object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationRoles

      public OrganizationRoleEntityListing getAuthorizationRoles(Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage, String name, List<String> permission, List<String> defaultRoleId, Boolean userCount, List<String> id) throws IOException, ApiException
      Retrieve a list of all roles defined for the organization
      Parameters:
      pageSize - The total page size requested (optional, default to 25)
      pageNumber - The page number requested (optional, default to 1)
      sortBy - variable name requested to sort by (optional)
      expand - variable name requested by expand list (optional)
      nextPage - next page token (optional)
      previousPage - Previous page token (optional)
      name - (optional)
      permission - (optional)
      defaultRoleId - (optional)
      userCount - (optional, default to true)
      id - id (optional)
      Returns:
      OrganizationRoleEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationRolesWithHttpInfo

      public ApiResponse<OrganizationRoleEntityListing> getAuthorizationRolesWithHttpInfo(Integer pageSize, Integer pageNumber, String sortBy, List<String> expand, String nextPage, String previousPage, String name, List<String> permission, List<String> defaultRoleId, Boolean userCount, List<String> id) throws IOException
      Retrieve a list of all roles defined for the organization
      Parameters:
      pageSize - The total page size requested (optional, default to 25)
      pageNumber - The page number requested (optional, default to 1)
      sortBy - variable name requested to sort by (optional)
      expand - variable name requested by expand list (optional)
      nextPage - next page token (optional)
      previousPage - Previous page token (optional)
      name - (optional)
      permission - (optional)
      defaultRoleId - (optional)
      userCount - (optional, default to true)
      id - id (optional)
      Returns:
      OrganizationRoleEntityListing
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationRoles

      public OrganizationRoleEntityListing getAuthorizationRoles(GetAuthorizationRolesRequest request) throws IOException, ApiException
      Retrieve a list of all roles defined for the organization
      Parameters:
      request - The request object
      Returns:
      OrganizationRoleEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationRoles

      public ApiResponse<OrganizationRoleEntityListing> getAuthorizationRoles(ApiRequest<Void> request) throws IOException
      Retrieve a list of all roles defined for the organization
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationRolesSettings

      public RoleSettings getAuthorizationRolesSettings() throws IOException, ApiException
      Get authorization role settings
      Returns:
      RoleSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationRolesSettingsWithHttpInfo

      public ApiResponse<RoleSettings> getAuthorizationRolesSettingsWithHttpInfo() throws IOException
      Get authorization role settings
      Returns:
      RoleSettings
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationRolesSettings

      public RoleSettings getAuthorizationRolesSettings(GetAuthorizationRolesSettingsRequest request) throws IOException, ApiException
      Get authorization role settings
      Parameters:
      request - The request object
      Returns:
      RoleSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationRolesSettings

      public ApiResponse<RoleSettings> getAuthorizationRolesSettings(ApiRequest<Void> request) throws IOException
      Get authorization role settings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationSettings

      public AuthorizationSettings getAuthorizationSettings() throws IOException, ApiException
      Get authorization settings
      Returns:
      AuthorizationSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationSettingsWithHttpInfo

      public ApiResponse<AuthorizationSettings> getAuthorizationSettingsWithHttpInfo() throws IOException
      Get authorization settings
      Returns:
      AuthorizationSettings
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationSettings

      public AuthorizationSettings getAuthorizationSettings(GetAuthorizationSettingsRequest request) throws IOException, ApiException
      Get authorization settings
      Parameters:
      request - The request object
      Returns:
      AuthorizationSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationSettings

      public ApiResponse<AuthorizationSettings> getAuthorizationSettings(ApiRequest<Void> request) throws IOException
      Get authorization settings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationSubject

      public AuthzSubject getAuthorizationSubject(String subjectId, Boolean includeDuplicates) throws IOException, ApiException
      Returns a listing of roles and permissions for a user.
      Parameters:
      subjectId - Subject ID (user or group) (required)
      includeDuplicates - Include multiple entries with the same role and division but different subjects (optional, default to false)
      Returns:
      AuthzSubject
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationSubjectWithHttpInfo

      public ApiResponse<AuthzSubject> getAuthorizationSubjectWithHttpInfo(String subjectId, Boolean includeDuplicates) throws IOException
      Returns a listing of roles and permissions for a user.
      Parameters:
      subjectId - Subject ID (user or group) (required)
      includeDuplicates - Include multiple entries with the same role and division but different subjects (optional, default to false)
      Returns:
      AuthzSubject
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationSubject

      public AuthzSubject getAuthorizationSubject(GetAuthorizationSubjectRequest request) throws IOException, ApiException
      Returns a listing of roles and permissions for a user.
      Parameters:
      request - The request object
      Returns:
      AuthzSubject
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationSubject

      public ApiResponse<AuthzSubject> getAuthorizationSubject(ApiRequest<Void> request) throws IOException
      Returns a listing of roles and permissions for a user.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationSubjectsMe

      public AuthzSubject getAuthorizationSubjectsMe(Boolean includeDuplicates) throws IOException, ApiException
      Returns a listing of roles and permissions for the currently authenticated user.
      Parameters:
      includeDuplicates - Include multiple entries with the same role and division but different subjects (optional, default to false)
      Returns:
      AuthzSubject
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationSubjectsMeWithHttpInfo

      public ApiResponse<AuthzSubject> getAuthorizationSubjectsMeWithHttpInfo(Boolean includeDuplicates) throws IOException
      Returns a listing of roles and permissions for the currently authenticated user.
      Parameters:
      includeDuplicates - Include multiple entries with the same role and division but different subjects (optional, default to false)
      Returns:
      AuthzSubject
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationSubjectsMe

      public AuthzSubject getAuthorizationSubjectsMe(GetAuthorizationSubjectsMeRequest request) throws IOException, ApiException
      Returns a listing of roles and permissions for the currently authenticated user.
      Parameters:
      request - The request object
      Returns:
      AuthzSubject
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationSubjectsMe

      public ApiResponse<AuthzSubject> getAuthorizationSubjectsMe(ApiRequest<Void> request) throws IOException
      Returns a listing of roles and permissions for the currently authenticated user.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationSubjectsRolecounts

      public Map<String,Object> getAuthorizationSubjectsRolecounts(List<String> id) throws IOException, ApiException
      Get the count of roles granted to a list of subjects
      Parameters:
      id - id (optional)
      Returns:
      Map<String, Object>
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationSubjectsRolecountsWithHttpInfo

      public ApiResponse<Map<String,Object>> getAuthorizationSubjectsRolecountsWithHttpInfo(List<String> id) throws IOException
      Get the count of roles granted to a list of subjects
      Parameters:
      id - id (optional)
      Returns:
      Map<String, Object>
      Throws:
      IOException - if the request fails to be processed

    • getAuthorizationSubjectsRolecounts

      public Map<String,Object> getAuthorizationSubjectsRolecounts(GetAuthorizationSubjectsRolecountsRequest request) throws IOException, ApiException
      Get the count of roles granted to a list of subjects
      Parameters:
      request - The request object
      Returns:
      Map<String, Object>
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getAuthorizationSubjectsRolecounts

      public ApiResponse<Map<String,Object>> getAuthorizationSubjectsRolecounts(ApiRequest<Void> request) throws IOException
      Get the count of roles granted to a list of subjects
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getUserRoles

      public UserAuthorization getUserRoles(String subjectId) throws IOException, ApiException
      Returns a listing of roles and permissions for a user.
      Parameters:
      subjectId - User ID (required)
      Returns:
      UserAuthorization
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getUserRolesWithHttpInfo

      public ApiResponse<UserAuthorization> getUserRolesWithHttpInfo(String subjectId) throws IOException
      Returns a listing of roles and permissions for a user.
      Parameters:
      subjectId - User ID (required)
      Returns:
      UserAuthorization
      Throws:
      IOException - if the request fails to be processed

    • getUserRoles

      public UserAuthorization getUserRoles(GetUserRolesRequest request) throws IOException, ApiException
      Returns a listing of roles and permissions for a user.
      Parameters:
      request - The request object
      Returns:
      UserAuthorization
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getUserRoles

      public ApiResponse<UserAuthorization> getUserRoles(ApiRequest<Void> request) throws IOException
      Returns a listing of roles and permissions for a user.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchAuthorizationRole

      public DomainOrganizationRole patchAuthorizationRole(String roleId, DomainOrganizationRole body) throws IOException, ApiException
      Patch Organization Role for needsUpdate Field Patch Organization Role for needsUpdate Field
      Parameters:
      roleId - Role ID (required)
      body - Organization role (required)
      Returns:
      DomainOrganizationRole
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchAuthorizationRoleWithHttpInfo

      public ApiResponse<DomainOrganizationRole> patchAuthorizationRoleWithHttpInfo(String roleId, DomainOrganizationRole body) throws IOException
      Patch Organization Role for needsUpdate Field Patch Organization Role for needsUpdate Field
      Parameters:
      roleId - Role ID (required)
      body - Organization role (required)
      Returns:
      DomainOrganizationRole
      Throws:
      IOException - if the request fails to be processed

    • patchAuthorizationRole

      public DomainOrganizationRole patchAuthorizationRole(PatchAuthorizationRoleRequest request) throws IOException, ApiException
      Patch Organization Role for needsUpdate Field Patch Organization Role for needsUpdate Field
      Parameters:
      request - The request object
      Returns:
      DomainOrganizationRole
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchAuthorizationRole

      public ApiResponse<DomainOrganizationRole> patchAuthorizationRole(ApiRequest<DomainOrganizationRole> request) throws IOException
      Patch Organization Role for needsUpdate Field Patch Organization Role for needsUpdate Field
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchAuthorizationSettings

      public AuthorizationSettings patchAuthorizationSettings(AuthorizationSettings body) throws IOException, ApiException
      Change authorization settings Change authorization settings
      Parameters:
      body - Authorization Settings (required)
      Returns:
      AuthorizationSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchAuthorizationSettingsWithHttpInfo

      public ApiResponse<AuthorizationSettings> patchAuthorizationSettingsWithHttpInfo(AuthorizationSettings body) throws IOException
      Change authorization settings Change authorization settings
      Parameters:
      body - Authorization Settings (required)
      Returns:
      AuthorizationSettings
      Throws:
      IOException - if the request fails to be processed

    • patchAuthorizationSettings

      public AuthorizationSettings patchAuthorizationSettings(PatchAuthorizationSettingsRequest request) throws IOException, ApiException
      Change authorization settings Change authorization settings
      Parameters:
      request - The request object
      Returns:
      AuthorizationSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchAuthorizationSettings

      public ApiResponse<AuthorizationSettings> patchAuthorizationSettings(ApiRequest<AuthorizationSettings> request) throws IOException
      Change authorization settings Change authorization settings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postAuthorizationDivisionObject

      public void postAuthorizationDivisionObject(String divisionId, String objectType, List<String> body) throws IOException, ApiException
      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:
      divisionId - Division ID (required)
      objectType - The type of the objects. Must be one of the valid object types (required)
      body - Object Id List (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAuthorizationDivisionObjectWithHttpInfo

      public ApiResponse<Void> postAuthorizationDivisionObjectWithHttpInfo(String divisionId, String objectType, List<String> body) throws IOException
      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:
      divisionId - Division ID (required)
      objectType - The type of the objects. Must be one of the valid object types (required)
      body - Object Id List (required)
      Throws:
      IOException - if the request fails to be processed

    • postAuthorizationDivisionObject

      public void postAuthorizationDivisionObject(PostAuthorizationDivisionObjectRequest request) throws IOException, ApiException
      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 object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAuthorizationDivisionObject

      public ApiResponse<Void> postAuthorizationDivisionObject(ApiRequest<List<String>> request) throws IOException
      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 object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postAuthorizationDivisionRestore

      public AuthzDivision postAuthorizationDivisionRestore(String divisionId, AuthzDivision body) throws IOException, ApiException
      Recreate a previously deleted division.
      Parameters:
      divisionId - Division ID (required)
      body - Recreated division data (required)
      Returns:
      AuthzDivision
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAuthorizationDivisionRestoreWithHttpInfo

      public ApiResponse<AuthzDivision> postAuthorizationDivisionRestoreWithHttpInfo(String divisionId, AuthzDivision body) throws IOException
      Recreate a previously deleted division.
      Parameters:
      divisionId - Division ID (required)
      body - Recreated division data (required)
      Returns:
      AuthzDivision
      Throws:
      IOException - if the request fails to be processed

    • postAuthorizationDivisionRestore

      public AuthzDivision postAuthorizationDivisionRestore(PostAuthorizationDivisionRestoreRequest request) throws IOException, ApiException
      Recreate a previously deleted division.
      Parameters:
      request - The request object
      Returns:
      AuthzDivision
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAuthorizationDivisionRestore

      public ApiResponse<AuthzDivision> postAuthorizationDivisionRestore(ApiRequest<AuthzDivision> request) throws IOException
      Recreate a previously deleted division.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postAuthorizationDivisions

      public AuthzDivision postAuthorizationDivisions(AuthzDivision body) throws IOException, ApiException
      Create a division.
      Parameters:
      body - Division (required)
      Returns:
      AuthzDivision
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAuthorizationDivisionsWithHttpInfo

      public ApiResponse<AuthzDivision> postAuthorizationDivisionsWithHttpInfo(AuthzDivision body) throws IOException
      Create a division.
      Parameters:
      body - Division (required)
      Returns:
      AuthzDivision
      Throws:
      IOException - if the request fails to be processed

    • postAuthorizationDivisions

      public AuthzDivision postAuthorizationDivisions(PostAuthorizationDivisionsRequest request) throws IOException, ApiException
      Create a division.
      Parameters:
      request - The request object
      Returns:
      AuthzDivision
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAuthorizationDivisions

      public ApiResponse<AuthzDivision> postAuthorizationDivisions(ApiRequest<AuthzDivision> request) throws IOException
      Create a division.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postAuthorizationPoliciesTarget

      public AuthorizationPolicy postAuthorizationPoliciesTarget(String targetName, AuthorizationPolicy body, Boolean skipLockoutCheck) throws IOException, ApiException
      Add an access control policy for a specified resource target and subject
      Parameters:
      targetName - The domain:entity:action target to which the policy will be applied (required)
      body - Access control policy (required)
      skipLockoutCheck - Skip lockout check; if true, policy will not be evaluated against current context for lockout risk (optional, default to false)
      Returns:
      AuthorizationPolicy
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAuthorizationPoliciesTargetWithHttpInfo

      public ApiResponse<AuthorizationPolicy> postAuthorizationPoliciesTargetWithHttpInfo(String targetName, AuthorizationPolicy body, Boolean skipLockoutCheck) throws IOException
      Add an access control policy for a specified resource target and subject
      Parameters:
      targetName - The domain:entity:action target to which the policy will be applied (required)
      body - Access control policy (required)
      skipLockoutCheck - Skip lockout check; if true, policy will not be evaluated against current context for lockout risk (optional, default to false)
      Returns:
      AuthorizationPolicy
      Throws:
      IOException - if the request fails to be processed

    • postAuthorizationPoliciesTarget

      public AuthorizationPolicy postAuthorizationPoliciesTarget(PostAuthorizationPoliciesTargetRequest request) throws IOException, ApiException
      Add an access control policy for a specified resource target and subject
      Parameters:
      request - The request object
      Returns:
      AuthorizationPolicy
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAuthorizationPoliciesTarget

      public ApiResponse<AuthorizationPolicy> postAuthorizationPoliciesTarget(ApiRequest<AuthorizationPolicy> request) throws IOException
      Add an access control policy for a specified resource target and subject
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postAuthorizationPoliciesTargetValidate

      public ValidationErrorListing postAuthorizationPoliciesTargetValidate(String targetName, AuthorizationPolicy body) throws IOException, ApiException
      Validate the conditions and attributes of an access control policy for a specified resource target
      Parameters:
      targetName - The domain:entity:action target to which the policy will be applied (required)
      body - Access control policy (required)
      Returns:
      ValidationErrorListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAuthorizationPoliciesTargetValidateWithHttpInfo

      public ApiResponse<ValidationErrorListing> postAuthorizationPoliciesTargetValidateWithHttpInfo(String targetName, AuthorizationPolicy body) throws IOException
      Validate the conditions and attributes of an access control policy for a specified resource target
      Parameters:
      targetName - The domain:entity:action target to which the policy will be applied (required)
      body - Access control policy (required)
      Returns:
      ValidationErrorListing
      Throws:
      IOException - if the request fails to be processed

    • postAuthorizationPoliciesTargetValidate

      public ValidationErrorListing postAuthorizationPoliciesTargetValidate(PostAuthorizationPoliciesTargetValidateRequest request) throws IOException, ApiException
      Validate the conditions and attributes of an access control policy for a specified resource target
      Parameters:
      request - The request object
      Returns:
      ValidationErrorListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAuthorizationPoliciesTargetValidate

      public ApiResponse<ValidationErrorListing> postAuthorizationPoliciesTargetValidate(ApiRequest<AuthorizationPolicy> request) throws IOException
      Validate the conditions and attributes of an access control policy for a specified resource target
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postAuthorizationPolicySimulate

      public PolicyTestResult postAuthorizationPolicySimulate(String policyId, PolicyTestPayload body) throws IOException, ApiException
      Simulate a request and evaluate the specified policy ID against the provided values
      Parameters:
      policyId - The ID of the policy to test the simulated data against (required)
      body - A map of attribute names to type and simulated data value (required)
      Returns:
      PolicyTestResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAuthorizationPolicySimulateWithHttpInfo

      public ApiResponse<PolicyTestResult> postAuthorizationPolicySimulateWithHttpInfo(String policyId, PolicyTestPayload body) throws IOException
      Simulate a request and evaluate the specified policy ID against the provided values
      Parameters:
      policyId - The ID of the policy to test the simulated data against (required)
      body - A map of attribute names to type and simulated data value (required)
      Returns:
      PolicyTestResult
      Throws:
      IOException - if the request fails to be processed

    • postAuthorizationPolicySimulate

      public PolicyTestResult postAuthorizationPolicySimulate(PostAuthorizationPolicySimulateRequest request) throws IOException, ApiException
      Simulate a request and evaluate the specified policy ID against the provided values
      Parameters:
      request - The request object
      Returns:
      PolicyTestResult
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAuthorizationPolicySimulate

      public ApiResponse<PolicyTestResult> postAuthorizationPolicySimulate(ApiRequest<PolicyTestPayload> request) throws IOException
      Simulate a request and evaluate the specified policy ID against the provided values
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postAuthorizationRole

      public void postAuthorizationRole(String roleId, SubjectDivisions body, String subjectType) throws IOException, ApiException
      Bulk-grant subjects and divisions with an organization role.
      Parameters:
      roleId - Role ID (required)
      body - Subjects and Divisions (required)
      subjectType - what the type of the subjects are (PC_GROUP, PC_USER or PC_OAUTH_CLIENT) (optional, default to PC_USER)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAuthorizationRoleWithHttpInfo

      public ApiResponse<Void> postAuthorizationRoleWithHttpInfo(String roleId, SubjectDivisions body, String subjectType) throws IOException
      Bulk-grant subjects and divisions with an organization role.
      Parameters:
      roleId - Role ID (required)
      body - Subjects and Divisions (required)
      subjectType - what the type of the subjects are (PC_GROUP, PC_USER or PC_OAUTH_CLIENT) (optional, default to PC_USER)
      Throws:
      IOException - if the request fails to be processed

    • postAuthorizationRole

      public void postAuthorizationRole(PostAuthorizationRoleRequest request) throws IOException, ApiException
      Bulk-grant subjects and divisions with an organization role.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAuthorizationRole

      public ApiResponse<Void> postAuthorizationRole(ApiRequest<SubjectDivisions> request) throws IOException
      Bulk-grant subjects and divisions with an organization role.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postAuthorizationRoleComparedefaultRightRoleId

      public DomainOrgRoleDifference postAuthorizationRoleComparedefaultRightRoleId(String leftRoleId, String rightRoleId, DomainOrganizationRole body) throws IOException, ApiException
      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:
      leftRoleId - Left Role ID (required)
      rightRoleId - Right Role id (required)
      body - Organization role (required)
      Returns:
      DomainOrgRoleDifference
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAuthorizationRoleComparedefaultRightRoleIdWithHttpInfo

      public ApiResponse<DomainOrgRoleDifference> postAuthorizationRoleComparedefaultRightRoleIdWithHttpInfo(String leftRoleId, String rightRoleId, DomainOrganizationRole body) throws IOException
      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:
      leftRoleId - Left Role ID (required)
      rightRoleId - Right Role id (required)
      body - Organization role (required)
      Returns:
      DomainOrgRoleDifference
      Throws:
      IOException - if the request fails to be processed

    • postAuthorizationRoleComparedefaultRightRoleId

      public DomainOrgRoleDifference postAuthorizationRoleComparedefaultRightRoleId(PostAuthorizationRoleComparedefaultRightRoleIdRequest request) throws IOException, ApiException
      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 object
      Returns:
      DomainOrgRoleDifference
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAuthorizationRoleComparedefaultRightRoleId

      public ApiResponse<DomainOrgRoleDifference> postAuthorizationRoleComparedefaultRightRoleId(ApiRequest<DomainOrganizationRole> request) throws IOException
      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 object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postAuthorizationRoles

      public DomainOrganizationRole postAuthorizationRoles(DomainOrganizationRoleCreate body) throws IOException, ApiException
      Create an organization role.
      Parameters:
      body - Organization role (required)
      Returns:
      DomainOrganizationRole
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAuthorizationRolesWithHttpInfo

      public ApiResponse<DomainOrganizationRole> postAuthorizationRolesWithHttpInfo(DomainOrganizationRoleCreate body) throws IOException
      Create an organization role.
      Parameters:
      body - Organization role (required)
      Returns:
      DomainOrganizationRole
      Throws:
      IOException - if the request fails to be processed

    • postAuthorizationRoles

      public DomainOrganizationRole postAuthorizationRoles(PostAuthorizationRolesRequest request) throws IOException, ApiException
      Create an organization role.
      Parameters:
      request - The request object
      Returns:
      DomainOrganizationRole
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAuthorizationRoles

      public ApiResponse<DomainOrganizationRole> postAuthorizationRoles(ApiRequest<DomainOrganizationRoleCreate> request) throws IOException
      Create an organization role.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postAuthorizationRolesDefault

      public OrganizationRoleEntityListing postAuthorizationRolesDefault(Boolean force) throws IOException, ApiException
      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:
      force - Restore default roles (optional, default to false)
      Returns:
      OrganizationRoleEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAuthorizationRolesDefaultWithHttpInfo

      public ApiResponse<OrganizationRoleEntityListing> postAuthorizationRolesDefaultWithHttpInfo(Boolean force) throws IOException
      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:
      force - Restore default roles (optional, default to false)
      Returns:
      OrganizationRoleEntityListing
      Throws:
      IOException - if the request fails to be processed

    • postAuthorizationRolesDefault

      public OrganizationRoleEntityListing postAuthorizationRolesDefault(PostAuthorizationRolesDefaultRequest request) throws IOException, ApiException
      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 object
      Returns:
      OrganizationRoleEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAuthorizationRolesDefault

      public ApiResponse<OrganizationRoleEntityListing> postAuthorizationRolesDefault(ApiRequest<Void> request) throws IOException
      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 object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postAuthorizationSubjectBulkadd

      public void postAuthorizationSubjectBulkadd(String subjectId, RoleDivisionGrants body, String subjectType) throws IOException, ApiException
      Bulk-grant roles and divisions to a subject.
      Parameters:
      subjectId - Subject ID (user or group) (required)
      body - Pairs of role and division IDs (required)
      subjectType - what the type of the subject is (PC_GROUP, PC_USER or PC_OAUTH_CLIENT) (optional, default to PC_USER)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAuthorizationSubjectBulkaddWithHttpInfo

      public ApiResponse<Void> postAuthorizationSubjectBulkaddWithHttpInfo(String subjectId, RoleDivisionGrants body, String subjectType) throws IOException
      Bulk-grant roles and divisions to a subject.
      Parameters:
      subjectId - Subject ID (user or group) (required)
      body - Pairs of role and division IDs (required)
      subjectType - what the type of the subject is (PC_GROUP, PC_USER or PC_OAUTH_CLIENT) (optional, default to PC_USER)
      Throws:
      IOException - if the request fails to be processed

    • postAuthorizationSubjectBulkadd

      public void postAuthorizationSubjectBulkadd(PostAuthorizationSubjectBulkaddRequest request) throws IOException, ApiException
      Bulk-grant roles and divisions to a subject.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAuthorizationSubjectBulkadd

      public ApiResponse<Void> postAuthorizationSubjectBulkadd(ApiRequest<RoleDivisionGrants> request) throws IOException
      Bulk-grant roles and divisions to a subject.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postAuthorizationSubjectBulkremove

      public void postAuthorizationSubjectBulkremove(String subjectId, RoleDivisionGrants body) throws IOException, ApiException
      Bulk-remove grants from a subject.
      Parameters:
      subjectId - Subject ID (user or group) (required)
      body - Pairs of role and division IDs (required)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAuthorizationSubjectBulkremoveWithHttpInfo

      public ApiResponse<Void> postAuthorizationSubjectBulkremoveWithHttpInfo(String subjectId, RoleDivisionGrants body) throws IOException
      Bulk-remove grants from a subject.
      Parameters:
      subjectId - Subject ID (user or group) (required)
      body - Pairs of role and division IDs (required)
      Throws:
      IOException - if the request fails to be processed

    • postAuthorizationSubjectBulkremove

      public void postAuthorizationSubjectBulkremove(PostAuthorizationSubjectBulkremoveRequest request) throws IOException, ApiException
      Bulk-remove grants from a subject.
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAuthorizationSubjectBulkremove

      public ApiResponse<Void> postAuthorizationSubjectBulkremove(ApiRequest<RoleDivisionGrants> request) throws IOException
      Bulk-remove grants from a subject.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postAuthorizationSubjectBulkreplace

      public void postAuthorizationSubjectBulkreplace(String subjectId, RoleDivisionGrants body, String subjectType) throws IOException, ApiException
      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:
      subjectId - Subject ID (user or group) (required)
      body - Pairs of role and division IDs (required)
      subjectType - what the type of the subject is (PC_GROUP, PC_USER or PC_OAUTH_CLIENT) (optional, default to PC_USER)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAuthorizationSubjectBulkreplaceWithHttpInfo

      public ApiResponse<Void> postAuthorizationSubjectBulkreplaceWithHttpInfo(String subjectId, RoleDivisionGrants body, String subjectType) throws IOException
      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:
      subjectId - Subject ID (user or group) (required)
      body - Pairs of role and division IDs (required)
      subjectType - what the type of the subject is (PC_GROUP, PC_USER or PC_OAUTH_CLIENT) (optional, default to PC_USER)
      Throws:
      IOException - if the request fails to be processed

    • postAuthorizationSubjectBulkreplace

      public void postAuthorizationSubjectBulkreplace(PostAuthorizationSubjectBulkreplaceRequest request) throws IOException, ApiException
      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 object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAuthorizationSubjectBulkreplace

      public ApiResponse<Void> postAuthorizationSubjectBulkreplace(ApiRequest<RoleDivisionGrants> request) throws IOException
      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 object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postAuthorizationSubjectDivisionRole

      public void postAuthorizationSubjectDivisionRole(String subjectId, String divisionId, String roleId, String subjectType) throws IOException, ApiException
      Make a grant of a role in a division
      Parameters:
      subjectId - Subject ID (user or group) (required)
      divisionId - the id of the division to which to make the grant (required)
      roleId - the id of the role to grant (required)
      subjectType - what the type of the subject is: PC_GROUP, PC_USER or PC_OAUTH_CLIENT (note: for cross-org authorization, please use the Organization Authorization endpoints) (optional, default to PC_USER)
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAuthorizationSubjectDivisionRoleWithHttpInfo

      public ApiResponse<Void> postAuthorizationSubjectDivisionRoleWithHttpInfo(String subjectId, String divisionId, String roleId, String subjectType) throws IOException
      Make a grant of a role in a division
      Parameters:
      subjectId - Subject ID (user or group) (required)
      divisionId - the id of the division to which to make the grant (required)
      roleId - the id of the role to grant (required)
      subjectType - what the type of the subject is: PC_GROUP, PC_USER or PC_OAUTH_CLIENT (note: for cross-org authorization, please use the Organization Authorization endpoints) (optional, default to PC_USER)
      Throws:
      IOException - if the request fails to be processed

    • postAuthorizationSubjectDivisionRole

      public void postAuthorizationSubjectDivisionRole(PostAuthorizationSubjectDivisionRoleRequest request) throws IOException, ApiException
      Make a grant of a role in a division
      Parameters:
      request - The request object
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postAuthorizationSubjectDivisionRole

      public ApiResponse<Void> postAuthorizationSubjectDivisionRole(ApiRequest<Void> request) throws IOException
      Make a grant of a role in a division
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putAuthorizationDivision

      public AuthzDivision putAuthorizationDivision(String divisionId, AuthzDivision body) throws IOException, ApiException
      Update a division.
      Parameters:
      divisionId - Division ID (required)
      body - Updated division data (required)
      Returns:
      AuthzDivision
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putAuthorizationDivisionWithHttpInfo

      public ApiResponse<AuthzDivision> putAuthorizationDivisionWithHttpInfo(String divisionId, AuthzDivision body) throws IOException
      Update a division.
      Parameters:
      divisionId - Division ID (required)
      body - Updated division data (required)
      Returns:
      AuthzDivision
      Throws:
      IOException - if the request fails to be processed

    • putAuthorizationDivision

      public AuthzDivision putAuthorizationDivision(PutAuthorizationDivisionRequest request) throws IOException, ApiException
      Update a division.
      Parameters:
      request - The request object
      Returns:
      AuthzDivision
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putAuthorizationDivision

      public ApiResponse<AuthzDivision> putAuthorizationDivision(ApiRequest<AuthzDivision> request) throws IOException
      Update a division.
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putAuthorizationPoliciesTarget

      public AuthorizationPolicy putAuthorizationPoliciesTarget(String targetName, AuthorizationPolicy body, Boolean skipLockoutCheck) throws IOException, ApiException
      Add an access control policy for a specified resource target and subject, overwriting any existing policy
      Parameters:
      targetName - The domain:entity:action target to which the policy will be applied (required)
      body - Access control policy (required)
      skipLockoutCheck - Skip lockout check; if true, policy will not be evaluated against current context for lockout risk (optional, default to false)
      Returns:
      AuthorizationPolicy
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putAuthorizationPoliciesTargetWithHttpInfo

      public ApiResponse<AuthorizationPolicy> putAuthorizationPoliciesTargetWithHttpInfo(String targetName, AuthorizationPolicy body, Boolean skipLockoutCheck) throws IOException
      Add an access control policy for a specified resource target and subject, overwriting any existing policy
      Parameters:
      targetName - The domain:entity:action target to which the policy will be applied (required)
      body - Access control policy (required)
      skipLockoutCheck - Skip lockout check; if true, policy will not be evaluated against current context for lockout risk (optional, default to false)
      Returns:
      AuthorizationPolicy
      Throws:
      IOException - if the request fails to be processed

    • putAuthorizationPoliciesTarget

      public AuthorizationPolicy putAuthorizationPoliciesTarget(PutAuthorizationPoliciesTargetRequest request) throws IOException, ApiException
      Add an access control policy for a specified resource target and subject, overwriting any existing policy
      Parameters:
      request - The request object
      Returns:
      AuthorizationPolicy
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putAuthorizationPoliciesTarget

      public ApiResponse<AuthorizationPolicy> putAuthorizationPoliciesTarget(ApiRequest<AuthorizationPolicy> request) throws IOException
      Add an access control policy for a specified resource target and subject, overwriting any existing policy
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putAuthorizationPolicy

      public AuthorizationPolicy putAuthorizationPolicy(String policyId, AuthorizationPolicy body, Boolean skipLockoutCheck) throws IOException, ApiException
      Update an access control policy with a given ID
      Parameters:
      policyId - The ID of the policy to update (required)
      body - Access control policy (required)
      skipLockoutCheck - Skip lockout check; if true, policy will not be evaluated against current context for lockout risk (optional, default to false)
      Returns:
      AuthorizationPolicy
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putAuthorizationPolicyWithHttpInfo

      public ApiResponse<AuthorizationPolicy> putAuthorizationPolicyWithHttpInfo(String policyId, AuthorizationPolicy body, Boolean skipLockoutCheck) throws IOException
      Update an access control policy with a given ID
      Parameters:
      policyId - The ID of the policy to update (required)
      body - Access control policy (required)
      skipLockoutCheck - Skip lockout check; if true, policy will not be evaluated against current context for lockout risk (optional, default to false)
      Returns:
      AuthorizationPolicy
      Throws:
      IOException - if the request fails to be processed

    • putAuthorizationPolicy

      public AuthorizationPolicy putAuthorizationPolicy(PutAuthorizationPolicyRequest request) throws IOException, ApiException
      Update an access control policy with a given ID
      Parameters:
      request - The request object
      Returns:
      AuthorizationPolicy
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putAuthorizationPolicy

      public ApiResponse<AuthorizationPolicy> putAuthorizationPolicy(ApiRequest<AuthorizationPolicy> request) throws IOException
      Update an access control policy with a given ID
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putAuthorizationRole

      public DomainOrganizationRole putAuthorizationRole(String roleId, DomainOrganizationRoleUpdate body) throws IOException, ApiException
      Update an organization role. Update
      Parameters:
      roleId - Role ID (required)
      body - Organization role (required)
      Returns:
      DomainOrganizationRole
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putAuthorizationRoleWithHttpInfo

      public ApiResponse<DomainOrganizationRole> putAuthorizationRoleWithHttpInfo(String roleId, DomainOrganizationRoleUpdate body) throws IOException
      Update an organization role. Update
      Parameters:
      roleId - Role ID (required)
      body - Organization role (required)
      Returns:
      DomainOrganizationRole
      Throws:
      IOException - if the request fails to be processed

    • putAuthorizationRole

      public DomainOrganizationRole putAuthorizationRole(PutAuthorizationRoleRequest request) throws IOException, ApiException
      Update an organization role. Update
      Parameters:
      request - The request object
      Returns:
      DomainOrganizationRole
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putAuthorizationRole

      public ApiResponse<DomainOrganizationRole> putAuthorizationRole(ApiRequest<DomainOrganizationRoleUpdate> request) throws IOException
      Update an organization role. Update
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putAuthorizationRoleUsersAdd

      public List<String> putAuthorizationRoleUsersAdd(String roleId, List<String> body) throws IOException, ApiException
      Sets the users for the role
      Parameters:
      roleId - Role ID (required)
      body - List of user IDs (required)
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putAuthorizationRoleUsersAddWithHttpInfo

      public ApiResponse<List<String>> putAuthorizationRoleUsersAddWithHttpInfo(String roleId, List<String> body) throws IOException
      Sets the users for the role
      Parameters:
      roleId - Role ID (required)
      body - List of user IDs (required)
      Returns:
      List
      Throws:
      IOException - if the request fails to be processed

    • putAuthorizationRoleUsersAdd

      public List<String> putAuthorizationRoleUsersAdd(PutAuthorizationRoleUsersAddRequest request) throws IOException, ApiException
      Sets the users for the role
      Parameters:
      request - The request object
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putAuthorizationRoleUsersAdd

      public ApiResponse<List<String>> putAuthorizationRoleUsersAdd(ApiRequest<List<String>> request) throws IOException
      Sets the users for the role
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putAuthorizationRoleUsersRemove

      public List<String> putAuthorizationRoleUsersRemove(String roleId, List<String> body) throws IOException, ApiException
      Removes the users from the role
      Parameters:
      roleId - Role ID (required)
      body - List of user IDs (required)
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putAuthorizationRoleUsersRemoveWithHttpInfo

      public ApiResponse<List<String>> putAuthorizationRoleUsersRemoveWithHttpInfo(String roleId, List<String> body) throws IOException
      Removes the users from the role
      Parameters:
      roleId - Role ID (required)
      body - List of user IDs (required)
      Returns:
      List
      Throws:
      IOException - if the request fails to be processed

    • putAuthorizationRoleUsersRemove

      public List<String> putAuthorizationRoleUsersRemove(PutAuthorizationRoleUsersRemoveRequest request) throws IOException, ApiException
      Removes the users from the role
      Parameters:
      request - The request object
      Returns:
      List
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putAuthorizationRoleUsersRemove

      public ApiResponse<List<String>> putAuthorizationRoleUsersRemove(ApiRequest<List<String>> request) throws IOException
      Removes the users from the role
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putAuthorizationRolesDefault

      public OrganizationRoleEntityListing putAuthorizationRolesDefault(List<DomainOrganizationRole> body) throws IOException, ApiException
      Restore specified default roles
      Parameters:
      body - Organization roles list (required)
      Returns:
      OrganizationRoleEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putAuthorizationRolesDefaultWithHttpInfo

      public ApiResponse<OrganizationRoleEntityListing> putAuthorizationRolesDefaultWithHttpInfo(List<DomainOrganizationRole> body) throws IOException
      Restore specified default roles
      Parameters:
      body - Organization roles list (required)
      Returns:
      OrganizationRoleEntityListing
      Throws:
      IOException - if the request fails to be processed

    • putAuthorizationRolesDefault

      public OrganizationRoleEntityListing putAuthorizationRolesDefault(PutAuthorizationRolesDefaultRequest request) throws IOException, ApiException
      Restore specified default roles
      Parameters:
      request - The request object
      Returns:
      OrganizationRoleEntityListing
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putAuthorizationRolesDefault

      public ApiResponse<OrganizationRoleEntityListing> putAuthorizationRolesDefault(ApiRequest<List<DomainOrganizationRole>> request) throws IOException
      Restore specified default roles
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putAuthorizationRolesSettings

      public RoleSettings putAuthorizationRolesSettings(RoleSettings body) throws IOException, ApiException
      Change authorization role settings Change role settings
      Parameters:
      body - Authorization Role Settings (required)
      Returns:
      RoleSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putAuthorizationRolesSettingsWithHttpInfo

      public ApiResponse<RoleSettings> putAuthorizationRolesSettingsWithHttpInfo(RoleSettings body) throws IOException
      Change authorization role settings Change role settings
      Parameters:
      body - Authorization Role Settings (required)
      Returns:
      RoleSettings
      Throws:
      IOException - if the request fails to be processed

    • putAuthorizationRolesSettings

      public RoleSettings putAuthorizationRolesSettings(PutAuthorizationRolesSettingsRequest request) throws IOException, ApiException
      Change authorization role settings Change role settings
      Parameters:
      request - The request object
      Returns:
      RoleSettings
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putAuthorizationRolesSettings

      public ApiResponse<RoleSettings> putAuthorizationRolesSettings(ApiRequest<RoleSettings> request) throws IOException
      Change authorization role settings Change role settings
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putUserRoles

      public UserAuthorization putUserRoles(String subjectId, List<String> body) throws IOException, ApiException
      Sets the user's roles
      Parameters:
      subjectId - User ID (required)
      body - List of roles (required)
      Returns:
      UserAuthorization
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putUserRolesWithHttpInfo

      public ApiResponse<UserAuthorization> putUserRolesWithHttpInfo(String subjectId, List<String> body) throws IOException
      Sets the user's roles
      Parameters:
      subjectId - User ID (required)
      body - List of roles (required)
      Returns:
      UserAuthorization
      Throws:
      IOException - if the request fails to be processed

    • putUserRoles

      public UserAuthorization putUserRoles(PutUserRolesRequest request) throws IOException, ApiException
      Sets the user's roles
      Parameters:
      request - The request object
      Returns:
      UserAuthorization
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putUserRoles

      public ApiResponse<UserAuthorization> putUserRoles(ApiRequest<List<String>> request) throws IOException
      Sets the user's roles
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed