SCIM 2.0

SCIM 2.0 API

The SCIM 2.0 API allows for automated user and group management inside Psoda.

Headers

All requests must include an API-Key in the header. You can find your API key by logging into your account, going to your “My Stuff” page, clicking the three dot menu, and clicking the “API Key” button. The API key can be passed in two ways:

As a custom API-Key header:

API-Key: your-api-key-here

As a Bearer token in the Authorization header:

Authorization: Bearer your-api-key-here

Additionally, include the following Content-Type header in your requests:

Content-Type: application/scim+json

Note:

The current implementation does not support PATCH operations or filtering. Updates must be performed using a full object replacement.

Azure integration is still being worked on and will be available in the near future.

Endpoints

1. Get User Details – GET /scim/v2/Users/{objectId}

Returns details of a specific user.

2. List All Users – GET /scim/v2/Users

Gets a paginated list of all users in the system.

Query Parameters:

  • startIndex (integer, optional) – The index of the first result to return.
  • pageSize (integer, optional) – The maximum number of results to return.

3. Create a User – POST /scim/v2/Users

Creates a new user with the specified attributes. Field information can be found via the schema request.

4. Update a User – PUT /scim/v2/Users/{objectId}

Updates a user by replacing the full object. Field information can be found via the schema request.

5. Delete a User – DELETE /scim/v2/Users/{objectId}

Deletes a user. In Psoda, this means suspending the user’s account.

6. Get Group Details – GET /scim/v2/Groups/{objectId}

Returns details of a specific group.

7. List All Groups – GET /scim/v2/Groups

Gets a paginated list of all groups.

Query Parameters:

  • startIndex (integer, optional) – The index of the first result to return.
  • pageSize (integer, optional) – The maximum number of results to return.

8. Create a Group – POST /scim/v2/Groups

Creates a new group with specified members. Field information can be found via the schema request.

9. Update a Group – PUT /scim/v2/Groups/{objectId}

Updates a group by replacing the full object. Field information can be found via the schema request.

10. Delete a Group – DELETE /scim/v2/Groups/{objectId}

Deletes a group from the Psoda.

11. Get Schema Details – GET /scim/v2/Schemas/{schemaId}

Returns details of a specific SCIM schema.

12. List All Schemas – GET /scim/v2/Schemas

Gets a list of all available SCIM schemas in the system.

Related Topics