Get List of Users

Use this API to retrieve a paginated list of users and user profile details.

Example Request

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

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

Using 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 a few example requests using SCIM filters:

  • GET https://trial.onetrust.com/api/scim/v2/Users/?filter=givenName sw 'John'
  • GET https://trial.onetrust.com/api/scim/v2/Users/?filter=familyName sw 'Doe'
  • GET https://trial.onetrust.com/api/scim/v2/Users/?filter=email sw 'user'
  • GET https://trial.onetrust.com/api/scim/v2/Users/?filter=id sw 'c77'
  • GET https://trial.onetrust.com/api/scim/v2/Users/?filter=externalId sw '00u1'
  • GET https://trial.onetrust.com/api/scim/v2/Users/?filter=userType eq 'External'
  • GET https://trial.onetrust.com/api/scim/v2/Users/?filter=emails co 'domain.com'
Language
Authorization
OAuth2