Sign in

v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB
Users V3

Get List of Users

Use this API to retrieve a list of users along with user details such as the created date, last modified date, name, and email. This API should only be used when provisioning and managing users from your Identity Provider using the System for Cross-Domain Identity Management (SCIM) standard to facilitate the automated creation of user identities from a third-party identity management application.

🗒 Things to Know

  • This API supports OneTrust's Enhanced SCIM Integration that leverages Group Provisioning to manage access for users by provisioning them to one or more user groups. For more information, see SCIM User & Group Provisioning.
  • The response will always return the following values for roles and organization: "roles": [] and "organization": null.
  • OneTrust supports the use of SCIM filters to identify specific users:
  • Filters can be applied on the id, externalId, email, emails, givenName, familyName, userType, and active 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), and le (less than or equal to).
  • The filter query parameter is applied in the following format: attribute operator "value". For example, emails co "onetrust.com" would return a list of user records that contain emails with the onetrust.com domain.
get/api/scim/v3/Users

Query parameters

startIndexstring

Starting value of the response.

countstring

The number of entries to be returned in the response.

filterstring

The search filter to apply to the search criteria. For example, emails co "onetrust.com" would return a list of user records that contain emails with the onetrust.com domain.

Response

OK

Users retrieved successfully.

schemasstring[]
totalResultsinteger

The total number of results in the list.

startIndexinteger

TThe starting point of the result list.

itemsPerPageinteger

The number of items per results page.

Example response

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:User"
  ],
  "totalResults": 2,
  "startIndex": 1,
  "itemsPerPage": 25,
  "Resources": [
    {
      "id": "aeb3d45d-0c05-4ff0-b635-6e3c3b2f86ea",
      "externalId": "3PNdoRZES0GLfV+9y1dDwQ==",
      "meta": {
        "created": "2022-05-27T15:28:14.298Z",
        "lastModified": "2022-05-27T15:28:14.298Z",
        "location": "/api/scim/v3/Users/53b1325c-081f-4f05-b41b-ba8cbdb7bae9",
        "version": "W/\"f0f2a936\"",
        "attributes": [
          [
            "active",
            "emails",
            "userName"
          ]
        ],
        "resourceType": "Group"
      },
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:Group"
      ],
      "displayName": "Test Group",
      "members": [
        {
          "value": "3da9fe38-7845-4658-a96e-00071fa20c2e",
          "$ref": "/api/scim/v3/Users/1bd418b2-85dd-4f04-955f-e4870e119ef1\""
        }
      ],
      "urn:ietf:params:scim:schemas:onetrust:Group": {
        "category": "HR",
        "description": "HR User Group"
      }
    }
  ]
}