--- updatedAt: 2026-05-27T12:54:01.000Z agentTools: projectIndex: https://developer.onetrust.com/onetrust/llms.txt --- # 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](https://my.onetrust.com/s/article/UUID-abda73a7-4996-c1b4-2e2a-e46aa3f2a3cc). # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Platform - User Provisioning", "description": "OneTrust supports cross-domain identity management through the SCIM 2.0 specification. System for Cross-Domain Identity Management (SCIM) is an open specification to help facilitate the automated management of user identities and groups in cloud applications using RESTful APIs. This allows organizations to manage and update user information and group information across domains and applications.", "version": "1.0", "contact": { "name": "OneTrust Support", "url": "https://my.onetrust.com/s/contactsupport" }, "license": { "name": "Apache 2.0", "url": "https://www.apache.org/licenses/LICENSE-2.0" } }, "servers": [ { "url": "https://{hostname}", "variables": { "hostname": { "default": "hostname", "description": "The OneTrust hostname such as app.onetrust.com, app-eu.onetrust.com, app-de.onetrust.com, app-uk.onetrust.com, app-apac.onetrust.com, trial.onetrust.com, or uat.onetrust.com." } } } ], "tags": [ { "name": "SCIM Schemas V3", "description": "V3 version APIs to manager Schemas.", "externalDocs": { "description": "OpenAPI 3.1.0 - Download Definition", "url": "https://developer.onetrust.com/onetrust/openapi/platform-user-provisioning.json" } } ], "x-onetrust": { "spec-label": "OpenAPI 3.1.0", "links": [ "{'SCIM User & Group Provisioning': 'https://my.onetrust.com/s/article/UUID-93f936ef-8076-280c-a58e-ba2d3437dfad?topicId=0TO1Q000000ItSxWAK'}" ] }, "x-readme": { "explorer-enabled": false, "proxy-enabled": false, "metrics-enabled": false }, "paths": { "/api/scim/v3/Schemas/{schemaName}": { "get": { "operationId": "getSchemasByNameUsingGET", "summary": "Get SCIM Schema", "description": "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.\n\n> 🗒 Things to Know\n>\n> - 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](https://my.onetrust.com/s/article/UUID-abda73a7-4996-c1b4-2e2a-e46aa3f2a3cc).\n", "tags": [ "SCIM Schemas V3" ], "x-onetrust": { "spec-label": "https://developer.onetrust.com/onetrust/openapi/platform-user-provisioning.json" }, "parameters": [ { "name": "schemaName", "in": "path", "description": "The name of the schema to retrieve. This identifies a specific schema supported by SCIM 2.0 specifications that describes the\ncontents of SCIM resources (i.e. User and Group). The schema name can be obtained using the\n[Get List of Supported SCIM Schemas](/onetrust/reference/getschemasusingget) API.\n", "required": true, "schema": { "type": "string", "enum": [ "urn:ietf:params:scim:schemas:core:2.0:User", "urn:ietf:params:scim:schemas:core:2.0:Group", "urn:ietf:params:scim:schemas:onetrust:Group", "urn:ietf:params:scim:schemas:extension:enterprise:2.0:User" ], "maxLength": 255, "minLength": 1 }, "example": "urn:ietf:params:scim:schemas:core:2.0:Group" } ], "responses": { "200": { "description": "Schema retrieved successfully", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/SchemaResource" } } } }, "400": { "description": "Bad Request" }, "401": { "description": "Unauthorized" }, "403": { "description": "Forbidden" }, "429": { "description": "Too Many Requests. \nFor more information, see [API Rate Limits](https://developer.onetrust.com/onetrust/reference/rate-limits-overview).", "headers": { "Retry-After": { "schema": { "description": "The number of seconds after which requests will be allowed again.", "format": "int32" } }, "ot-period": { "schema": { "description": "The unit of time for which the rate limit applies", "enum": [ "HOUR", "MINUTE" ] } }, "ot-ratelimit-event-id": { "schema": { "description": "The unique identifier for the rate-limiting event.", "format": "uuid" } }, "ot-request-made": { "schema": { "description": "The number of requests made within the specified period.", "format": "int32" } }, "ot-requests-allowed": { "schema": { "description": "The number of requests allowed within the specified period.", "format": "int32" } } } }, "500": { "description": "Internal Server Error" } }, "security": [ { "OAUTH2": [ "SCIM" ] } ] } } }, "components": { "schemas": { "Meta": { "type": "object", "properties": { "created": { "description": "The date and time when the resource was created", "type": "string", "format": "date-time", "example": "2022-05-27T15:28:14.298Z" }, "lastModified": { "description": "The date and time when the resource was last modified", "type": "string", "format": "date-time", "example": "2022-05-27T15:28:14.298Z" }, "location": { "description": "The URL for the resource", "type": "string", "format": "uri", "example": "/api/scim/v3/Users/53b1325c-081f-4f05-b41b-ba8cbdb7bae9", "maxLength": 2083, "minLength": 1 }, "version": { "description": "The version of the resource", "type": "string", "example": "W/\"f0f2a936\"", "maxLength": 100, "minLength": 1 }, "attributes": { "type": "array", "items": { "description": "The set of attributes", "example": [ "active", "emails", "userName" ] }, "uniqueItems": true }, "resourceType": { "description": "The resource type", "type": "string", "example": "Group", "enum": [ "User", "Group", "ResourceType", "ServiceProviderConfig", "Schema" ], "maxLength": 100, "minLength": 1 } }, "readOnly": true, "title": "Meta" }, "SchemaResource": { "type": "object", "properties": { "id": { "description": "Unique identifier of the schema", "type": "string", "format": "uuid", "example": "b430e8b1-748a-4f03-aa18-d32a79a3fae8" }, "name": { "description": "Name of the schema", "type": "string", "example": "User", "enum": [ "User", "Group", "OneTrustGroup", "EnterpriseUser" ] }, "description": { "description": "Description of the schema", "type": "string", "example": "User schema representation" }, "attributes": { "type": "array", "items": { "type": "object", "description": "Attribute definition", "example": { "name": "name", "type": "string", "schema": "urn:ietf:params:scim:schemas:core:2.0", "subAttributes": [] } } }, "meta": { "description": "Metadata about the schema", "example": { "resourceType": "User" }, "$ref": "#/components/schemas/Meta", "readOnly": true } }, "required": [ "attributes", "description", "id", "meta", "name" ] } }, "securitySchemes": { "OAUTH2": { "type": "oauth2", "flows": { "clientCredentials": { "tokenUrl": "https://{hostname}/api/access/v1/oauth/token", "scopes": { "SCIM": "Grants full access to the SCIM APIs for User Provisioning. This includes all the endpoints under Users, Groups, Resources, Schemas and Service Provider." } } } } } } } ``` # Sibling pages * [Get List of Supported SCIM Schemas](https://developer.onetrust.com/onetrust/reference/getschemasusingget.md)