Skip to main content

Overview

How to use the user API to synchronize user data

The Proactis user API offers several endpoints to create, update, delete or retrieve user details and department master roles.

SCIM 2.0​

Proactis user API uses the SCIM 2.0 standard. SCIM's standardized approach to identity management helps ensure interoperability across different systems and simplifies the integration of identity-related functionalities in diverse applications. Keep in mind that the exact details of the implementation may vary based on the SCIM version and the specific identity provider or service being used.

We suggest you refer to the System for Cross-domain Identity Management website to learn more. Sample messages including annotation can be found on the sample messages page.

Users​

The SCIM user API is a set of RESTful web services that enable the creation, modification, retrieval, and deletion of user accounts in/from Proactis. Proactis user API facilitates the following key actions:

Create Users​

The SCIM user API allows you to create new user accounts. Clients can send a POST request to the appropriate endpoint with a JSON representation of the user data, adhering to the SCIM user schema. This operation is typically used when a new user needs to be added to Proactis.

Retrieve Users​

Users can be retrieved from Proactis by sending a GET request to the user endpoint. This request can include parameters to filter or paginate the results. The response contains a JSON representation of the user data.

Modify Users​

The SCIM user API supports the modification of user attributes. Clients can send either a PATCH or PUT request to update specific attributes of a user. This is useful when, for example, a user's information needs to be updated due to a change in their profile.

Delete Users​

User accounts can be deleted by sending a DELETE request to the user endpoint with the user's unique identifier. This operation removes the user from Proactis. This will only apply to users who have not created or own data in Proactis.

Groups​

The SCIM groups API is a set of RESTful web services that facilitates the management of Department Master roles (groups) within Proactis. Similar to the SCIM User API, the SCIM groups API provides standardized endpoints and operations for creating, retrieving, updating, and deleting groups. The following key actions are supported:

Create Groups​

Clients can use the SCIM groups API to create new Department Master roles (group) by sending a POST request to the appropriate endpoint. The request includes a JSON representation of the group data, adhering to the SCIM group schema. This operation is typically used when a new group needs to be added to Proactis.

Retrieve Groups​

Groups can be retrieved from Proactis by sending a GET request to the group endpoint. Clients can use query parameters to filter or paginate the results. The response contains a JSON representation of the group data.

Modify Groups​

The SCIM groups API supports the modification of group attributes. Clients can send either a PATCH or PUT request to update specific attributes of a group. This is useful when changes need to be made to the group's properties or membership.

Delete Groups​

Group removal is accomplished by sending a DELETE request to the group endpoint with the group's unique identifier. This operation removes the group from Proactis.

Contents