Get List of Users

Leverage this API to retrieve a paginated list of user records from the OneTrust application.

OneTrust supports provisioning and management of users from your Identity Provider using the system for Cross-Domain Identity Management (SCIM) standard. Ensure your Identity Provider supports SCIM standards. For more information, please refer to SCIM User & Group Provisioning.

Example Request

GET https://{hostname}/api/scim/v3/Users

GET https://trial.onetrust.com/api/scim/v3/Users?startIndex=1&count=1000

📘

SCIM Filters

OneTrust supports SCIM filters to identify specific users.

• Filters can be applied on id, externalId, email, emails, givenName, familyName, and userType attributes.
• The supported logical operators are eq (equal), co (contains), sw (starts with), gt (greater than), ge (greater than or equal to), lt (less than), le (less than or equal to).

Below are some example requests using SCIM filters:

• GET https://trial.onetrust.com/api/scim/v3/Users/?filter=givenName sw "George"

• GET https://trial.onetrust.com/api/scim/v3/Users/?filter=familyName sw "Burdell"

• GET https://trial.onetrust.com/api/scim/v3/Users/?filter=email sw "gpburdell"

• GET https://trial.onetrust.com/api/scim/v3/Users/?filter=id sw "8675"

• GET https://trial.onetrust.com/api/scim/v3/Users/?filter=externalId sw "gt01"

• GET https://trial.onetrust.com/api/scim/v3/Users/?filter=userType eq "External"

• GET https://trial.onetrust.com/api/scim/v3/Users/?filter=emails co "onetrust.com"