> For the complete documentation index, see [llms.txt](https://docs.ggwp.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.ggwp.com/identity-and-access-management-iam/api-docs-scim/users-apis.md).

# Users APIs

### Overview

The `/Users` endpoint is used to manage user identities in the system.

It supports the full user lifecycle, including:

* Creating users
* Retrieving user information
* Updating user attributes
* Deleting users

Identity providers such as Okta and Microsoft Azure Active Directory use this endpoint for automated provisioning and deprovisioning.

***

### Base Endpoint

```http
https://api.ggwp.com/scim/v2/Users
```

***

### Supported Operations

| Operation   | Method | Endpoint      |
| ----------- | ------ | ------------- |
| Create User | POST   | `/Users`      |
| Get User    | GET    | `/Users/{id}` |
| Patch User  | PATCH  | `/Users/{id}` |
| Delete User | DELETE | `/Users/{id}` |

***

### Resource Identifier

Each user is uniquely identified by:

* `id` → System-generated unique identifier
* `userName` → Unique username (used by IdPs)
* `email` → Unique email

***

### Request & Response Format

All requests and responses must:

* Include the `schemas` attribute
* Follow SCIM 2.0 standards

***

### Attributes

<table><thead><tr><th width="179.5">Attribute</th><th>Description</th></tr></thead><tbody><tr><td>id</td><td>Unique identifier</td></tr><tr><td>userName</td><td>Unique username</td></tr><tr><td>emails</td><td>User email(s)</td></tr><tr><td>name</td><td>User’s name object</td></tr><tr><td>active</td><td>Indicates if user is active (not used)</td></tr></tbody></table>