RubyDoc.info: Class: PureCloud::SCIMApi – Documentation for purecloudplatformclientv2 (95.0.0)

#delete_scim_group(group_id, opts = {}) ⇒ `nil`

Delete a group

Parameters:

group_id —

The ID of a group. Returned with GET /api/v2/scim/groups or GET /api/v2/scim/v2/groups.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:if_match (String) —

The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/groupId or 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".

Returns:

(nil)

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 33

def delete_scim_group(group_id, opts = {})
  delete_scim_group_with_http_info(group_id, opts)
  return nil
end

#delete_scim_group_with_http_info(group_id, opts = {}) ⇒ `Array<(nil, Fixnum, Hash)>`

Delete a group

Parameters:

group_id —

The ID of a group. Returned with GET /api/v2/scim/groups or GET /api/v2/scim/v2/groups.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:if_match (String) —

The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/groupId or 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".

Returns:

(Array<(nil, Fixnum, Hash)>) —

nil, response status code and response headers

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 44

def delete_scim_group_with_http_info(group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SCIMApi.delete_scim_group ..."
  end
  
  
  # verify the required parameter 'group_id' is set
  fail ArgumentError, "Missing the required parameter 'group_id' when calling SCIMApi.delete_scim_group" if group_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/scim/groups/{groupId}".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json', 'application/scim+json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'application/scim+json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
  header_params[:'If-Match'] = opts[:'if_match'] if opts[:'if_match']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SCIMApi#delete_scim_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_scim_user(user_id, opts = {}) ⇒ `Empty`

Delete a user

Parameters:

user_id —

The ID of a user. Returned with GET /api/v2/scim/users.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:if_match (String) —

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".

Returns:

(Empty)

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 106

def delete_scim_user(user_id, opts = {})
  data, _status_code, _headers = delete_scim_user_with_http_info(user_id, opts)
  return data
end

#delete_scim_user_with_http_info(user_id, opts = {}) ⇒ `Array<(Empty, Fixnum, Hash)>`

Delete a user

Parameters:

user_id —

The ID of a user. Returned with GET /api/v2/scim/users.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:if_match (String) —

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".

Returns:

(Array<(Empty, Fixnum, Hash)>) —

Empty data, response status code and response headers

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 117

def delete_scim_user_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SCIMApi.delete_scim_user ..."
  end
  
  
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling SCIMApi.delete_scim_user" if user_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/scim/users/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json', 'application/scim+json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'application/scim+json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
  header_params[:'If-Match'] = opts[:'if_match'] if opts[:'if_match']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Empty')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SCIMApi#delete_scim_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_scim_v2_group(group_id, opts = {}) ⇒ `nil`

Delete a group

Parameters:

group_id —

The ID of a group. Returned with GET /api/v2/scim/groups or GET /api/v2/scim/v2/groups.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:if_match (String) —

The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/groupId or 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".

Returns:

(nil)

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 180

def delete_scim_v2_group(group_id, opts = {})
  delete_scim_v2_group_with_http_info(group_id, opts)
  return nil
end

#delete_scim_v2_group_with_http_info(group_id, opts = {}) ⇒ `Array<(nil, Fixnum, Hash)>`

Delete a group

Parameters:

group_id —

The ID of a group. Returned with GET /api/v2/scim/groups or GET /api/v2/scim/v2/groups.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:if_match (String) —

The ETag of a resource in double quotes. Returned as header and meta.version with initial call to GET /api/v2/scim/groups/groupId or 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".

Returns:

(Array<(nil, Fixnum, Hash)>) —

nil, response status code and response headers

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 191

def delete_scim_v2_group_with_http_info(group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SCIMApi.delete_scim_v2_group ..."
  end
  
  
  # verify the required parameter 'group_id' is set
  fail ArgumentError, "Missing the required parameter 'group_id' when calling SCIMApi.delete_scim_v2_group" if group_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/scim/v2/groups/{groupId}".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json', 'application/scim+json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'application/scim+json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
  header_params[:'If-Match'] = opts[:'if_match'] if opts[:'if_match']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SCIMApi#delete_scim_v2_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_scim_v2_user(user_id, opts = {}) ⇒ `Empty`

Delete a user

Parameters:

user_id —

The ID of a user. Returned with GET /api/v2/scim/v2/users.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:if_match (String) —

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".

Returns:

(Empty)

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 253

def delete_scim_v2_user(user_id, opts = {})
  data, _status_code, _headers = delete_scim_v2_user_with_http_info(user_id, opts)
  return data
end

#delete_scim_v2_user_with_http_info(user_id, opts = {}) ⇒ `Array<(Empty, Fixnum, Hash)>`

Delete a user

Parameters:

user_id —

The ID of a user. Returned with GET /api/v2/scim/v2/users.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:if_match (String) —

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".

Returns:

(Array<(Empty, Fixnum, Hash)>) —

Empty data, response status code and response headers

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 264

def delete_scim_v2_user_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SCIMApi.delete_scim_v2_user ..."
  end
  
  
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling SCIMApi.delete_scim_v2_user" if user_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/scim/v2/users/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json', 'application/scim+json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'application/scim+json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
  header_params[:'If-Match'] = opts[:'if_match'] if opts[:'if_match']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'Empty')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SCIMApi#delete_scim_v2_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_scim_group(group_id, opts = {}) ⇒ `ScimV2Group`

Get a group

Parameters:

group_id —

The ID of a group. Returned with GET /api/v2/scim/groups.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:attributes (Array<String>) —

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.
:excluded_attributes (Array<String>) —

Indicates which attributes to exclude. Returns the default attributes minus "excludedAttributes". Use "excludedAttributes" to avoid expensive secondary calls for the default attributes. The'id', 'active', and 'meta' attributes will always be present in the output.
:if_none_match (String) —

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.

Returns:

(ScimV2Group)

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 329

def get_scim_group(group_id, opts = {})
  data, _status_code, _headers = get_scim_group_with_http_info(group_id, opts)
  return data
end

#get_scim_group_with_http_info(group_id, opts = {}) ⇒ `Array<(ScimV2Group, Fixnum, Hash)>`

Get a group

Parameters:

group_id —

The ID of a group. Returned with GET /api/v2/scim/groups.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:attributes (Array<String>) —

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.
:excluded_attributes (Array<String>) —

Indicates which attributes to exclude. Returns the default attributes minus "excludedAttributes". Use "excludedAttributes" to avoid expensive secondary calls for the default attributes. The'id', 'active', and 'meta' attributes will always be present in the output.
:if_none_match (String) —

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.

Returns:

(Array<(ScimV2Group, Fixnum, Hash)>) —

ScimV2Group data, response status code and response headers

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 342

def get_scim_group_with_http_info(group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SCIMApi.get_scim_group ..."
  end
  
  
  # verify the required parameter 'group_id' is set
  fail ArgumentError, "Missing the required parameter 'group_id' when calling SCIMApi.get_scim_group" if group_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/scim/groups/{groupId}".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'attributes'] = @api_client.build_collection_param(opts[:'attributes'], :multi) if opts[:'attributes']
  query_params[:'excludedAttributes'] = @api_client.build_collection_param(opts[:'excluded_attributes'], :multi) if opts[:'excluded_attributes']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json', 'application/scim+json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'application/scim+json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if opts[:'if_none_match']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScimV2Group')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SCIMApi#get_scim_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_scim_groups(opts = {}) ⇒ `ScimGroupListResponse`

Get a list of groups

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:start_index (Integer) —

The 1-based index of the first query result. (default to 1)
:count (Integer) —

The requested number of items per page. A value of 0 returns "totalResults". Note that a page size over 25 will likely cause a 429 error by exceeding internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values – (i.e. externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills) (default to 25)
:attributes (Array<String>) —

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.
:excluded_attributes (Array<String>) —

Indicates which attributes to exclude. Returns the default attributes minus "excludedAttributes". Use "excludedAttributes" to avoid expensive secondary calls for the default attributes. The'id', 'active', and 'meta' attributes will always be present in the output.
:filter (String) —

Filters results. If nothing is specified, returns all groups. Examples of valid values: "id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3", "displayname eq Sales".

Returns:

(ScimGroupListResponse)

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 422

def get_scim_groups(opts = {})
  data, _status_code, _headers = get_scim_groups_with_http_info(opts)
  return data
end

#get_scim_groups_with_http_info(opts = {}) ⇒ `Array<(ScimGroupListResponse, Fixnum, Hash)>`

Get a list of groups

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:start_index (Integer) —

The 1-based index of the first query result.
:count (Integer) —

The requested number of items per page. A value of 0 returns "totalResults". Note that a page size over 25 will likely cause a 429 error by exceeding internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values – (i.e. externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills)
:attributes (Array<String>) —

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.
:excluded_attributes (Array<String>) —

Indicates which attributes to exclude. Returns the default attributes minus "excludedAttributes". Use "excludedAttributes" to avoid expensive secondary calls for the default attributes. The'id', 'active', and 'meta' attributes will always be present in the output.
:filter (String) —

Filters results. If nothing is specified, returns all groups. Examples of valid values: "id eq 5f4bc742-a019-4e38-8e2a-d39d5bc0b0f3", "displayname eq Sales".

Returns:

(Array<(ScimGroupListResponse, Fixnum, Hash)>) —

ScimGroupListResponse data, response status code and response headers

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 436

def get_scim_groups_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SCIMApi.get_scim_groups ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/scim/groups".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'startIndex'] = opts[:'start_index'] if opts[:'start_index']
  query_params[:'count'] = opts[:'count'] if opts[:'count']
  query_params[:'attributes'] = @api_client.build_collection_param(opts[:'attributes'], :multi) if opts[:'attributes']
  query_params[:'excludedAttributes'] = @api_client.build_collection_param(opts[:'excluded_attributes'], :multi) if opts[:'excluded_attributes']
  query_params[:'filter'] = opts[:'filter'] if opts[:'filter']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json', 'application/scim+json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'application/scim+json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScimGroupListResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SCIMApi#get_scim_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_scim_resourcetype(resource_type, opts = {}) ⇒ `ScimConfigResourceType`

Get a resource type

Parameters:

resource_type —

The type of resource. Returned with GET /api/v2/scim/resourcetypes.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(ScimConfigResourceType)

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 518

def get_scim_resourcetype(resource_type, opts = {})
  data, _status_code, _headers = get_scim_resourcetype_with_http_info(resource_type, opts)
  return data
end

#get_scim_resourcetype_with_http_info(resource_type, opts = {}) ⇒ `Array<(ScimConfigResourceType, Fixnum, Hash)>`

Get a resource type

Parameters:

resource_type —

The type of resource. Returned with GET /api/v2/scim/resourcetypes.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(ScimConfigResourceType, Fixnum, Hash)>) —

ScimConfigResourceType data, response status code and response headers

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 528

def get_scim_resourcetype_with_http_info(resource_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SCIMApi.get_scim_resourcetype ..."
  end
  
  
  # verify the required parameter 'resource_type' is set
  fail ArgumentError, "Missing the required parameter 'resource_type' when calling SCIMApi.get_scim_resourcetype" if resource_type.nil?
  
  # verify enum value
  unless ['User', 'Group', 'ServiceProviderConfig', 'ResourceType', 'Schema'].include?(resource_type)
    fail ArgumentError, "invalid value for 'resource_type', must be one of User, Group, ServiceProviderConfig, ResourceType, Schema"
  end
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/scim/resourcetypes/{resourceType}".sub('{format}','json').sub('{' + 'resourceType' + '}', resource_type.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json', 'application/scim+json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'application/scim+json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScimConfigResourceType')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SCIMApi#get_scim_resourcetype\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_scim_resourcetypes(opts = {}) ⇒ `ScimConfigResourceTypesListResponse`

Get a list of resource types

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(ScimConfigResourceTypesListResponse)

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 587

def get_scim_resourcetypes(opts = {})
  data, _status_code, _headers = get_scim_resourcetypes_with_http_info(opts)
  return data
end

#get_scim_resourcetypes_with_http_info(opts = {}) ⇒ `Array<(ScimConfigResourceTypesListResponse, Fixnum, Hash)>`

Get a list of resource types

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(ScimConfigResourceTypesListResponse, Fixnum, Hash)>) —

ScimConfigResourceTypesListResponse data, response status code and response headers

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 596

def get_scim_resourcetypes_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SCIMApi.get_scim_resourcetypes ..."
  end
  
  # resource path
  local_var_path = "/api/v2/scim/resourcetypes".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json', 'application/scim+json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'application/scim+json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScimConfigResourceTypesListResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SCIMApi#get_scim_resourcetypes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_scim_schema(schema_id, opts = {}) ⇒ `ScimV2SchemaDefinition`

Get a SCIM schema

Parameters:

schema_id —

The ID of a schema. Returned with GET /api/v2/scim/schemas.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(ScimV2SchemaDefinition)

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 643

def get_scim_schema(schema_id, opts = {})
  data, _status_code, _headers = get_scim_schema_with_http_info(schema_id, opts)
  return data
end

#get_scim_schema_with_http_info(schema_id, opts = {}) ⇒ `Array<(ScimV2SchemaDefinition, Fixnum, Hash)>`

Get a SCIM schema

Parameters:

schema_id —

The ID of a schema. Returned with GET /api/v2/scim/schemas.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(ScimV2SchemaDefinition, Fixnum, Hash)>) —

ScimV2SchemaDefinition data, response status code and response headers

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 653

def get_scim_schema_with_http_info(schema_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SCIMApi.get_scim_schema ..."
  end
  
  
  # verify the required parameter 'schema_id' is set
  fail ArgumentError, "Missing the required parameter 'schema_id' when calling SCIMApi.get_scim_schema" if schema_id.nil?
  
  # verify enum value
  unless ['urn:ietf:params:scim:schemas:core:2.0:User', 'urn:ietf:params:scim:schemas:core:2.0:Group', 'urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig', 'urn:ietf:params:scim:schemas:core:2.0:ResourceType', 'urn:ietf:params:scim:schemas:core:2.0:Schema', 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User', 'urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User'].include?(schema_id)
    fail ArgumentError, "invalid value for 'schema_id', must be one of urn:ietf:params:scim:schemas:core:2.0:User, urn:ietf:params:scim:schemas:core:2.0:Group, urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig, urn:ietf:params:scim:schemas:core:2.0:ResourceType, urn:ietf:params:scim:schemas:core:2.0:Schema, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"
  end
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/scim/schemas/{schemaId}".sub('{format}','json').sub('{' + 'schemaId' + '}', schema_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json', 'application/scim+json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'application/scim+json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScimV2SchemaDefinition')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SCIMApi#get_scim_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_scim_schemas(opts = {}) ⇒ `ScimV2SchemaListResponse`

Get a list of SCIM schemas

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:filter (String) —

Filtered results are invalid and return 403 Unauthorized.

Returns:

(ScimV2SchemaListResponse)

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 713

def get_scim_schemas(opts = {})
  data, _status_code, _headers = get_scim_schemas_with_http_info(opts)
  return data
end

#get_scim_schemas_with_http_info(opts = {}) ⇒ `Array<(ScimV2SchemaListResponse, Fixnum, Hash)>`

Get a list of SCIM schemas

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:filter (String) —

Filtered results are invalid and return 403 Unauthorized.

Returns:

(Array<(ScimV2SchemaListResponse, Fixnum, Hash)>) —

ScimV2SchemaListResponse data, response status code and response headers

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 723

def get_scim_schemas_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SCIMApi.get_scim_schemas ..."
  end
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/scim/schemas".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'filter'] = opts[:'filter'] if opts[:'filter']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json', 'application/scim+json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'application/scim+json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScimV2SchemaListResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SCIMApi#get_scim_schemas\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_scim_serviceproviderconfig(opts = {}) ⇒ `ScimServiceProviderConfig`

Get a service provider’s configuration

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:if_none_match (String) —

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.

Returns:

(ScimServiceProviderConfig)

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 777

def get_scim_serviceproviderconfig(opts = {})
  data, _status_code, _headers = get_scim_serviceproviderconfig_with_http_info(opts)
  return data
end

#get_scim_serviceproviderconfig_with_http_info(opts = {}) ⇒ `Array<(ScimServiceProviderConfig, Fixnum, Hash)>`

Get a service provider's configuration

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:if_none_match (String) —

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.

Returns:

(Array<(ScimServiceProviderConfig, Fixnum, Hash)>) —

ScimServiceProviderConfig data, response status code and response headers

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 787

def get_scim_serviceproviderconfig_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SCIMApi.get_scim_serviceproviderconfig ..."
  end
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/scim/serviceproviderconfig".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json', 'application/scim+json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'application/scim+json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if opts[:'if_none_match']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScimServiceProviderConfig')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SCIMApi#get_scim_serviceproviderconfig\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_scim_user(user_id, opts = {}) ⇒ `ScimV2User`

Get a user

Parameters:

user_id —

The ID of a user. Returned with GET /api/v2/scim/users.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:attributes (Array<String>) —

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.
:excluded_attributes (Array<String>) —

Indicates which attributes to exclude. Returns the default attributes minus "excludedAttributes". Use "excludedAttributes" to avoid expensive secondary calls for the default attributes. The 'id', 'userName', 'active', 'meta' attributes will always be present in output.
:if_none_match (String) —

TThe 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.

Returns:

(ScimV2User)

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 844

def get_scim_user(user_id, opts = {})
  data, _status_code, _headers = get_scim_user_with_http_info(user_id, opts)
  return data
end

#get_scim_user_with_http_info(user_id, opts = {}) ⇒ `Array<(ScimV2User, Fixnum, Hash)>`

Get a user

Parameters:

user_id —

The ID of a user. Returned with GET /api/v2/scim/users.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:attributes (Array<String>) —

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.
:excluded_attributes (Array<String>) —

Indicates which attributes to exclude. Returns the default attributes minus "excludedAttributes". Use "excludedAttributes" to avoid expensive secondary calls for the default attributes. The 'id', 'userName', 'active', 'meta' attributes will always be present in output.
:if_none_match (String) —

TThe 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.

Returns:

(Array<(ScimV2User, Fixnum, Hash)>) —

ScimV2User data, response status code and response headers

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 857

def get_scim_user_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SCIMApi.get_scim_user ..."
  end
  
  
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling SCIMApi.get_scim_user" if user_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/scim/users/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'attributes'] = @api_client.build_collection_param(opts[:'attributes'], :multi) if opts[:'attributes']
  query_params[:'excludedAttributes'] = @api_client.build_collection_param(opts[:'excluded_attributes'], :multi) if opts[:'excluded_attributes']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json', 'application/scim+json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'application/scim+json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if opts[:'if_none_match']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScimV2User')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SCIMApi#get_scim_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_scim_users(opts = {}) ⇒ `ScimUserListResponse`

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:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:start_index (Integer) —

The 1-based index of the first query result. (default to 1)
:count (Integer) —

The requested number of items per page. A value of 0 returns "totalResults". Note that a page size over 25 will likely cause a 429 error by exceeding internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values – (i.e. externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills) (default to 25)
:attributes (Array<String>) —

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.
:excluded_attributes (Array<String>) —

Indicates which attributes to exclude. Returns the default attributes minus "excludedAttributes". Use "excludedAttributes" to avoid expensive secondary calls for the default attributes. The 'id', 'userName', 'active', 'meta' attributes will always be present in output.
:filter (String) —

Filters results. If nothing is specified, returns all active users. Examples of valid values: "id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9", "userName eq [email protected]", "manager eq 16e10e2f-1136-43fe-bb84-eac073168a49", "email eq [email protected]", "division eq divisionName", "externalId eq 167844", "active eq false", "employeeNumber eq 9876543210".

Returns:

(ScimUserListResponse)

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 937

def get_scim_users(opts = {})
  data, _status_code, _headers = get_scim_users_with_http_info(opts)
  return data
end

#get_scim_users_with_http_info(opts = {}) ⇒ `Array<(ScimUserListResponse, Fixnum, Hash)>`

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:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:start_index (Integer) —

The 1-based index of the first query result.
:count (Integer) —

The requested number of items per page. A value of 0 returns "totalResults". Note that a page size over 25 will likely cause a 429 error by exceeding internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values – (i.e. externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills)
:attributes (Array<String>) —

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.
:excluded_attributes (Array<String>) —

Indicates which attributes to exclude. Returns the default attributes minus "excludedAttributes". Use "excludedAttributes" to avoid expensive secondary calls for the default attributes. The 'id', 'userName', 'active', 'meta' attributes will always be present in output.
:filter (String) —

Filters results. If nothing is specified, returns all active users. Examples of valid values: "id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9", "userName eq [email protected]", "manager eq 16e10e2f-1136-43fe-bb84-eac073168a49", "email eq [email protected]", "division eq divisionName", "externalId eq 167844", "active eq false", "employeeNumber eq 9876543210".

Returns:

(Array<(ScimUserListResponse, Fixnum, Hash)>) —

ScimUserListResponse data, response status code and response headers

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 951

def get_scim_users_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SCIMApi.get_scim_users ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/scim/users".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'startIndex'] = opts[:'start_index'] if opts[:'start_index']
  query_params[:'count'] = opts[:'count'] if opts[:'count']
  query_params[:'attributes'] = @api_client.build_collection_param(opts[:'attributes'], :multi) if opts[:'attributes']
  query_params[:'excludedAttributes'] = @api_client.build_collection_param(opts[:'excluded_attributes'], :multi) if opts[:'excluded_attributes']
  query_params[:'filter'] = opts[:'filter'] if opts[:'filter']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json', 'application/scim+json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'application/scim+json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScimUserListResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SCIMApi#get_scim_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_scim_v2_group(group_id, opts = {}) ⇒ `ScimV2Group`

Get a group

Parameters:

group_id —

The ID of a group. Returned with GET /api/v2/scim/v2/groups.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:attributes (Array<String>) —

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.
:excluded_attributes (Array<String>) —

Indicates which attributes to exclude. Returns the default attributes minus "excludedAttributes". Use "excludedAttributes" to avoid expensive secondary calls for the default attributes. The'id', 'active', and 'meta' attributes will always be present in the output.
:if_none_match (String) —

TThe 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.

Returns:

(ScimV2Group)

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 1036

def get_scim_v2_group(group_id, opts = {})
  data, _status_code, _headers = get_scim_v2_group_with_http_info(group_id, opts)
  return data
end

#get_scim_v2_group_with_http_info(group_id, opts = {}) ⇒ `Array<(ScimV2Group, Fixnum, Hash)>`

Get a group

Parameters:

group_id —

The ID of a group. Returned with GET /api/v2/scim/v2/groups.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:attributes (Array<String>) —

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.
:excluded_attributes (Array<String>) —

Indicates which attributes to exclude. Returns the default attributes minus "excludedAttributes". Use "excludedAttributes" to avoid expensive secondary calls for the default attributes. The'id', 'active', and 'meta' attributes will always be present in the output.
:if_none_match (String) —

TThe 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.

Returns:

(Array<(ScimV2Group, Fixnum, Hash)>) —

ScimV2Group data, response status code and response headers

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 1049

def get_scim_v2_group_with_http_info(group_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SCIMApi.get_scim_v2_group ..."
  end
  
  
  # verify the required parameter 'group_id' is set
  fail ArgumentError, "Missing the required parameter 'group_id' when calling SCIMApi.get_scim_v2_group" if group_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/scim/v2/groups/{groupId}".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'attributes'] = @api_client.build_collection_param(opts[:'attributes'], :multi) if opts[:'attributes']
  query_params[:'excludedAttributes'] = @api_client.build_collection_param(opts[:'excluded_attributes'], :multi) if opts[:'excluded_attributes']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json', 'application/scim+json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'application/scim+json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if opts[:'if_none_match']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScimV2Group')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SCIMApi#get_scim_v2_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_scim_v2_groups(filter, opts = {}) ⇒ `ScimGroupListResponse`

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".
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:start_index (Integer) —

The 1-based index of the first query result. (default to 1)
:count (Integer) —

The requested number of items per page. A value of 0 returns "totalResults". Note that a page size over 25 will likely cause a 429 error by exceeding internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values – (i.e. externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills) (default to 25)
:attributes (Array<String>) —

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.
:excluded_attributes (Array<String>) —

Indicates which attributes to exclude. Returns the default attributes minus "excludedAttributes". Use "excludedAttributes" to avoid expensive secondary calls for the default attributes. The'id', 'active', and 'meta' attributes will always be present in the output.

Returns:

(ScimGroupListResponse)

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 1129

def get_scim_v2_groups(filter, opts = {})
  data, _status_code, _headers = get_scim_v2_groups_with_http_info(filter, opts)
  return data
end

#get_scim_v2_groups_with_http_info(filter, opts = {}) ⇒ `Array<(ScimGroupListResponse, Fixnum, Hash)>`

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".
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:start_index (Integer) —

The 1-based index of the first query result.
:count (Integer) —

The requested number of items per page. A value of 0 returns "totalResults". Note that a page size over 25 will likely cause a 429 error by exceeding internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values – (i.e. externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills)
:attributes (Array<String>) —

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.
:excluded_attributes (Array<String>) —

Indicates which attributes to exclude. Returns the default attributes minus "excludedAttributes". Use "excludedAttributes" to avoid expensive secondary calls for the default attributes. The'id', 'active', and 'meta' attributes will always be present in the output.

Returns:

(Array<(ScimGroupListResponse, Fixnum, Hash)>) —

ScimGroupListResponse data, response status code and response headers

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 1143

def get_scim_v2_groups_with_http_info(filter, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SCIMApi.get_scim_v2_groups ..."
  end
  
  
  # verify the required parameter 'filter' is set
  fail ArgumentError, "Missing the required parameter 'filter' when calling SCIMApi.get_scim_v2_groups" if filter.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/scim/v2/groups".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'filter'] = filter
  query_params[:'startIndex'] = opts[:'start_index'] if opts[:'start_index']
  query_params[:'count'] = opts[:'count'] if opts[:'count']
  query_params[:'attributes'] = @api_client.build_collection_param(opts[:'attributes'], :multi) if opts[:'attributes']
  query_params[:'excludedAttributes'] = @api_client.build_collection_param(opts[:'excluded_attributes'], :multi) if opts[:'excluded_attributes']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json', 'application/scim+json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'application/scim+json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScimGroupListResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SCIMApi#get_scim_v2_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_scim_v2_resourcetype(resource_type, opts = {}) ⇒ `ScimConfigResourceType`

Get a resource type

Parameters:

resource_type —

The type of resource. Returned with GET /api/v2/scim/v2/resourcetypes.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(ScimConfigResourceType)

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 1227

def get_scim_v2_resourcetype(resource_type, opts = {})
  data, _status_code, _headers = get_scim_v2_resourcetype_with_http_info(resource_type, opts)
  return data
end

#get_scim_v2_resourcetype_with_http_info(resource_type, opts = {}) ⇒ `Array<(ScimConfigResourceType, Fixnum, Hash)>`

Get a resource type

Parameters:

resource_type —

The type of resource. Returned with GET /api/v2/scim/v2/resourcetypes.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(ScimConfigResourceType, Fixnum, Hash)>) —

ScimConfigResourceType data, response status code and response headers

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 1237

def get_scim_v2_resourcetype_with_http_info(resource_type, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SCIMApi.get_scim_v2_resourcetype ..."
  end
  
  
  # verify the required parameter 'resource_type' is set
  fail ArgumentError, "Missing the required parameter 'resource_type' when calling SCIMApi.get_scim_v2_resourcetype" if resource_type.nil?
  
  # verify enum value
  unless ['User', 'Group', 'ServiceProviderConfig', 'ResourceType', 'Schema'].include?(resource_type)
    fail ArgumentError, "invalid value for 'resource_type', must be one of User, Group, ServiceProviderConfig, ResourceType, Schema"
  end
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/scim/v2/resourcetypes/{resourceType}".sub('{format}','json').sub('{' + 'resourceType' + '}', resource_type.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json', 'application/scim+json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'application/scim+json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScimConfigResourceType')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SCIMApi#get_scim_v2_resourcetype\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_scim_v2_resourcetypes(opts = {}) ⇒ `ScimConfigResourceTypesListResponse`

Get a list of resource types

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(ScimConfigResourceTypesListResponse)

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 1296

def get_scim_v2_resourcetypes(opts = {})
  data, _status_code, _headers = get_scim_v2_resourcetypes_with_http_info(opts)
  return data
end

#get_scim_v2_resourcetypes_with_http_info(opts = {}) ⇒ `Array<(ScimConfigResourceTypesListResponse, Fixnum, Hash)>`

Get a list of resource types

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(ScimConfigResourceTypesListResponse, Fixnum, Hash)>) —

ScimConfigResourceTypesListResponse data, response status code and response headers

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 1305

def get_scim_v2_resourcetypes_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SCIMApi.get_scim_v2_resourcetypes ..."
  end
  
  # resource path
  local_var_path = "/api/v2/scim/v2/resourcetypes".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json', 'application/scim+json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'application/scim+json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScimConfigResourceTypesListResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SCIMApi#get_scim_v2_resourcetypes\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_scim_v2_schema(schema_id, opts = {}) ⇒ `ScimV2SchemaDefinition`

Get a SCIM schema

Parameters:

schema_id —

The ID of a schema. Returned with GET /api/v2/scim/v2/schemas.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(ScimV2SchemaDefinition)

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 1352

def get_scim_v2_schema(schema_id, opts = {})
  data, _status_code, _headers = get_scim_v2_schema_with_http_info(schema_id, opts)
  return data
end

#get_scim_v2_schema_with_http_info(schema_id, opts = {}) ⇒ `Array<(ScimV2SchemaDefinition, Fixnum, Hash)>`

Get a SCIM schema

Parameters:

schema_id —

The ID of a schema. Returned with GET /api/v2/scim/v2/schemas.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(ScimV2SchemaDefinition, Fixnum, Hash)>) —

ScimV2SchemaDefinition data, response status code and response headers

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 1362

def get_scim_v2_schema_with_http_info(schema_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SCIMApi.get_scim_v2_schema ..."
  end
  
  
  # verify the required parameter 'schema_id' is set
  fail ArgumentError, "Missing the required parameter 'schema_id' when calling SCIMApi.get_scim_v2_schema" if schema_id.nil?
  
  # verify enum value
  unless ['urn:ietf:params:scim:schemas:core:2.0:User', 'urn:ietf:params:scim:schemas:core:2.0:Group', 'urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig', 'urn:ietf:params:scim:schemas:core:2.0:ResourceType', 'urn:ietf:params:scim:schemas:core:2.0:Schema', 'urn:ietf:params:scim:schemas:extension:enterprise:2.0:User', 'urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User'].include?(schema_id)
    fail ArgumentError, "invalid value for 'schema_id', must be one of urn:ietf:params:scim:schemas:core:2.0:User, urn:ietf:params:scim:schemas:core:2.0:Group, urn:ietf:params:scim:schemas:core:2.0:ServiceProviderConfig, urn:ietf:params:scim:schemas:core:2.0:ResourceType, urn:ietf:params:scim:schemas:core:2.0:Schema, urn:ietf:params:scim:schemas:extension:enterprise:2.0:User, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User"
  end
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/scim/v2/schemas/{schemaId}".sub('{format}','json').sub('{' + 'schemaId' + '}', schema_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json', 'application/scim+json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'application/scim+json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScimV2SchemaDefinition')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SCIMApi#get_scim_v2_schema\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_scim_v2_schemas(opts = {}) ⇒ `ScimV2SchemaListResponse`

Get a list of SCIM schemas

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:filter (String) —

Filtered results are invalid and return 403 Unauthorized.

Returns:

(ScimV2SchemaListResponse)

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 1422

def get_scim_v2_schemas(opts = {})
  data, _status_code, _headers = get_scim_v2_schemas_with_http_info(opts)
  return data
end

#get_scim_v2_schemas_with_http_info(opts = {}) ⇒ `Array<(ScimV2SchemaListResponse, Fixnum, Hash)>`

Get a list of SCIM schemas

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:filter (String) —

Filtered results are invalid and return 403 Unauthorized.

Returns:

(Array<(ScimV2SchemaListResponse, Fixnum, Hash)>) —

ScimV2SchemaListResponse data, response status code and response headers

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 1432

def get_scim_v2_schemas_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SCIMApi.get_scim_v2_schemas ..."
  end
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/scim/v2/schemas".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'filter'] = opts[:'filter'] if opts[:'filter']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json', 'application/scim+json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'application/scim+json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScimV2SchemaListResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SCIMApi#get_scim_v2_schemas\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_scim_v2_serviceproviderconfig(opts = {}) ⇒ `ScimServiceProviderConfig`

Get a service provider’s configuration

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:if_none_match (String) —

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.

Returns:

(ScimServiceProviderConfig)

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 1486

def get_scim_v2_serviceproviderconfig(opts = {})
  data, _status_code, _headers = get_scim_v2_serviceproviderconfig_with_http_info(opts)
  return data
end

#get_scim_v2_serviceproviderconfig_with_http_info(opts = {}) ⇒ `Array<(ScimServiceProviderConfig, Fixnum, Hash)>`

Get a service provider's configuration

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:if_none_match (String) —

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.

Returns:

(Array<(ScimServiceProviderConfig, Fixnum, Hash)>) —

ScimServiceProviderConfig data, response status code and response headers

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 1496

def get_scim_v2_serviceproviderconfig_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SCIMApi.get_scim_v2_serviceproviderconfig ..."
  end
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/scim/v2/serviceproviderconfig".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json', 'application/scim+json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'application/scim+json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if opts[:'if_none_match']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScimServiceProviderConfig')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SCIMApi#get_scim_v2_serviceproviderconfig\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_scim_v2_user(user_id, opts = {}) ⇒ `ScimV2User`

Get a user

Parameters:

user_id —

The ID of a user. Returned with GET /api/v2/scim/v2/users.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:attributes (Array<String>) —

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.
:excluded_attributes (Array<String>) —

Indicates which attributes to exclude. Returns the default attributes minus "excludedAttributes". Use "excludedAttributes" to avoid expensive secondary calls for the default attributes. The 'id', 'userName', 'active', 'meta' attributes will always be present in output.
:if_none_match (String) —

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.

Returns:

(ScimV2User)

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 1553

def get_scim_v2_user(user_id, opts = {})
  data, _status_code, _headers = get_scim_v2_user_with_http_info(user_id, opts)
  return data
end

#get_scim_v2_user_with_http_info(user_id, opts = {}) ⇒ `Array<(ScimV2User, Fixnum, Hash)>`

Get a user

Parameters:

user_id —

The ID of a user. Returned with GET /api/v2/scim/v2/users.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:attributes (Array<String>) —

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.
:excluded_attributes (Array<String>) —

Indicates which attributes to exclude. Returns the default attributes minus "excludedAttributes". Use "excludedAttributes" to avoid expensive secondary calls for the default attributes. The 'id', 'userName', 'active', 'meta' attributes will always be present in output.
:if_none_match (String) —

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.

Returns:

(Array<(ScimV2User, Fixnum, Hash)>) —

ScimV2User data, response status code and response headers

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 1566

def get_scim_v2_user_with_http_info(user_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SCIMApi.get_scim_v2_user ..."
  end
  
  
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling SCIMApi.get_scim_v2_user" if user_id.nil?
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/scim/v2/users/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)

  # query parameters
  query_params = {}
  query_params[:'attributes'] = @api_client.build_collection_param(opts[:'attributes'], :multi) if opts[:'attributes']
  query_params[:'excludedAttributes'] = @api_client.build_collection_param(opts[:'excluded_attributes'], :multi) if opts[:'excluded_attributes']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json', 'application/scim+json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'application/scim+json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
  header_params[:'If-None-Match'] = opts[:'if_none_match'] if opts[:'if_none_match']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScimV2User')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SCIMApi#get_scim_v2_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_scim_v2_users(opts = {}) ⇒ `ScimUserListResponse`

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:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:start_index (Integer) —

The 1-based index of the first query result. (default to 1)
:count (Integer) —

The requested number of items per page. A value of 0 returns "totalResults". Note that a page size over 25 will likely cause a 429 error by exceeding internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values – (i.e. externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills) (default to 25)
:attributes (Array<String>) —

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.
:excluded_attributes (Array<String>) —

Indicates which attributes to exclude. Returns the default attributes minus "excludedAttributes". Use "excludedAttributes" to avoid expensive secondary calls for the default attributes. The 'id', 'userName', 'active', 'meta' attributes will always be present in output.
:filter (String) —

Filters results. If nothing is specified, returns all active users. Examples of valid values: "id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9", "userName eq [email protected]", "manager eq 16e10e2f-1136-43fe-bb84-eac073168a49", "email eq [email protected]", "division eq divisionName", "externalId eq 167844", "active eq false", "employeeNumber eq 9876543210".

Returns:

(ScimUserListResponse)

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 1646

def get_scim_v2_users(opts = {})
  data, _status_code, _headers = get_scim_v2_users_with_http_info(opts)
  return data
end

#get_scim_v2_users_with_http_info(opts = {}) ⇒ `Array<(ScimUserListResponse, Fixnum, Hash)>`

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:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:start_index (Integer) —

The 1-based index of the first query result.
:count (Integer) —

The requested number of items per page. A value of 0 returns "totalResults". Note that a page size over 25 will likely cause a 429 error by exceeding internal resource limits. Page sizes over 25 will require using excludedAttributes and includeAttributes query parameters to exclude secondary lookup values – (i.e. externalId, roles, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingLanguages, urn:ietf:params:scim:schemas:extension:genesys:purecloud:2.0:User:routingSkills)
:attributes (Array<String>) —

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.
:excluded_attributes (Array<String>) —

Indicates which attributes to exclude. Returns the default attributes minus "excludedAttributes". Use "excludedAttributes" to avoid expensive secondary calls for the default attributes. The 'id', 'userName', 'active', 'meta' attributes will always be present in output.
:filter (String) —

Filters results. If nothing is specified, returns all active users. Examples of valid values: "id eq 857449b0-d9e7-4cd0-acbf-a6adfb9ef1e9", "userName eq [email protected]", "manager eq 16e10e2f-1136-43fe-bb84-eac073168a49", "email eq [email protected]", "division eq divisionName", "externalId eq 167844", "active eq false", "employeeNumber eq 9876543210".

Returns:

(Array<(ScimUserListResponse, Fixnum, Hash)>) —

ScimUserListResponse data, response status code and response headers

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 1660

def get_scim_v2_users_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SCIMApi.get_scim_v2_users ..."
  end
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/scim/v2/users".sub('{format}','json')

  # query parameters
  query_params = {}
  query_params[:'startIndex'] = opts[:'start_index'] if opts[:'start_index']
  query_params[:'count'] = opts[:'count'] if opts[:'count']
  query_params[:'attributes'] = @api_client.build_collection_param(opts[:'attributes'], :multi) if opts[:'attributes']
  query_params[:'excludedAttributes'] = @api_client.build_collection_param(opts[:'excluded_attributes'], :multi) if opts[:'excluded_attributes']
  query_params[:'filter'] = opts[:'filter'] if opts[:'filter']

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json', 'application/scim+json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'application/scim+json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = nil
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:GET, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScimUserListResponse')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SCIMApi#get_scim_v2_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_scim_group(group_id, body, opts = {}) ⇒ `ScimV2Group`

Modify a group

Parameters:

group_id —

The ID of a group. Returned with GET /api/v2/scim/groups.
body —

The information used to modify a group.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:if_match (String) —

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".

Returns:

(ScimV2Group)

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 1744

def patch_scim_group(group_id, body, opts = {})
  data, _status_code, _headers = patch_scim_group_with_http_info(group_id, body, opts)
  return data
end

#patch_scim_group_with_http_info(group_id, body, opts = {}) ⇒ `Array<(ScimV2Group, Fixnum, Hash)>`

Modify a group

Parameters:

group_id —

The ID of a group. Returned with GET /api/v2/scim/groups.
body —

The information used to modify a group.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:if_match (String) —

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".

Returns:

(Array<(ScimV2Group, Fixnum, Hash)>) —

ScimV2Group data, response status code and response headers

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 1756

def patch_scim_group_with_http_info(group_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SCIMApi.patch_scim_group ..."
  end
  
  
  # verify the required parameter 'group_id' is set
  fail ArgumentError, "Missing the required parameter 'group_id' when calling SCIMApi.patch_scim_group" if group_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling SCIMApi.patch_scim_group" if body.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/scim/groups/{groupId}".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json', 'application/scim+json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'application/scim+json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
  header_params[:'If-Match'] = opts[:'if_match'] if opts[:'if_match']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScimV2Group')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SCIMApi#patch_scim_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_scim_user(user_id, body, opts = {}) ⇒ `ScimV2User`

Modify a user

Parameters:

user_id —

The ID of a user. Returned with GET /api/v2/scim/users.
body —

The information used to modify a user.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:if_match (String) —

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".

Returns:

(ScimV2User)

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 1828

def patch_scim_user(user_id, body, opts = {})
  data, _status_code, _headers = patch_scim_user_with_http_info(user_id, body, opts)
  return data
end

#patch_scim_user_with_http_info(user_id, body, opts = {}) ⇒ `Array<(ScimV2User, Fixnum, Hash)>`

Modify a user

Parameters:

user_id —

The ID of a user. Returned with GET /api/v2/scim/users.
body —

The information used to modify a user.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:if_match (String) —

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".

Returns:

(Array<(ScimV2User, Fixnum, Hash)>) —

ScimV2User data, response status code and response headers

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 1840

def patch_scim_user_with_http_info(user_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SCIMApi.patch_scim_user ..."
  end
  
  
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling SCIMApi.patch_scim_user" if user_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling SCIMApi.patch_scim_user" if body.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/scim/users/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json', 'application/scim+json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'application/scim+json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
  header_params[:'If-Match'] = opts[:'if_match'] if opts[:'if_match']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScimV2User')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SCIMApi#patch_scim_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_scim_v2_group(group_id, body, opts = {}) ⇒ `ScimV2Group`

Modify a group

Parameters:

group_id —

The ID of a group. Returned with GET /api/v2/scim/v2/groups.
body —

The information used to modify a group.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:if_match (String) —

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".

Returns:

(ScimV2Group)

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 1912

def patch_scim_v2_group(group_id, body, opts = {})
  data, _status_code, _headers = patch_scim_v2_group_with_http_info(group_id, body, opts)
  return data
end

#patch_scim_v2_group_with_http_info(group_id, body, opts = {}) ⇒ `Array<(ScimV2Group, Fixnum, Hash)>`

Modify a group

Parameters:

group_id —

The ID of a group. Returned with GET /api/v2/scim/v2/groups.
body —

The information used to modify a group.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:if_match (String) —

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".

Returns:

(Array<(ScimV2Group, Fixnum, Hash)>) —

ScimV2Group data, response status code and response headers

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 1924

def patch_scim_v2_group_with_http_info(group_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SCIMApi.patch_scim_v2_group ..."
  end
  
  
  # verify the required parameter 'group_id' is set
  fail ArgumentError, "Missing the required parameter 'group_id' when calling SCIMApi.patch_scim_v2_group" if group_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling SCIMApi.patch_scim_v2_group" if body.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/scim/v2/groups/{groupId}".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json', 'application/scim+json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'application/scim+json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
  header_params[:'If-Match'] = opts[:'if_match'] if opts[:'if_match']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScimV2Group')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SCIMApi#patch_scim_v2_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_scim_v2_user(user_id, body, opts = {}) ⇒ `ScimV2User`

Modify a user

Parameters:

user_id —

The ID of a user. Returned with GET /api/v2/scim/v2/users.
body —

The information used to modify a user.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:if_match (String) —

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".

Returns:

(ScimV2User)

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 1996

def patch_scim_v2_user(user_id, body, opts = {})
  data, _status_code, _headers = patch_scim_v2_user_with_http_info(user_id, body, opts)
  return data
end

#patch_scim_v2_user_with_http_info(user_id, body, opts = {}) ⇒ `Array<(ScimV2User, Fixnum, Hash)>`

Modify a user

Parameters:

user_id —

The ID of a user. Returned with GET /api/v2/scim/v2/users.
body —

The information used to modify a user.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:if_match (String) —

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".

Returns:

(Array<(ScimV2User, Fixnum, Hash)>) —

ScimV2User data, response status code and response headers

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 2008

def patch_scim_v2_user_with_http_info(user_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SCIMApi.patch_scim_v2_user ..."
  end
  
  
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling SCIMApi.patch_scim_v2_user" if user_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling SCIMApi.patch_scim_v2_user" if body.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/scim/v2/users/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json', 'application/scim+json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'application/scim+json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
  header_params[:'If-Match'] = opts[:'if_match'] if opts[:'if_match']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScimV2User')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SCIMApi#patch_scim_v2_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_scim_groups(body, opts = {}) ⇒ `ScimV2Group`

Creates a group Creates a Genesys Cloud group with group visibility set to "public" and rules visibility set to "true". Auto-creates an "externalId". "externalId" is used to determine if DELETE /api/v2/scim/groups/groupId or DELETE /api/v2/scim/v2/groups/groupId should be allowed.

Parameters:

body —

The information used to create a group.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(ScimV2Group)

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 2078

def post_scim_groups(body, opts = {})
  data, _status_code, _headers = post_scim_groups_with_http_info(body, opts)
  return data
end

#post_scim_groups_with_http_info(body, opts = {}) ⇒ `Array<(ScimV2Group, Fixnum, Hash)>`

Creates a group Creates a Genesys Cloud group with group visibility set to "public" and rules visibility set to "true". Auto-creates an "externalId". "externalId" is used to determine if DELETE /api/v2/scim/groups/groupId or DELETE /api/v2/scim/v2/groups/groupId should be allowed.

Parameters:

body —

The information used to create a group.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(ScimV2Group, Fixnum, Hash)>) —

ScimV2Group data, response status code and response headers

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 2088

def post_scim_groups_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SCIMApi.post_scim_groups ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling SCIMApi.post_scim_groups" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/scim/groups".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json', 'application/scim+json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'application/scim+json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScimV2Group')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SCIMApi#post_scim_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_scim_users(body, opts = {}) ⇒ `ScimV2User`

Create a user

Parameters:

body —

The information used to create a user.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(ScimV2User)

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 2143

def post_scim_users(body, opts = {})
  data, _status_code, _headers = post_scim_users_with_http_info(body, opts)
  return data
end

#post_scim_users_with_http_info(body, opts = {}) ⇒ `Array<(ScimV2User, Fixnum, Hash)>`

Create a user

Parameters:

body —

The information used to create a user.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(ScimV2User, Fixnum, Hash)>) —

ScimV2User data, response status code and response headers

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 2153

def post_scim_users_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SCIMApi.post_scim_users ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling SCIMApi.post_scim_users" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/scim/users".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json', 'application/scim+json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'application/scim+json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScimV2User')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SCIMApi#post_scim_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_scim_v2_groups(body, opts = {}) ⇒ `ScimV2Group`

Create a group Creates an "official" Genesys Cloud group with group visibility set to "public" and rules visibility set to "true". Auto-creates an "externalId". "externalId" is used to determine if DELETE /api/v2/scim/groups/groupId or DELETE /api/v2/scim/v2/groups/groupId should be allowed.

Parameters:

body —

Creates a group.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(ScimV2Group)

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 2208

def post_scim_v2_groups(body, opts = {})
  data, _status_code, _headers = post_scim_v2_groups_with_http_info(body, opts)
  return data
end

#post_scim_v2_groups_with_http_info(body, opts = {}) ⇒ `Array<(ScimV2Group, Fixnum, Hash)>`

Create a group Creates an "official" Genesys Cloud group with group visibility set to "public" and rules visibility set to "true". Auto-creates an "externalId". "externalId" is used to determine if DELETE /api/v2/scim/groups/groupId or DELETE /api/v2/scim/v2/groups/groupId should be allowed.

Parameters:

body —

Creates a group.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(ScimV2Group, Fixnum, Hash)>) —

ScimV2Group data, response status code and response headers

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 2218

def post_scim_v2_groups_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SCIMApi.post_scim_v2_groups ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling SCIMApi.post_scim_v2_groups" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/scim/v2/groups".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json', 'application/scim+json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'application/scim+json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScimV2Group')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SCIMApi#post_scim_v2_groups\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#post_scim_v2_users(body, opts = {}) ⇒ `ScimV2User`

Create a user

Parameters:

body —

The information used to create a user.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(ScimV2User)

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 2273

def post_scim_v2_users(body, opts = {})
  data, _status_code, _headers = post_scim_v2_users_with_http_info(body, opts)
  return data
end

#post_scim_v2_users_with_http_info(body, opts = {}) ⇒ `Array<(ScimV2User, Fixnum, Hash)>`

Create a user

Parameters:

body —

The information used to create a user.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(ScimV2User, Fixnum, Hash)>) —

ScimV2User data, response status code and response headers

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 2283

def post_scim_v2_users_with_http_info(body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SCIMApi.post_scim_v2_users ..."
  end
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling SCIMApi.post_scim_v2_users" if body.nil?
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/scim/v2/users".sub('{format}','json')

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json', 'application/scim+json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'application/scim+json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:POST, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScimV2User')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SCIMApi#post_scim_v2_users\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_scim_group(group_id, body, opts = {}) ⇒ `ScimV2Group`

Replace a group

Parameters:

group_id —

The ID of a group. Returned with GET /api/v2/scim/groups.
body —

The information used to replace a group.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:if_match (String) —

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".

Returns:

(ScimV2Group)

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 2340

def put_scim_group(group_id, body, opts = {})
  data, _status_code, _headers = put_scim_group_with_http_info(group_id, body, opts)
  return data
end

#put_scim_group_with_http_info(group_id, body, opts = {}) ⇒ `Array<(ScimV2Group, Fixnum, Hash)>`

Replace a group

Parameters:

group_id —

The ID of a group. Returned with GET /api/v2/scim/groups.
body —

The information used to replace a group.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:if_match (String) —

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".

Returns:

(Array<(ScimV2Group, Fixnum, Hash)>) —

ScimV2Group data, response status code and response headers

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 2352

def put_scim_group_with_http_info(group_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SCIMApi.put_scim_group ..."
  end
  
  
  # verify the required parameter 'group_id' is set
  fail ArgumentError, "Missing the required parameter 'group_id' when calling SCIMApi.put_scim_group" if group_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling SCIMApi.put_scim_group" if body.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/scim/groups/{groupId}".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json', 'application/scim+json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'application/scim+json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
  header_params[:'If-Match'] = opts[:'if_match'] if opts[:'if_match']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScimV2Group')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SCIMApi#put_scim_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_scim_user(user_id, body, opts = {}) ⇒ `ScimV2User`

Replace a user

Parameters:

user_id —

The ID of a user. Returned with GET /api/v2/scim/users.
body —

The information used to replace a user.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:if_match (String) —

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".

Returns:

(ScimV2User)

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 2424

def put_scim_user(user_id, body, opts = {})
  data, _status_code, _headers = put_scim_user_with_http_info(user_id, body, opts)
  return data
end

#put_scim_user_with_http_info(user_id, body, opts = {}) ⇒ `Array<(ScimV2User, Fixnum, Hash)>`

Replace a user

Parameters:

user_id —

The ID of a user. Returned with GET /api/v2/scim/users.
body —

The information used to replace a user.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:if_match (String) —

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".

Returns:

(Array<(ScimV2User, Fixnum, Hash)>) —

ScimV2User data, response status code and response headers

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 2436

def put_scim_user_with_http_info(user_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SCIMApi.put_scim_user ..."
  end
  
  
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling SCIMApi.put_scim_user" if user_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling SCIMApi.put_scim_user" if body.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/scim/users/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json', 'application/scim+json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'application/scim+json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
  header_params[:'If-Match'] = opts[:'if_match'] if opts[:'if_match']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScimV2User')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SCIMApi#put_scim_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_scim_v2_group(group_id, body, opts = {}) ⇒ `ScimV2Group`

Replace a group

Parameters:

group_id —

The ID of a group. Returned with GET /api/v2/scim/v2/groups.
body —

The information used to replace a group.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:if_match (String) —

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".

Returns:

(ScimV2Group)

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 2508

def put_scim_v2_group(group_id, body, opts = {})
  data, _status_code, _headers = put_scim_v2_group_with_http_info(group_id, body, opts)
  return data
end

#put_scim_v2_group_with_http_info(group_id, body, opts = {}) ⇒ `Array<(ScimV2Group, Fixnum, Hash)>`

Replace a group

Parameters:

group_id —

The ID of a group. Returned with GET /api/v2/scim/v2/groups.
body —

The information used to replace a group.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:if_match (String) —

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".

Returns:

(Array<(ScimV2Group, Fixnum, Hash)>) —

ScimV2Group data, response status code and response headers

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 2520

def put_scim_v2_group_with_http_info(group_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SCIMApi.put_scim_v2_group ..."
  end
  
  
  # verify the required parameter 'group_id' is set
  fail ArgumentError, "Missing the required parameter 'group_id' when calling SCIMApi.put_scim_v2_group" if group_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling SCIMApi.put_scim_v2_group" if body.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/scim/v2/groups/{groupId}".sub('{format}','json').sub('{' + 'groupId' + '}', group_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json', 'application/scim+json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'application/scim+json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
  header_params[:'If-Match'] = opts[:'if_match'] if opts[:'if_match']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScimV2Group')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SCIMApi#put_scim_v2_group\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#put_scim_v2_user(user_id, body, opts = {}) ⇒ `ScimV2User`

Replace a user

Parameters:

user_id —

The ID of a user. Returned with GET /api/v2/scim/v2/users.
body —

The information used to replace a user.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:if_match (String) —

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".

Returns:

(ScimV2User)

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 2592

def put_scim_v2_user(user_id, body, opts = {})
  data, _status_code, _headers = put_scim_v2_user_with_http_info(user_id, body, opts)
  return data
end

#put_scim_v2_user_with_http_info(user_id, body, opts = {}) ⇒ `Array<(ScimV2User, Fixnum, Hash)>`

Replace a user

Parameters:

user_id —

The ID of a user. Returned with GET /api/v2/scim/v2/users.
body —

The information used to replace a user.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:if_match (String) —

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".

Returns:

(Array<(ScimV2User, Fixnum, Hash)>) —

ScimV2User data, response status code and response headers

# File 'lib/purecloudplatformclientv2/api/scim_api.rb', line 2604

def put_scim_v2_user_with_http_info(user_id, body, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug "Calling API: SCIMApi.put_scim_v2_user ..."
  end
  
  
  # verify the required parameter 'user_id' is set
  fail ArgumentError, "Missing the required parameter 'user_id' when calling SCIMApi.put_scim_v2_user" if user_id.nil?
  
  
  
  
  
  
  # verify the required parameter 'body' is set
  fail ArgumentError, "Missing the required parameter 'body' when calling SCIMApi.put_scim_v2_user" if body.nil?
  
  
  
  
  
  
  
  
  
  
  
  # resource path
  local_var_path = "/api/v2/scim/v2/users/{userId}".sub('{format}','json').sub('{' + 'userId' + '}', user_id.to_s)

  # query parameters
  query_params = {}

  # header parameters
  header_params = {}

  # HTTP header 'Accept' (if needed)
  local_header_accept = ['application/json', 'application/scim+json']
  local_header_accept_result = @api_client.select_header_accept(local_header_accept) and header_params['Accept'] = local_header_accept_result

  # HTTP header 'Content-Type'
  local_header_content_type = ['application/json', 'application/scim+json']
  header_params['Content-Type'] = @api_client.select_header_content_type(local_header_content_type)
  header_params[:'If-Match'] = opts[:'if_match'] if opts[:'if_match']

  # form parameters
  form_params = {}

  # http body (model)
  post_body = @api_client.object_to_http_body(body)
  
  auth_names = ['PureCloud OAuth']
  data, status_code, headers = @api_client.call_api(:PUT, local_var_path,
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => 'ScimV2User')
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: SCIMApi#put_scim_v2_user\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

Class: PureCloud::SCIMApi

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ SCIMApi

Instance Attribute Details

#api_client ⇒ Object

Instance Method Details

#delete_scim_group(group_id, opts = {}) ⇒ nil

#delete_scim_group_with_http_info(group_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

#delete_scim_user(user_id, opts = {}) ⇒ Empty

#delete_scim_user_with_http_info(user_id, opts = {}) ⇒ Array<(Empty, Fixnum, Hash)>

#delete_scim_v2_group(group_id, opts = {}) ⇒ nil

#delete_scim_v2_group_with_http_info(group_id, opts = {}) ⇒ Array<(nil, Fixnum, Hash)>

#delete_scim_v2_user(user_id, opts = {}) ⇒ Empty

#delete_scim_v2_user_with_http_info(user_id, opts = {}) ⇒ Array<(Empty, Fixnum, Hash)>

#get_scim_group(group_id, opts = {}) ⇒ ScimV2Group

#get_scim_group_with_http_info(group_id, opts = {}) ⇒ Array<(ScimV2Group, Fixnum, Hash)>

#get_scim_groups(opts = {}) ⇒ ScimGroupListResponse

#get_scim_groups_with_http_info(opts = {}) ⇒ Array<(ScimGroupListResponse, Fixnum, Hash)>

#get_scim_resourcetype(resource_type, opts = {}) ⇒ ScimConfigResourceType

#get_scim_resourcetype_with_http_info(resource_type, opts = {}) ⇒ Array<(ScimConfigResourceType, Fixnum, Hash)>

#get_scim_resourcetypes(opts = {}) ⇒ ScimConfigResourceTypesListResponse

#get_scim_resourcetypes_with_http_info(opts = {}) ⇒ Array<(ScimConfigResourceTypesListResponse, Fixnum, Hash)>

#get_scim_schema(schema_id, opts = {}) ⇒ ScimV2SchemaDefinition

#get_scim_schema_with_http_info(schema_id, opts = {}) ⇒ Array<(ScimV2SchemaDefinition, Fixnum, Hash)>

#get_scim_schemas(opts = {}) ⇒ ScimV2SchemaListResponse

#get_scim_schemas_with_http_info(opts = {}) ⇒ Array<(ScimV2SchemaListResponse, Fixnum, Hash)>

#get_scim_serviceproviderconfig(opts = {}) ⇒ ScimServiceProviderConfig

#get_scim_serviceproviderconfig_with_http_info(opts = {}) ⇒ Array<(ScimServiceProviderConfig, Fixnum, Hash)>

#get_scim_user(user_id, opts = {}) ⇒ ScimV2User

#get_scim_user_with_http_info(user_id, opts = {}) ⇒ Array<(ScimV2User, Fixnum, Hash)>

#get_scim_users(opts = {}) ⇒ ScimUserListResponse

#get_scim_users_with_http_info(opts = {}) ⇒ Array<(ScimUserListResponse, Fixnum, Hash)>

#get_scim_v2_group(group_id, opts = {}) ⇒ ScimV2Group

#get_scim_v2_group_with_http_info(group_id, opts = {}) ⇒ Array<(ScimV2Group, Fixnum, Hash)>

#get_scim_v2_groups(filter, opts = {}) ⇒ ScimGroupListResponse

#get_scim_v2_groups_with_http_info(filter, opts = {}) ⇒ Array<(ScimGroupListResponse, Fixnum, Hash)>

#get_scim_v2_resourcetype(resource_type, opts = {}) ⇒ ScimConfigResourceType

#get_scim_v2_resourcetype_with_http_info(resource_type, opts = {}) ⇒ Array<(ScimConfigResourceType, Fixnum, Hash)>

#get_scim_v2_resourcetypes(opts = {}) ⇒ ScimConfigResourceTypesListResponse

#get_scim_v2_resourcetypes_with_http_info(opts = {}) ⇒ Array<(ScimConfigResourceTypesListResponse, Fixnum, Hash)>

#get_scim_v2_schema(schema_id, opts = {}) ⇒ ScimV2SchemaDefinition

#get_scim_v2_schema_with_http_info(schema_id, opts = {}) ⇒ Array<(ScimV2SchemaDefinition, Fixnum, Hash)>

#get_scim_v2_schemas(opts = {}) ⇒ ScimV2SchemaListResponse

#get_scim_v2_schemas_with_http_info(opts = {}) ⇒ Array<(ScimV2SchemaListResponse, Fixnum, Hash)>

#get_scim_v2_serviceproviderconfig(opts = {}) ⇒ ScimServiceProviderConfig

#get_scim_v2_serviceproviderconfig_with_http_info(opts = {}) ⇒ Array<(ScimServiceProviderConfig, Fixnum, Hash)>

#get_scim_v2_user(user_id, opts = {}) ⇒ ScimV2User

#get_scim_v2_user_with_http_info(user_id, opts = {}) ⇒ Array<(ScimV2User, Fixnum, Hash)>

#get_scim_v2_users(opts = {}) ⇒ ScimUserListResponse

#get_scim_v2_users_with_http_info(opts = {}) ⇒ Array<(ScimUserListResponse, Fixnum, Hash)>

#patch_scim_group(group_id, body, opts = {}) ⇒ ScimV2Group

#patch_scim_group_with_http_info(group_id, body, opts = {}) ⇒ Array<(ScimV2Group, Fixnum, Hash)>

#patch_scim_user(user_id, body, opts = {}) ⇒ ScimV2User

#patch_scim_user_with_http_info(user_id, body, opts = {}) ⇒ Array<(ScimV2User, Fixnum, Hash)>

#patch_scim_v2_group(group_id, body, opts = {}) ⇒ ScimV2Group

#patch_scim_v2_group_with_http_info(group_id, body, opts = {}) ⇒ Array<(ScimV2Group, Fixnum, Hash)>

#patch_scim_v2_user(user_id, body, opts = {}) ⇒ ScimV2User

#patch_scim_v2_user_with_http_info(user_id, body, opts = {}) ⇒ Array<(ScimV2User, Fixnum, Hash)>

#post_scim_groups(body, opts = {}) ⇒ ScimV2Group

#post_scim_groups_with_http_info(body, opts = {}) ⇒ Array<(ScimV2Group, Fixnum, Hash)>

#post_scim_users(body, opts = {}) ⇒ ScimV2User

#post_scim_users_with_http_info(body, opts = {}) ⇒ Array<(ScimV2User, Fixnum, Hash)>

#post_scim_v2_groups(body, opts = {}) ⇒ ScimV2Group

#post_scim_v2_groups_with_http_info(body, opts = {}) ⇒ Array<(ScimV2Group, Fixnum, Hash)>

#post_scim_v2_users(body, opts = {}) ⇒ ScimV2User

#post_scim_v2_users_with_http_info(body, opts = {}) ⇒ Array<(ScimV2User, Fixnum, Hash)>

#put_scim_group(group_id, body, opts = {}) ⇒ ScimV2Group

#put_scim_group_with_http_info(group_id, body, opts = {}) ⇒ Array<(ScimV2Group, Fixnum, Hash)>

#put_scim_user(user_id, body, opts = {}) ⇒ ScimV2User

#put_scim_user_with_http_info(user_id, body, opts = {}) ⇒ Array<(ScimV2User, Fixnum, Hash)>

#put_scim_v2_group(group_id, body, opts = {}) ⇒ ScimV2Group

#put_scim_v2_group_with_http_info(group_id, body, opts = {}) ⇒ Array<(ScimV2Group, Fixnum, Hash)>

#put_scim_v2_user(user_id, body, opts = {}) ⇒ ScimV2User

#put_scim_v2_user_with_http_info(user_id, body, opts = {}) ⇒ Array<(ScimV2User, Fixnum, Hash)>

#initialize(api_client = ApiClient.default) ⇒ `SCIMApi`

#api_client ⇒ `Object`

#delete_scim_group(group_id, opts = {}) ⇒ `nil`

#delete_scim_group_with_http_info(group_id, opts = {}) ⇒ `Array<(nil, Fixnum, Hash)>`

#delete_scim_user(user_id, opts = {}) ⇒ `Empty`

#delete_scim_user_with_http_info(user_id, opts = {}) ⇒ `Array<(Empty, Fixnum, Hash)>`

#delete_scim_v2_group(group_id, opts = {}) ⇒ `nil`

#delete_scim_v2_group_with_http_info(group_id, opts = {}) ⇒ `Array<(nil, Fixnum, Hash)>`

#delete_scim_v2_user(user_id, opts = {}) ⇒ `Empty`

#delete_scim_v2_user_with_http_info(user_id, opts = {}) ⇒ `Array<(Empty, Fixnum, Hash)>`

#get_scim_group(group_id, opts = {}) ⇒ `ScimV2Group`

#get_scim_group_with_http_info(group_id, opts = {}) ⇒ `Array<(ScimV2Group, Fixnum, Hash)>`

#get_scim_groups(opts = {}) ⇒ `ScimGroupListResponse`

#get_scim_groups_with_http_info(opts = {}) ⇒ `Array<(ScimGroupListResponse, Fixnum, Hash)>`

#get_scim_resourcetype(resource_type, opts = {}) ⇒ `ScimConfigResourceType`

#get_scim_resourcetype_with_http_info(resource_type, opts = {}) ⇒ `Array<(ScimConfigResourceType, Fixnum, Hash)>`

#get_scim_resourcetypes(opts = {}) ⇒ `ScimConfigResourceTypesListResponse`

#get_scim_resourcetypes_with_http_info(opts = {}) ⇒ `Array<(ScimConfigResourceTypesListResponse, Fixnum, Hash)>`

#get_scim_schema(schema_id, opts = {}) ⇒ `ScimV2SchemaDefinition`

#get_scim_schema_with_http_info(schema_id, opts = {}) ⇒ `Array<(ScimV2SchemaDefinition, Fixnum, Hash)>`

#get_scim_schemas(opts = {}) ⇒ `ScimV2SchemaListResponse`

#get_scim_schemas_with_http_info(opts = {}) ⇒ `Array<(ScimV2SchemaListResponse, Fixnum, Hash)>`

#get_scim_serviceproviderconfig(opts = {}) ⇒ `ScimServiceProviderConfig`

#get_scim_serviceproviderconfig_with_http_info(opts = {}) ⇒ `Array<(ScimServiceProviderConfig, Fixnum, Hash)>`

#get_scim_user(user_id, opts = {}) ⇒ `ScimV2User`

#get_scim_user_with_http_info(user_id, opts = {}) ⇒ `Array<(ScimV2User, Fixnum, Hash)>`

#get_scim_users(opts = {}) ⇒ `ScimUserListResponse`

#get_scim_users_with_http_info(opts = {}) ⇒ `Array<(ScimUserListResponse, Fixnum, Hash)>`

#get_scim_v2_group(group_id, opts = {}) ⇒ `ScimV2Group`

#get_scim_v2_group_with_http_info(group_id, opts = {}) ⇒ `Array<(ScimV2Group, Fixnum, Hash)>`

#get_scim_v2_groups(filter, opts = {}) ⇒ `ScimGroupListResponse`

#get_scim_v2_groups_with_http_info(filter, opts = {}) ⇒ `Array<(ScimGroupListResponse, Fixnum, Hash)>`

#get_scim_v2_resourcetype(resource_type, opts = {}) ⇒ `ScimConfigResourceType`

#get_scim_v2_resourcetype_with_http_info(resource_type, opts = {}) ⇒ `Array<(ScimConfigResourceType, Fixnum, Hash)>`

#get_scim_v2_resourcetypes(opts = {}) ⇒ `ScimConfigResourceTypesListResponse`

#get_scim_v2_resourcetypes_with_http_info(opts = {}) ⇒ `Array<(ScimConfigResourceTypesListResponse, Fixnum, Hash)>`

#get_scim_v2_schema(schema_id, opts = {}) ⇒ `ScimV2SchemaDefinition`

#get_scim_v2_schema_with_http_info(schema_id, opts = {}) ⇒ `Array<(ScimV2SchemaDefinition, Fixnum, Hash)>`

#get_scim_v2_schemas(opts = {}) ⇒ `ScimV2SchemaListResponse`

#get_scim_v2_schemas_with_http_info(opts = {}) ⇒ `Array<(ScimV2SchemaListResponse, Fixnum, Hash)>`

#get_scim_v2_serviceproviderconfig(opts = {}) ⇒ `ScimServiceProviderConfig`

#get_scim_v2_serviceproviderconfig_with_http_info(opts = {}) ⇒ `Array<(ScimServiceProviderConfig, Fixnum, Hash)>`

#get_scim_v2_user(user_id, opts = {}) ⇒ `ScimV2User`

#get_scim_v2_user_with_http_info(user_id, opts = {}) ⇒ `Array<(ScimV2User, Fixnum, Hash)>`

#get_scim_v2_users(opts = {}) ⇒ `ScimUserListResponse`

#get_scim_v2_users_with_http_info(opts = {}) ⇒ `Array<(ScimUserListResponse, Fixnum, Hash)>`

#patch_scim_group(group_id, body, opts = {}) ⇒ `ScimV2Group`

#patch_scim_group_with_http_info(group_id, body, opts = {}) ⇒ `Array<(ScimV2Group, Fixnum, Hash)>`

#patch_scim_user(user_id, body, opts = {}) ⇒ `ScimV2User`

#patch_scim_user_with_http_info(user_id, body, opts = {}) ⇒ `Array<(ScimV2User, Fixnum, Hash)>`

#patch_scim_v2_group(group_id, body, opts = {}) ⇒ `ScimV2Group`

#patch_scim_v2_group_with_http_info(group_id, body, opts = {}) ⇒ `Array<(ScimV2Group, Fixnum, Hash)>`

#patch_scim_v2_user(user_id, body, opts = {}) ⇒ `ScimV2User`

#patch_scim_v2_user_with_http_info(user_id, body, opts = {}) ⇒ `Array<(ScimV2User, Fixnum, Hash)>`

#post_scim_groups(body, opts = {}) ⇒ `ScimV2Group`

#post_scim_groups_with_http_info(body, opts = {}) ⇒ `Array<(ScimV2Group, Fixnum, Hash)>`

#post_scim_users(body, opts = {}) ⇒ `ScimV2User`

#post_scim_users_with_http_info(body, opts = {}) ⇒ `Array<(ScimV2User, Fixnum, Hash)>`

#post_scim_v2_groups(body, opts = {}) ⇒ `ScimV2Group`

#post_scim_v2_groups_with_http_info(body, opts = {}) ⇒ `Array<(ScimV2Group, Fixnum, Hash)>`

#post_scim_v2_users(body, opts = {}) ⇒ `ScimV2User`

#post_scim_v2_users_with_http_info(body, opts = {}) ⇒ `Array<(ScimV2User, Fixnum, Hash)>`

#put_scim_group(group_id, body, opts = {}) ⇒ `ScimV2Group`

#put_scim_group_with_http_info(group_id, body, opts = {}) ⇒ `Array<(ScimV2Group, Fixnum, Hash)>`

#put_scim_user(user_id, body, opts = {}) ⇒ `ScimV2User`

#put_scim_user_with_http_info(user_id, body, opts = {}) ⇒ `Array<(ScimV2User, Fixnum, Hash)>`

#put_scim_v2_group(group_id, body, opts = {}) ⇒ `ScimV2Group`

#put_scim_v2_group_with_http_info(group_id, body, opts = {}) ⇒ `Array<(ScimV2Group, Fixnum, Hash)>`

#put_scim_v2_user(user_id, body, opts = {}) ⇒ `ScimV2User`

#put_scim_v2_user_with_http_info(user_id, body, opts = {}) ⇒ `Array<(ScimV2User, Fixnum, Hash)>`