Package com.mypurecloud.sdk.v2.api

Class SCIMApi

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

  • Constructor Details

    • SCIMApi

      public SCIMApi()

    • SCIMApi

      public SCIMApi(ApiClient apiClient)

  • Method Details

    • deleteScimUser

      public Empty deleteScimUser(String userId, String ifMatch) throws IOException, ApiException
      Delete a user
      Parameters:
      userId - The ID of a user. Returned with GET /api/v2/scim/users. (required)
      ifMatch - The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". (optional)
      Returns:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteScimUserWithHttpInfo

      public ApiResponse<Empty> deleteScimUserWithHttpInfo(String userId, String ifMatch) throws IOException
      Delete a user
      Parameters:
      userId - The ID of a user. Returned with GET /api/v2/scim/users. (required)
      ifMatch - The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". (optional)
      Returns:
      Empty
      Throws:
      IOException - if the request fails to be processed

    • deleteScimUser

      public Empty deleteScimUser(DeleteScimUserRequest request) throws IOException, ApiException
      Delete a user
      Parameters:
      request - The request object
      Returns:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteScimUser

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

    • deleteScimV2User

      public Empty deleteScimV2User(String userId, String ifMatch) throws IOException, ApiException
      Delete a user
      Parameters:
      userId - The ID of a user. Returned with GET /api/v2/scim/v2/users. (required)
      ifMatch - The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". (optional)
      Returns:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteScimV2UserWithHttpInfo

      public ApiResponse<Empty> deleteScimV2UserWithHttpInfo(String userId, String ifMatch) throws IOException
      Delete a user
      Parameters:
      userId - The ID of a user. Returned with GET /api/v2/scim/v2/users. (required)
      ifMatch - The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". (optional)
      Returns:
      Empty
      Throws:
      IOException - if the request fails to be processed

    • deleteScimV2User

      public Empty deleteScimV2User(DeleteScimV2UserRequest request) throws IOException, ApiException
      Delete a user
      Parameters:
      request - The request object
      Returns:
      Empty
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • deleteScimV2User

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

    • getScimGroup

      public ScimV2Group getScimGroup(String groupId, List<String> attributes, List<String> excludedAttributes, String ifNoneMatch) throws IOException, ApiException
      Get a group
      Parameters:
      groupId - The ID of a group. Returned with GET /api/v2/scim/groups. (required)
      attributes - Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes. (optional)
      excludedAttributes - Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns \"id\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. (optional)
      ifNoneMatch - The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified. (optional)
      Returns:
      ScimV2Group
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getScimGroupWithHttpInfo

      public ApiResponse<ScimV2Group> getScimGroupWithHttpInfo(String groupId, List<String> attributes, List<String> excludedAttributes, String ifNoneMatch) throws IOException
      Get a group
      Parameters:
      groupId - The ID of a group. Returned with GET /api/v2/scim/groups. (required)
      attributes - Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes. (optional)
      excludedAttributes - Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns \"id\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. (optional)
      ifNoneMatch - The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified. (optional)
      Returns:
      ScimV2Group
      Throws:
      IOException - if the request fails to be processed

    • getScimGroup

      public ScimV2Group getScimGroup(GetScimGroupRequest request) throws IOException, ApiException
      Get a group
      Parameters:
      request - The request object
      Returns:
      ScimV2Group
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getScimGroup

      public ApiResponse<ScimV2Group> getScimGroup(ApiRequest<Void> request) throws IOException
      Get a group
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getScimGroups

      public ScimGroupListResponse getScimGroups(Integer startIndex, Integer count, List<String> attributes, List<String> excludedAttributes, String filter) throws IOException, ApiException
      Get a list of groups
      Parameters:
      startIndex - The 1-based index of the first query result. (optional, default to 1)
      count - The requested number of items per page. A value of 0 returns \"totalResults\". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \"excludedAttributes\" or \"attributes\" query parameters to exclude or only include secondary lookup values such as \"externalId\", \"roles\", \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\", or \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\". (optional, default to 25)
      attributes - Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes. (optional)
      excludedAttributes - Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns \"id\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. (optional)
      filter - Filters results. If nothing is specified, returns all groups. Examples of valid values: \"id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\", \"displayname eq Sales\". (optional, default to null)
      Returns:
      ScimGroupListResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getScimGroupsWithHttpInfo

      public ApiResponse<ScimGroupListResponse> getScimGroupsWithHttpInfo(Integer startIndex, Integer count, List<String> attributes, List<String> excludedAttributes, String filter) throws IOException
      Get a list of groups
      Parameters:
      startIndex - The 1-based index of the first query result. (optional, default to 1)
      count - The requested number of items per page. A value of 0 returns \"totalResults\". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \"excludedAttributes\" or \"attributes\" query parameters to exclude or only include secondary lookup values such as \"externalId\", \"roles\", \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\", or \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\". (optional, default to 25)
      attributes - Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes. (optional)
      excludedAttributes - Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns \"id\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. (optional)
      filter - Filters results. If nothing is specified, returns all groups. Examples of valid values: \"id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\", \"displayname eq Sales\". (optional, default to null)
      Returns:
      ScimGroupListResponse
      Throws:
      IOException - if the request fails to be processed

    • getScimGroups

      public ScimGroupListResponse getScimGroups(GetScimGroupsRequest request) throws IOException, ApiException
      Get a list of groups
      Parameters:
      request - The request object
      Returns:
      ScimGroupListResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getScimGroups

      public ApiResponse<ScimGroupListResponse> getScimGroups(ApiRequest<Void> request) throws IOException
      Get a list of groups
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getScimResourcetype

      public ScimConfigResourceType getScimResourcetype(String resourceType) throws IOException, ApiException
      Get a resource type
      Parameters:
      resourceType - The type of resource. Returned with GET /api/v2/scim/resourcetypes. (required)
      Returns:
      ScimConfigResourceType
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getScimResourcetypeWithHttpInfo

      public ApiResponse<ScimConfigResourceType> getScimResourcetypeWithHttpInfo(String resourceType) throws IOException
      Get a resource type
      Parameters:
      resourceType - The type of resource. Returned with GET /api/v2/scim/resourcetypes. (required)
      Returns:
      ScimConfigResourceType
      Throws:
      IOException - if the request fails to be processed

    • getScimResourcetype

      public ScimConfigResourceType getScimResourcetype(GetScimResourcetypeRequest request) throws IOException, ApiException
      Get a resource type
      Parameters:
      request - The request object
      Returns:
      ScimConfigResourceType
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getScimResourcetype

      public ApiResponse<ScimConfigResourceType> getScimResourcetype(ApiRequest<Void> request) throws IOException
      Get a resource type
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getScimResourcetypes

      public ScimConfigResourceTypesListResponse getScimResourcetypes() throws IOException, ApiException
      Get a list of resource types
      Returns:
      ScimConfigResourceTypesListResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getScimResourcetypesWithHttpInfo

      public ApiResponse<ScimConfigResourceTypesListResponse> getScimResourcetypesWithHttpInfo() throws IOException
      Get a list of resource types
      Returns:
      ScimConfigResourceTypesListResponse
      Throws:
      IOException - if the request fails to be processed

    • getScimResourcetypes

      public ScimConfigResourceTypesListResponse getScimResourcetypes(GetScimResourcetypesRequest request) throws IOException, ApiException
      Get a list of resource types
      Parameters:
      request - The request object
      Returns:
      ScimConfigResourceTypesListResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getScimResourcetypes

      public ApiResponse<ScimConfigResourceTypesListResponse> getScimResourcetypes(ApiRequest<Void> request) throws IOException
      Get a list of resource types
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getScimSchema

      public ScimV2SchemaDefinition getScimSchema(String schemaId) throws IOException, ApiException
      Get a SCIM schema
      Parameters:
      schemaId - The ID of a schema. Returned with GET /api/v2/scim/schemas. (required)
      Returns:
      ScimV2SchemaDefinition
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getScimSchemaWithHttpInfo

      public ApiResponse<ScimV2SchemaDefinition> getScimSchemaWithHttpInfo(String schemaId) throws IOException
      Get a SCIM schema
      Parameters:
      schemaId - The ID of a schema. Returned with GET /api/v2/scim/schemas. (required)
      Returns:
      ScimV2SchemaDefinition
      Throws:
      IOException - if the request fails to be processed

    • getScimSchema

      public ScimV2SchemaDefinition getScimSchema(GetScimSchemaRequest request) throws IOException, ApiException
      Get a SCIM schema
      Parameters:
      request - The request object
      Returns:
      ScimV2SchemaDefinition
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getScimSchema

      public ApiResponse<ScimV2SchemaDefinition> getScimSchema(ApiRequest<Void> request) throws IOException
      Get a SCIM schema
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getScimSchemas

      public ScimV2SchemaListResponse getScimSchemas(String filter) throws IOException, ApiException
      Get a list of SCIM schemas
      Parameters:
      filter - Filtered results are invalid and return 403 Unauthorized. (optional, default to null)
      Returns:
      ScimV2SchemaListResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getScimSchemasWithHttpInfo

      public ApiResponse<ScimV2SchemaListResponse> getScimSchemasWithHttpInfo(String filter) throws IOException
      Get a list of SCIM schemas
      Parameters:
      filter - Filtered results are invalid and return 403 Unauthorized. (optional, default to null)
      Returns:
      ScimV2SchemaListResponse
      Throws:
      IOException - if the request fails to be processed

    • getScimSchemas

      public ScimV2SchemaListResponse getScimSchemas(GetScimSchemasRequest request) throws IOException, ApiException
      Get a list of SCIM schemas
      Parameters:
      request - The request object
      Returns:
      ScimV2SchemaListResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getScimSchemas

      public ApiResponse<ScimV2SchemaListResponse> getScimSchemas(ApiRequest<Void> request) throws IOException
      Get a list of SCIM schemas
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getScimServiceproviderconfig

      public ScimServiceProviderConfig getScimServiceproviderconfig(String ifNoneMatch) throws IOException, ApiException
      Get a service provider's configuration
      Parameters:
      ifNoneMatch - The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/serviceproviderconfig. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified. (optional)
      Returns:
      ScimServiceProviderConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getScimServiceproviderconfigWithHttpInfo

      public ApiResponse<ScimServiceProviderConfig> getScimServiceproviderconfigWithHttpInfo(String ifNoneMatch) throws IOException
      Get a service provider's configuration
      Parameters:
      ifNoneMatch - The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/serviceproviderconfig. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified. (optional)
      Returns:
      ScimServiceProviderConfig
      Throws:
      IOException - if the request fails to be processed

    • getScimServiceproviderconfig

      public ScimServiceProviderConfig getScimServiceproviderconfig(GetScimServiceproviderconfigRequest request) throws IOException, ApiException
      Get a service provider's configuration
      Parameters:
      request - The request object
      Returns:
      ScimServiceProviderConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getScimServiceproviderconfig

      public ApiResponse<ScimServiceProviderConfig> getScimServiceproviderconfig(ApiRequest<Void> request) throws IOException
      Get a service provider's configuration
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getScimUser

      public ScimV2User getScimUser(String userId, List<String> attributes, List<String> excludedAttributes, String ifNoneMatch) throws IOException, ApiException
      Get a user
      Parameters:
      userId - The ID of a user. Returned with GET /api/v2/scim/users. (required)
      attributes - Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes. (optional)
      excludedAttributes - Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. (optional)
      ifNoneMatch - The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified. (optional)
      Returns:
      ScimV2User
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getScimUserWithHttpInfo

      public ApiResponse<ScimV2User> getScimUserWithHttpInfo(String userId, List<String> attributes, List<String> excludedAttributes, String ifNoneMatch) throws IOException
      Get a user
      Parameters:
      userId - The ID of a user. Returned with GET /api/v2/scim/users. (required)
      attributes - Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes. (optional)
      excludedAttributes - Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. (optional)
      ifNoneMatch - The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified. (optional)
      Returns:
      ScimV2User
      Throws:
      IOException - if the request fails to be processed

    • getScimUser

      public ScimV2User getScimUser(GetScimUserRequest request) throws IOException, ApiException
      Get a user
      Parameters:
      request - The request object
      Returns:
      ScimV2User
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getScimUser

      public ApiResponse<ScimV2User> getScimUser(ApiRequest<Void> request) throws IOException
      Get a user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getScimUsers

      public ScimUserListResponse getScimUsers(Integer startIndex, Integer count, List<String> attributes, List<String> excludedAttributes, String filter) throws IOException, ApiException
      Get a list of users To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to \"active eq false\". By default, returns SCIM attributes \"externalId\", \"enterprise-user:manager\", and \"roles\". To exclude these attributes, set the attributes parameter to \"id,active\" or the excludeAttributes parameter to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".
      Parameters:
      startIndex - The 1-based index of the first query result. (optional, default to 1)
      count - The requested number of items per page. A value of 0 returns \"totalResults\". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \"excludedAttributes\" or \"attributes\" query parameters to exclude or only include secondary lookup values such as \"externalId\", \"roles\", \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\", or \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\". (optional, default to 25)
      attributes - Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes. (optional)
      excludedAttributes - Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. (optional)
      filter - Filters results. If nothing is specified, returns all active users. Examples of valid values: \"id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\", \"userName eq search@sample.org\", \"manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\", \"email eq search@sample.org\", \"division eq divisionName\", \"externalId eq 167844\", \"active eq false\", \"employeeNumber eq 9876543210\". (optional)
      Returns:
      ScimUserListResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getScimUsersWithHttpInfo

      public ApiResponse<ScimUserListResponse> getScimUsersWithHttpInfo(Integer startIndex, Integer count, List<String> attributes, List<String> excludedAttributes, String filter) throws IOException
      Get a list of users To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to \"active eq false\". By default, returns SCIM attributes \"externalId\", \"enterprise-user:manager\", and \"roles\". To exclude these attributes, set the attributes parameter to \"id,active\" or the excludeAttributes parameter to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".
      Parameters:
      startIndex - The 1-based index of the first query result. (optional, default to 1)
      count - The requested number of items per page. A value of 0 returns \"totalResults\". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \"excludedAttributes\" or \"attributes\" query parameters to exclude or only include secondary lookup values such as \"externalId\", \"roles\", \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\", or \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\". (optional, default to 25)
      attributes - Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes. (optional)
      excludedAttributes - Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. (optional)
      filter - Filters results. If nothing is specified, returns all active users. Examples of valid values: \"id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\", \"userName eq search@sample.org\", \"manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\", \"email eq search@sample.org\", \"division eq divisionName\", \"externalId eq 167844\", \"active eq false\", \"employeeNumber eq 9876543210\". (optional)
      Returns:
      ScimUserListResponse
      Throws:
      IOException - if the request fails to be processed

    • getScimUsers

      public ScimUserListResponse getScimUsers(GetScimUsersRequest request) throws IOException, ApiException
      Get a list of users To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to \"active eq false\". By default, returns SCIM attributes \"externalId\", \"enterprise-user:manager\", and \"roles\". To exclude these attributes, set the attributes parameter to \"id,active\" or the excludeAttributes parameter to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".
      Parameters:
      request - The request object
      Returns:
      ScimUserListResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getScimUsers

      public ApiResponse<ScimUserListResponse> getScimUsers(ApiRequest<Void> request) throws IOException
      Get a list of users To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to \"active eq false\". By default, returns SCIM attributes \"externalId\", \"enterprise-user:manager\", and \"roles\". To exclude these attributes, set the attributes parameter to \"id,active\" or the excludeAttributes parameter to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getScimV2Group

      public ScimV2Group getScimV2Group(String groupId, List<String> attributes, List<String> excludedAttributes, String ifNoneMatch) throws IOException, ApiException
      Get a group
      Parameters:
      groupId - The ID of a group. Returned with GET /api/v2/scim/v2/groups. (required)
      attributes - Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes. (optional)
      excludedAttributes - Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns \"id\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. (optional)
      ifNoneMatch - The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified. (optional)
      Returns:
      ScimV2Group
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getScimV2GroupWithHttpInfo

      public ApiResponse<ScimV2Group> getScimV2GroupWithHttpInfo(String groupId, List<String> attributes, List<String> excludedAttributes, String ifNoneMatch) throws IOException
      Get a group
      Parameters:
      groupId - The ID of a group. Returned with GET /api/v2/scim/v2/groups. (required)
      attributes - Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes. (optional)
      excludedAttributes - Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns \"id\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. (optional)
      ifNoneMatch - The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified. (optional)
      Returns:
      ScimV2Group
      Throws:
      IOException - if the request fails to be processed

    • getScimV2Group

      public ScimV2Group getScimV2Group(GetScimV2GroupRequest request) throws IOException, ApiException
      Get a group
      Parameters:
      request - The request object
      Returns:
      ScimV2Group
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getScimV2Group

      public ApiResponse<ScimV2Group> getScimV2Group(ApiRequest<Void> request) throws IOException
      Get a group
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getScimV2Groups

      public ScimGroupListResponse getScimV2Groups(String filter, Integer startIndex, Integer count, List<String> attributes, List<String> excludedAttributes) throws IOException, ApiException
      Get a list of groups
      Parameters:
      filter - Filters results. If nothing is specified, returns all groups. Examples of valid values: \"id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\", \"displayname eq Sales\". (required)
      startIndex - The 1-based index of the first query result. (optional, default to 1)
      count - The requested number of items per page. A value of 0 returns \"totalResults\". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \"excludedAttributes\" or \"attributes\" query parameters to exclude or only include secondary lookup values such as \"externalId\", \"roles\", \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\", or \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\". (optional, default to 25)
      attributes - Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes. (optional)
      excludedAttributes - Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns \"id\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. (optional)
      Returns:
      ScimGroupListResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getScimV2GroupsWithHttpInfo

      public ApiResponse<ScimGroupListResponse> getScimV2GroupsWithHttpInfo(String filter, Integer startIndex, Integer count, List<String> attributes, List<String> excludedAttributes) throws IOException
      Get a list of groups
      Parameters:
      filter - Filters results. If nothing is specified, returns all groups. Examples of valid values: \"id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3\", \"displayname eq Sales\". (required)
      startIndex - The 1-based index of the first query result. (optional, default to 1)
      count - The requested number of items per page. A value of 0 returns \"totalResults\". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \"excludedAttributes\" or \"attributes\" query parameters to exclude or only include secondary lookup values such as \"externalId\", \"roles\", \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\", or \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\". (optional, default to 25)
      attributes - Indicates which attributes to include. Returns these attributes and the \"id\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes. (optional)
      excludedAttributes - Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns \"id\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. (optional)
      Returns:
      ScimGroupListResponse
      Throws:
      IOException - if the request fails to be processed

    • getScimV2Groups

      public ScimGroupListResponse getScimV2Groups(GetScimV2GroupsRequest request) throws IOException, ApiException
      Get a list of groups
      Parameters:
      request - The request object
      Returns:
      ScimGroupListResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getScimV2Groups

      public ApiResponse<ScimGroupListResponse> getScimV2Groups(ApiRequest<Void> request) throws IOException
      Get a list of groups
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getScimV2Resourcetype

      public ScimConfigResourceType getScimV2Resourcetype(String resourceType) throws IOException, ApiException
      Get a resource type
      Parameters:
      resourceType - The type of resource. Returned with GET /api/v2/scim/v2/resourcetypes. (required)
      Returns:
      ScimConfigResourceType
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getScimV2ResourcetypeWithHttpInfo

      public ApiResponse<ScimConfigResourceType> getScimV2ResourcetypeWithHttpInfo(String resourceType) throws IOException
      Get a resource type
      Parameters:
      resourceType - The type of resource. Returned with GET /api/v2/scim/v2/resourcetypes. (required)
      Returns:
      ScimConfigResourceType
      Throws:
      IOException - if the request fails to be processed

    • getScimV2Resourcetype

      public ScimConfigResourceType getScimV2Resourcetype(GetScimV2ResourcetypeRequest request) throws IOException, ApiException
      Get a resource type
      Parameters:
      request - The request object
      Returns:
      ScimConfigResourceType
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getScimV2Resourcetype

      public ApiResponse<ScimConfigResourceType> getScimV2Resourcetype(ApiRequest<Void> request) throws IOException
      Get a resource type
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getScimV2Resourcetypes

      public ScimConfigResourceTypesListResponse getScimV2Resourcetypes() throws IOException, ApiException
      Get a list of resource types
      Returns:
      ScimConfigResourceTypesListResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getScimV2ResourcetypesWithHttpInfo

      public ApiResponse<ScimConfigResourceTypesListResponse> getScimV2ResourcetypesWithHttpInfo() throws IOException
      Get a list of resource types
      Returns:
      ScimConfigResourceTypesListResponse
      Throws:
      IOException - if the request fails to be processed

    • getScimV2Resourcetypes

      public ScimConfigResourceTypesListResponse getScimV2Resourcetypes(GetScimV2ResourcetypesRequest request) throws IOException, ApiException
      Get a list of resource types
      Parameters:
      request - The request object
      Returns:
      ScimConfigResourceTypesListResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getScimV2Resourcetypes

      public ApiResponse<ScimConfigResourceTypesListResponse> getScimV2Resourcetypes(ApiRequest<Void> request) throws IOException
      Get a list of resource types
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getScimV2Schema

      public ScimV2SchemaDefinition getScimV2Schema(String schemaId) throws IOException, ApiException
      Get a SCIM schema
      Parameters:
      schemaId - The ID of a schema. Returned with GET /api/v2/scim/v2/schemas. (required)
      Returns:
      ScimV2SchemaDefinition
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getScimV2SchemaWithHttpInfo

      public ApiResponse<ScimV2SchemaDefinition> getScimV2SchemaWithHttpInfo(String schemaId) throws IOException
      Get a SCIM schema
      Parameters:
      schemaId - The ID of a schema. Returned with GET /api/v2/scim/v2/schemas. (required)
      Returns:
      ScimV2SchemaDefinition
      Throws:
      IOException - if the request fails to be processed

    • getScimV2Schema

      public ScimV2SchemaDefinition getScimV2Schema(GetScimV2SchemaRequest request) throws IOException, ApiException
      Get a SCIM schema
      Parameters:
      request - The request object
      Returns:
      ScimV2SchemaDefinition
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getScimV2Schema

      public ApiResponse<ScimV2SchemaDefinition> getScimV2Schema(ApiRequest<Void> request) throws IOException
      Get a SCIM schema
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getScimV2Schemas

      public ScimV2SchemaListResponse getScimV2Schemas(String filter) throws IOException, ApiException
      Get a list of SCIM schemas
      Parameters:
      filter - Filtered results are invalid and return 403 Unauthorized. (optional, default to null)
      Returns:
      ScimV2SchemaListResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getScimV2SchemasWithHttpInfo

      public ApiResponse<ScimV2SchemaListResponse> getScimV2SchemasWithHttpInfo(String filter) throws IOException
      Get a list of SCIM schemas
      Parameters:
      filter - Filtered results are invalid and return 403 Unauthorized. (optional, default to null)
      Returns:
      ScimV2SchemaListResponse
      Throws:
      IOException - if the request fails to be processed

    • getScimV2Schemas

      public ScimV2SchemaListResponse getScimV2Schemas(GetScimV2SchemasRequest request) throws IOException, ApiException
      Get a list of SCIM schemas
      Parameters:
      request - The request object
      Returns:
      ScimV2SchemaListResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getScimV2Schemas

      public ApiResponse<ScimV2SchemaListResponse> getScimV2Schemas(ApiRequest<Void> request) throws IOException
      Get a list of SCIM schemas
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getScimV2Serviceproviderconfig

      public ScimServiceProviderConfig getScimV2Serviceproviderconfig(String ifNoneMatch) throws IOException, ApiException
      Get a service provider's configuration
      Parameters:
      ifNoneMatch - The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/serviceproviderconfig. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified. (optional)
      Returns:
      ScimServiceProviderConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getScimV2ServiceproviderconfigWithHttpInfo

      public ApiResponse<ScimServiceProviderConfig> getScimV2ServiceproviderconfigWithHttpInfo(String ifNoneMatch) throws IOException
      Get a service provider's configuration
      Parameters:
      ifNoneMatch - The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/serviceproviderconfig. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified. (optional)
      Returns:
      ScimServiceProviderConfig
      Throws:
      IOException - if the request fails to be processed

    • getScimV2Serviceproviderconfig

      public ScimServiceProviderConfig getScimV2Serviceproviderconfig(GetScimV2ServiceproviderconfigRequest request) throws IOException, ApiException
      Get a service provider's configuration
      Parameters:
      request - The request object
      Returns:
      ScimServiceProviderConfig
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getScimV2Serviceproviderconfig

      public ApiResponse<ScimServiceProviderConfig> getScimV2Serviceproviderconfig(ApiRequest<Void> request) throws IOException
      Get a service provider's configuration
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getScimV2User

      public ScimV2User getScimV2User(String userId, List<String> attributes, List<String> excludedAttributes, String ifNoneMatch) throws IOException, ApiException
      Get a user
      Parameters:
      userId - The ID of a user. Returned with GET /api/v2/scim/v2/users. (required)
      attributes - Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes. (optional)
      excludedAttributes - Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. (optional)
      ifNoneMatch - The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified. (optional)
      Returns:
      ScimV2User
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getScimV2UserWithHttpInfo

      public ApiResponse<ScimV2User> getScimV2UserWithHttpInfo(String userId, List<String> attributes, List<String> excludedAttributes, String ifNoneMatch) throws IOException
      Get a user
      Parameters:
      userId - The ID of a user. Returned with GET /api/v2/scim/v2/users. (required)
      attributes - Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes. (optional)
      excludedAttributes - Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. (optional)
      ifNoneMatch - The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns the current configuration of the resource. If the ETag is current, returns 304 Not Modified. (optional)
      Returns:
      ScimV2User
      Throws:
      IOException - if the request fails to be processed

    • getScimV2User

      public ScimV2User getScimV2User(GetScimV2UserRequest request) throws IOException, ApiException
      Get a user
      Parameters:
      request - The request object
      Returns:
      ScimV2User
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getScimV2User

      public ApiResponse<ScimV2User> getScimV2User(ApiRequest<Void> request) throws IOException
      Get a user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • getScimV2Users

      public ScimUserListResponse getScimV2Users(Integer startIndex, Integer count, List<String> attributes, List<String> excludedAttributes, String filter) throws IOException, ApiException
      Get a list of users To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to \"active eq false\". By default, returns SCIM attributes \"externalId\", \"enterprise-user:manager\", and \"roles\". To exclude these attributes, set the attributes parameter to \"id,active\" or the excludeAttributes parameter to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".
      Parameters:
      startIndex - The 1-based index of the first query result. (optional, default to 1)
      count - The requested number of items per page. A value of 0 returns \"totalResults\". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \"excludedAttributes\" or \"attributes\" query parameters to exclude or only include secondary lookup values such as \"externalId\", \"roles\", \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\", or \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\". (optional, default to 25)
      attributes - Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes. (optional)
      excludedAttributes - Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. (optional)
      filter - Filters results. If nothing is specified, returns all active users. Examples of valid values: \"id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\", \"userName eq search@sample.org\", \"manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\", \"email eq search@sample.org\", \"division eq divisionName\", \"externalId eq 167844\", \"active eq false\", \"employeeNumber eq 9876543210\". (optional)
      Returns:
      ScimUserListResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getScimV2UsersWithHttpInfo

      public ApiResponse<ScimUserListResponse> getScimV2UsersWithHttpInfo(Integer startIndex, Integer count, List<String> attributes, List<String> excludedAttributes, String filter) throws IOException
      Get a list of users To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to \"active eq false\". By default, returns SCIM attributes \"externalId\", \"enterprise-user:manager\", and \"roles\". To exclude these attributes, set the attributes parameter to \"id,active\" or the excludeAttributes parameter to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".
      Parameters:
      startIndex - The 1-based index of the first query result. (optional, default to 1)
      count - The requested number of items per page. A value of 0 returns \"totalResults\". A page size over 25 may exceed internal resource limits and return a 429 error. For a page size over 25, use the \"excludedAttributes\" or \"attributes\" query parameters to exclude or only include secondary lookup values such as \"externalId\", \"roles\", \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages\", or \"urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills\". (optional, default to 25)
      attributes - Indicates which attributes to include. Returns these attributes and the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"attributes\" to avoid expensive secondary calls for the default attributes. (optional)
      excludedAttributes - Indicates which attributes to exclude. Returns the default attributes minus \"excludedAttributes\". Always returns the \"id\", \"userName\", \"active\", and \"meta\" attributes. Use \"excludedAttributes\" to avoid expensive secondary calls for the default attributes. (optional)
      filter - Filters results. If nothing is specified, returns all active users. Examples of valid values: \"id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9\", \"userName eq search@sample.org\", \"manager eq 16e10e2f-1136-43fe-bb84-eac073168a49\", \"email eq search@sample.org\", \"division eq divisionName\", \"externalId eq 167844\", \"active eq false\", \"employeeNumber eq 9876543210\". (optional)
      Returns:
      ScimUserListResponse
      Throws:
      IOException - if the request fails to be processed

    • getScimV2Users

      public ScimUserListResponse getScimV2Users(GetScimV2UsersRequest request) throws IOException, ApiException
      Get a list of users To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to \"active eq false\". By default, returns SCIM attributes \"externalId\", \"enterprise-user:manager\", and \"roles\". To exclude these attributes, set the attributes parameter to \"id,active\" or the excludeAttributes parameter to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".
      Parameters:
      request - The request object
      Returns:
      ScimUserListResponse
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • getScimV2Users

      public ApiResponse<ScimUserListResponse> getScimV2Users(ApiRequest<Void> request) throws IOException
      Get a list of users To return all active users, do not use the filter parameter. To return inactive users, set the filter parameter to \"active eq false\". By default, returns SCIM attributes \"externalId\", \"enterprise-user:manager\", and \"roles\". To exclude these attributes, set the attributes parameter to \"id,active\" or the excludeAttributes parameter to \"externalId,roles,urn:ietf:params:scim:schemas:extension:enterprise:2.0:User:division\".
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchScimGroup

      public ScimV2Group patchScimGroup(String groupId, ScimV2PatchRequest body, String ifMatch) throws IOException, ApiException
      Modify a group
      Parameters:
      groupId - The ID of a group. Returned with GET /api/v2/scim/groups. (required)
      body - The information used to modify a group. (required)
      ifMatch - The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". (optional)
      Returns:
      ScimV2Group
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchScimGroupWithHttpInfo

      public ApiResponse<ScimV2Group> patchScimGroupWithHttpInfo(String groupId, ScimV2PatchRequest body, String ifMatch) throws IOException
      Modify a group
      Parameters:
      groupId - The ID of a group. Returned with GET /api/v2/scim/groups. (required)
      body - The information used to modify a group. (required)
      ifMatch - The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". (optional)
      Returns:
      ScimV2Group
      Throws:
      IOException - if the request fails to be processed

    • patchScimGroup

      public ScimV2Group patchScimGroup(PatchScimGroupRequest request) throws IOException, ApiException
      Modify a group
      Parameters:
      request - The request object
      Returns:
      ScimV2Group
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchScimGroup

      public ApiResponse<ScimV2Group> patchScimGroup(ApiRequest<ScimV2PatchRequest> request) throws IOException
      Modify a group
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchScimUser

      public ScimV2User patchScimUser(String userId, ScimV2PatchRequest body, String ifMatch) throws IOException, ApiException
      Modify a user
      Parameters:
      userId - The ID of a user. Returned with GET /api/v2/scim/users. (required)
      body - The information used to modify a user. (required)
      ifMatch - The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". (optional)
      Returns:
      ScimV2User
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchScimUserWithHttpInfo

      public ApiResponse<ScimV2User> patchScimUserWithHttpInfo(String userId, ScimV2PatchRequest body, String ifMatch) throws IOException
      Modify a user
      Parameters:
      userId - The ID of a user. Returned with GET /api/v2/scim/users. (required)
      body - The information used to modify a user. (required)
      ifMatch - The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". (optional)
      Returns:
      ScimV2User
      Throws:
      IOException - if the request fails to be processed

    • patchScimUser

      public ScimV2User patchScimUser(PatchScimUserRequest request) throws IOException, ApiException
      Modify a user
      Parameters:
      request - The request object
      Returns:
      ScimV2User
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchScimUser

      public ApiResponse<ScimV2User> patchScimUser(ApiRequest<ScimV2PatchRequest> request) throws IOException
      Modify a user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchScimV2Group

      public ScimV2Group patchScimV2Group(String groupId, ScimV2PatchRequest body, String ifMatch) throws IOException, ApiException
      Modify a group
      Parameters:
      groupId - The ID of a group. Returned with GET /api/v2/scim/v2/groups. (required)
      body - The information used to modify a group. (required)
      ifMatch - The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". (optional)
      Returns:
      ScimV2Group
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchScimV2GroupWithHttpInfo

      public ApiResponse<ScimV2Group> patchScimV2GroupWithHttpInfo(String groupId, ScimV2PatchRequest body, String ifMatch) throws IOException
      Modify a group
      Parameters:
      groupId - The ID of a group. Returned with GET /api/v2/scim/v2/groups. (required)
      body - The information used to modify a group. (required)
      ifMatch - The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". (optional)
      Returns:
      ScimV2Group
      Throws:
      IOException - if the request fails to be processed

    • patchScimV2Group

      public ScimV2Group patchScimV2Group(PatchScimV2GroupRequest request) throws IOException, ApiException
      Modify a group
      Parameters:
      request - The request object
      Returns:
      ScimV2Group
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchScimV2Group

      public ApiResponse<ScimV2Group> patchScimV2Group(ApiRequest<ScimV2PatchRequest> request) throws IOException
      Modify a group
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • patchScimV2User

      public ScimV2User patchScimV2User(String userId, ScimV2PatchRequest body, String ifMatch) throws IOException, ApiException
      Modify a user
      Parameters:
      userId - The ID of a user. Returned with GET /api/v2/scim/v2/users. (required)
      body - The information used to modify a user. (required)
      ifMatch - The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". (optional)
      Returns:
      ScimV2User
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchScimV2UserWithHttpInfo

      public ApiResponse<ScimV2User> patchScimV2UserWithHttpInfo(String userId, ScimV2PatchRequest body, String ifMatch) throws IOException
      Modify a user
      Parameters:
      userId - The ID of a user. Returned with GET /api/v2/scim/v2/users. (required)
      body - The information used to modify a user. (required)
      ifMatch - The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". (optional)
      Returns:
      ScimV2User
      Throws:
      IOException - if the request fails to be processed

    • patchScimV2User

      public ScimV2User patchScimV2User(PatchScimV2UserRequest request) throws IOException, ApiException
      Modify a user
      Parameters:
      request - The request object
      Returns:
      ScimV2User
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • patchScimV2User

      public ApiResponse<ScimV2User> patchScimV2User(ApiRequest<ScimV2PatchRequest> request) throws IOException
      Modify a user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postScimUsers

      public ScimV2User postScimUsers(ScimV2CreateUser body) throws IOException, ApiException
      Create a user
      Parameters:
      body - The information used to create a user. (required)
      Returns:
      ScimV2User
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postScimUsersWithHttpInfo

      public ApiResponse<ScimV2User> postScimUsersWithHttpInfo(ScimV2CreateUser body) throws IOException
      Create a user
      Parameters:
      body - The information used to create a user. (required)
      Returns:
      ScimV2User
      Throws:
      IOException - if the request fails to be processed

    • postScimUsers

      public ScimV2User postScimUsers(PostScimUsersRequest request) throws IOException, ApiException
      Create a user
      Parameters:
      request - The request object
      Returns:
      ScimV2User
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postScimUsers

      public ApiResponse<ScimV2User> postScimUsers(ApiRequest<ScimV2CreateUser> request) throws IOException
      Create a user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • postScimV2Users

      public ScimV2User postScimV2Users(ScimV2CreateUser body) throws IOException, ApiException
      Create a user
      Parameters:
      body - The information used to create a user. (required)
      Returns:
      ScimV2User
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postScimV2UsersWithHttpInfo

      public ApiResponse<ScimV2User> postScimV2UsersWithHttpInfo(ScimV2CreateUser body) throws IOException
      Create a user
      Parameters:
      body - The information used to create a user. (required)
      Returns:
      ScimV2User
      Throws:
      IOException - if the request fails to be processed

    • postScimV2Users

      public ScimV2User postScimV2Users(PostScimV2UsersRequest request) throws IOException, ApiException
      Create a user
      Parameters:
      request - The request object
      Returns:
      ScimV2User
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • postScimV2Users

      public ApiResponse<ScimV2User> postScimV2Users(ApiRequest<ScimV2CreateUser> request) throws IOException
      Create a user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putScimGroup

      public ScimV2Group putScimGroup(String groupId, ScimV2Group body, String ifMatch) throws IOException, ApiException
      Replace a group
      Parameters:
      groupId - The ID of a group. Returned with GET /api/v2/scim/groups. (required)
      body - The information used to replace a group. (required)
      ifMatch - The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". (optional)
      Returns:
      ScimV2Group
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putScimGroupWithHttpInfo

      public ApiResponse<ScimV2Group> putScimGroupWithHttpInfo(String groupId, ScimV2Group body, String ifMatch) throws IOException
      Replace a group
      Parameters:
      groupId - The ID of a group. Returned with GET /api/v2/scim/groups. (required)
      body - The information used to replace a group. (required)
      ifMatch - The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". (optional)
      Returns:
      ScimV2Group
      Throws:
      IOException - if the request fails to be processed

    • putScimGroup

      public ScimV2Group putScimGroup(PutScimGroupRequest request) throws IOException, ApiException
      Replace a group
      Parameters:
      request - The request object
      Returns:
      ScimV2Group
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putScimGroup

      public ApiResponse<ScimV2Group> putScimGroup(ApiRequest<ScimV2Group> request) throws IOException
      Replace a group
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putScimUser

      public ScimV2User putScimUser(String userId, ScimV2User body, String ifMatch) throws IOException, ApiException
      Replace a user
      Parameters:
      userId - The ID of a user. Returned with GET /api/v2/scim/users. (required)
      body - The information used to replace a user. (required)
      ifMatch - The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". (optional)
      Returns:
      ScimV2User
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putScimUserWithHttpInfo

      public ApiResponse<ScimV2User> putScimUserWithHttpInfo(String userId, ScimV2User body, String ifMatch) throws IOException
      Replace a user
      Parameters:
      userId - The ID of a user. Returned with GET /api/v2/scim/users. (required)
      body - The information used to replace a user. (required)
      ifMatch - The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". (optional)
      Returns:
      ScimV2User
      Throws:
      IOException - if the request fails to be processed

    • putScimUser

      public ScimV2User putScimUser(PutScimUserRequest request) throws IOException, ApiException
      Replace a user
      Parameters:
      request - The request object
      Returns:
      ScimV2User
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putScimUser

      public ApiResponse<ScimV2User> putScimUser(ApiRequest<ScimV2User> request) throws IOException
      Replace a user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putScimV2Group

      public ScimV2Group putScimV2Group(String groupId, ScimV2Group body, String ifMatch) throws IOException, ApiException
      Replace a group
      Parameters:
      groupId - The ID of a group. Returned with GET /api/v2/scim/v2/groups. (required)
      body - The information used to replace a group. (required)
      ifMatch - The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". (optional)
      Returns:
      ScimV2Group
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putScimV2GroupWithHttpInfo

      public ApiResponse<ScimV2Group> putScimV2GroupWithHttpInfo(String groupId, ScimV2Group body, String ifMatch) throws IOException
      Replace a group
      Parameters:
      groupId - The ID of a group. Returned with GET /api/v2/scim/v2/groups. (required)
      body - The information used to replace a group. (required)
      ifMatch - The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/groups/{groupId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". (optional)
      Returns:
      ScimV2Group
      Throws:
      IOException - if the request fails to be processed

    • putScimV2Group

      public ScimV2Group putScimV2Group(PutScimV2GroupRequest request) throws IOException, ApiException
      Replace a group
      Parameters:
      request - The request object
      Returns:
      ScimV2Group
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putScimV2Group

      public ApiResponse<ScimV2Group> putScimV2Group(ApiRequest<ScimV2Group> request) throws IOException
      Replace a group
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed

    • putScimV2User

      public ScimV2User putScimV2User(String userId, ScimV2User body, String ifMatch) throws IOException, ApiException
      Replace a user
      Parameters:
      userId - The ID of a user. Returned with GET /api/v2/scim/v2/users. (required)
      body - The information used to replace a user. (required)
      ifMatch - The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". (optional)
      Returns:
      ScimV2User
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putScimV2UserWithHttpInfo

      public ApiResponse<ScimV2User> putScimV2UserWithHttpInfo(String userId, ScimV2User body, String ifMatch) throws IOException
      Replace a user
      Parameters:
      userId - The ID of a user. Returned with GET /api/v2/scim/v2/users. (required)
      body - The information used to replace a user. (required)
      ifMatch - The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/v2/users/{userId}. Example: \"42\". If the ETag is different from the version on the server, returns 400 with a \"scimType\" of \"invalidVers\". (optional)
      Returns:
      ScimV2User
      Throws:
      IOException - if the request fails to be processed

    • putScimV2User

      public ScimV2User putScimV2User(PutScimV2UserRequest request) throws IOException, ApiException
      Replace a user
      Parameters:
      request - The request object
      Returns:
      ScimV2User
      Throws:
      ApiException - if the request fails on the server
      IOException - if the request fails to be processed

    • putScimV2User

      public ApiResponse<ScimV2User> putScimV2User(ApiRequest<ScimV2User> request) throws IOException
      Replace a user
      Parameters:
      request - The request object
      Returns:
      the response
      Throws:
      IOException - if the request fails to be processed