Get SCIM Schema
Use this API to retrieve details of a specific schema supported by SCIM 2.0 specifications. The response will include a collection of attributes that describe the contents of the specified SCIM resource. 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.
Path parameters
The name of the schema to retrieve. This identifies a specific schema supported by SCIM 2.0 specifications that describes the contents of SCIM resources (i.e. User and Group). The schema name can be obtained using the Get List of Supported SCIM Schemas API.
Response
Schema retrieved successfully
Example response
{
"id": "b430e8b1-748a-4f03-aa18-d32a79a3fae8",
"name": "User",
"description": "User schema representation",
"attributes": [
{
"name": "name",
"type": "string",
"schema": "urn:ietf:params:scim:schemas:core:2.0",
"subAttributes": []
}
],
"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"
}
}