> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://contentful.com/developers/docs/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://contentful.com/_mcp/server.

SCIM Users represent members of your Contentful organization.

You can create, update and list users with the SCIM API. Deactivating and removing users are currently not supported.

| SCIM Attribute    | Contentful `User` Attribute | Required | Mutability | Type    |
| ----------------- | --------------------------- | -------- | ---------- | ------- |
| `userName`        | `email`                     | yes      | immutable  | String  |
| `name.givenName`  | `firstName`                 | yes      | immutable  | String  |
| `name.familyName` | `lastName`                  | yes      | immutable  | String  |
| `active`          | `-`                         | no       | readOnly   | Boolean |
| `emails`          | `email`                     | no       | readOnly   | Array   |

Note: Other attributes supported by the SCIM specification will not be synchronized between Identity Providers and Contentful.

## User

[Get a user](/references/scim-api/users/get-a-user)

[Update a user with PUT](/references/scim-api/users/update-a-user)

Updates attributes of the user.

**Note**: This endpoint is currently provided for identity provider compatibility, since no User attributes are mutable.

[Update a user with PATCH](/references/scim-api/users/patch-a-user)

Updates attributes of the user.

**Note**: This endpoint is currently provided for identity provider compatibility, since no User attributes are mutable.

[Delete a user](/references/scim-api/users/delete-a-user)

Use this endpoint to remove a user from your organization. Removing a user from your organization will also remove the user from all teams and spaces.

**Note**: The action does not delete the user's Contentful account, but only removes them from your organization.

## Users collection

[Get all users in the organization](/references/scim-api/users/get-all-users)

It is possible to filter by the `userName eq` filter, passing a valid user email address as the value. See the [Filtering](https://tools.ietf.org/html/rfc7644#section-3.4.2.2) section in the SCIM 2.0 specification for details.

```
GET /Users?filter=userName eq "user@example.com"
```

[Create a user](/references/scim-api/users/create-a-user)

Newly created users will appear in your organization as "Invited". If you use the User Management API, you'll see the new Organization Membership with the `status` property of `"pending"`.

The new users should receive an invitation email to join your Organization. In SSO enabled organizations, users will not receive this email notification.

All users are created with the organization role of `member`. Role changes are currently only supported via the User Management API or in the Contentful web app.


## API Docs

- Users [Get a user](https://contentful.com/developers/docs/references/scim-api/users/get-a-user.md)
- Users [Update a user](https://contentful.com/developers/docs/references/scim-api/users/update-a-user.md)
- Users [Delete a user](https://contentful.com/developers/docs/references/scim-api/users/delete-a-user.md)
- Users [Patch a user](https://contentful.com/developers/docs/references/scim-api/users/patch-a-user.md)
- Users [Get all users](https://contentful.com/developers/docs/references/scim-api/users/get-all-users.md)
- Users [Create a user](https://contentful.com/developers/docs/references/scim-api/users/create-a-user.md)

## OpenAPI Specification

The raw OpenAPI 3.1 specification for this API is available at:
- [OpenAPI JSON](https://contentful.com/developers/docs/openapi.json)
- [OpenAPI YAML](https://contentful.com/developers/docs/openapi.yaml)