The Idaptive Developer Program

Using SCIM Endpoint Interaction to Manage Users

Provisioning users from a web-based Human Capital Management system to Idaptive

Once a SCIM admin and application are set up, the testing process can begin. API-Testing applications can now update the Idaptive Directory through available SCIM endpoints. This includes:

  • GET: access user information
  • POST: add new users
  • PUT/PATCH: update the information of existing users.
  • DELETE: deletes users

User Endpoints

GET all users

https://{{tenant_id}}.my.idaptive.app/scim/Users?

This endpoint allows you to access information relating to all users of the application. As soon as a user signs up for the Idaptive User Portal, their information is displayed when calling upon the https://{{tenant_id}}.my.idaptive.app/scim/Users? endpoint.

All methods require a header with a bearer token for authentication (retrieved through Actions in your SCIM App Settings) and a tenant ID for navigating to the correct endpoint.

GET one user

https://{{tenant_id}}.my.idaptive.app/scim/Users/{{user_id}}?

Every user has an assigned corresponding user ID. No ID can remain the same. The GET one user method isolates one user's information by navigating to the https://{{tenant_id}}.my.idaptive.app/scim/Users/{{user_id}}? endpoint with a particular user's ID.

Locating a certain user's ID can be done through the GET all users function. When calling upon this method, the response lists all users and their corresponding ID values.

POST one user

https://{{tenant_id}}.my.idaptive.app/scim/Users?

With the POST method, you can add other users with customized information. No configuration is necessary run POST aside from listing the correct header.

POST one user navigates to the Users endpoint in the Admin Portal. After running the method, a new user should appear there.

The POST one user information includes personal information about the user such as the display name, username, password, phone numbers, active status, and language settings. All of these aspects can be easily changed. Additional information regarding the user can be added (such as nickname, formatted name, etc.), although this will not appear in the Admin Portal as listed information.

PUT one user

https://{{tenant_id}}.my.idaptive.app/scim/Users/{{scim_created_id}}?

PUT one user takes a user ID and changes the user's information. Essentially, this request can either update multiple aspects of the user's identity or create a new user altogether. With a PUT request, the server replaces the stored version of the user and changes the user's identity. PUT updates the user by replacing it with a more updated version.

PUT requests edit the same amount of user information as POST requests. You can also list additional information, although it will not be displayed in the Admin Portal.

PATCH one user

https://{{tenant_id}}.my.idaptive.app/scim/Users/{{scim_created_id}}?

The PATCH method is an efficient way to update a user quickly. Rather than updating the entire user with PUT, PATCH edits only a fraction of the user. PATCH navigates to a particular user endpoint and accesses their information there.

You do not have to list the full user information. For example, editing the display name of a user is done by declaring "displayName" : "new display name".

DELETE one user

https://{{tenant_id}}.my.idaptive.app/scim/Users/{{scim_created_id}}

The DELETE one user request deletes a user. When a user's status is inactive for a long time, deleting the user may be a good idea. This request navigates to a particular user with an endpoint containing the user ID.

DELETE one user is the only request that returns no information. Running DELETE twice will receive an error; you cannot delete a user if the user ID no longer exists.

Updated 5 months ago

Using SCIM Endpoint Interaction to Manage Users


Provisioning users from a web-based Human Capital Management system to Idaptive

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.