Users

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.

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

User

Get a user

Update a user with PUT

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

Updates attributes of the user.

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

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

It is possible to filter by the userName eq filter, passing a valid user email address as the value. See the Filtering section in the SCIM 2.0 specification for details.

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

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.