v1

latestOpenAPI 3.1.0Apache 2.02026-07-245981,1853.0 MB

SCIM Schemas V3

Get List of Supported SCIM Schemas

Use this API to retrieve a list of schemas supported by SCIM 2.0 specifications. The response will include a collection of attributes that describe the contents of SCIM resources (i.e. User and Group). The attribute definitions specify the name of the attribute, metadata such as type (string, binary), cardinality (singular, multi, complex), mutability, and returnability. 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 Legacy SCIM Integration that leverages SCIM groups, which are unique role-organization combinations that each represent a specific role within a particular organization. For more information, see Legacy SCIM User Provisioning.

get/api/scim/v3/Schemas

Response

List of schemas 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"
      }
    }
  ]
}