# Users

Retrieve, add, modify Users.

## Query users

 - [GET /scim/v2/Users](https://innovario.apishowdown.com/catalog/api-showdown/api-hub/admin/openapi/users/queryuser.md): The SCIM protocol defines a standard set of query parameters that can be used to filter, sort, and paginate to return zero or more resources in a query response.

> For more on filtering with SCIM routes, please see RFC 7644 Filtering.


## Create a new user

 - [POST /scim/v2/Users](https://innovario.apishowdown.com/catalog/api-showdown/api-hub/admin/openapi/users/createuser.md): Creates a new user and brings that user object to the service provider.


## Retrieve a known user

 - [GET /scim/v2/Users/{userId}](https://innovario.apishowdown.com/catalog/api-showdown/api-hub/admin/openapi/users/getuser.md): Retrieve a known user by their ID.

> : This checks the user is present in the SCIM application.


## Modifies a user with a set of client-specified changes (partial update).

 - [PATCH /scim/v2/Users/{userId}](https://innovario.apishowdown.com/catalog/api-showdown/api-hub/admin/openapi/users/modifyuserattributes.md): Update one or more attributes of a SCIM resource using a sequence of operations to , , or  values.

The general form of the SCIM  request is based on the JSON Patch approach. Find more at [RFC6902].

> : One difference between SCIM  and JSON Patch is that SCIM servers do not support array indexing and do not support [RFC6902] operation types relating to array element manipulation, such as .

The body of each request must contain the "schemas" attribute with the URI value of .

The body of an HTTP  request must contain the attribute  whose value is an array of one or more  operations. Each  operation object must have exactly one  member whose value indicates the operation to perform and may be one of the following:

- 
- 
- . 

> : The semantics of each operation are defined in Section 3.5.2 of [RFC7644].

The  attribute value is a  containing an attribute path describing the target of the operation.  The  attribute is  for  and  and is  for  operations.

Each operation against an attribute must be compatible with the attribute's mutability and schema as defined in Sections 2.2 and 2.3 of [RFC7643].
For example, a client  modify an attribute that has mutability  or .  However, a client may  a value to an  attribute if the attribute had no previous value.  An operation that is not compatible with an attribute's mutability or schema will return the appropriate HTTP response status code and a JSON detail error response as defined in Section 3.12.

Each  operation represents a single action to be applied to the same SCIM resource specified by the request URI. Operations are applied sequentially in the order they appear in the array.  Each operation in the sequence is applied to the target resource; the resulting resource becomes the target of the next operation. Evaluation continues until all operations are successfully applied or until an error condition is encountered.

> : For multi-valued attributes, a  operation that sets a value's  sub-attribute to  will cause the server to automatically set "primary" to "false" for any other values in the array.


## Modifies a user by replacing existing attributes with a specified set of replacement attributes (replace).

 - [PUT /scim/v2/Users/{userId}](https://innovario.apishowdown.com/catalog/api-showdown/api-hub/admin/openapi/users/replaceuserattributes.md): Used to replace a resource's attributes.

For example, clients that have previously retrieved the entire resource in advance and revised it may replace the resource using an HTTP . Because SCIM resource identifiers are assigned by the service provider, HTTP   be used to create new resources.

> : As the operation's intent is to replace all attributes, SCIM clients may send all attributes, regardless of each attribute's mutability.


## Deletes a user.

 - [DELETE /scim/v2/Users/{userId}](https://innovario.apishowdown.com/catalog/api-showdown/api-hub/admin/openapi/users/deleteuser.md): This operations removes the user from the ReachFive side.