Get Schema by ID

Description: Returns a specific SCIM schema definition by its ID. SCIM schemas define the structure of SCIM resources, such as User and Group.

Since: Artifactory <version>

Security: Requires a valid Bearer token with the SCIM_PERMISSION_SCOPE_READ permission.

Usage: GET /access/api/v1/scim/v2/Schemas/<schemaID>

Produces: application/scim+json; charset=UTF-8

Sample Request (User schema):

GET /access/api/v1/scim/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:User HTTP/1.2
Host: <your-server>
Authorization: Bearer <access_token>
Accept: application/scim+json

Sample Request (Group schema):

GET /access/api/v1/scim/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:Group HTTP/1.2
Host: <your-server>
Authorization: Bearer <access_token>
Accept: application/scim+json

Sample Response (User schema):

200- OK

{
   "id": "urn:ietf:params:scim:schemas:core:2.0:User",
   "name": "User",
   "description": "User Account",
   "attributes": [
       {
           "name": "id",
           "type": "string",
           "description": "Unique identifier for the user (same as userName)",
           "required": true,
           "multiValued": false,
           "mutability": "readOnly",
           "returned": "always",
           "uniqueness": "server",
           "caseExact": false
       },
       {
           "name": "schemas",
           "type": "string",
           "description": "SCIM schemas for the user",
           "required": true,
           "multiValued": true,
           "mutability": "readOnly",
           "returned": "always",
           "uniqueness": "none",
           "caseExact": true
       },
       {
           "name": "userName",
           "type": "string",
           "description": "The username of the user",
           "required": true,
           "multiValued": false,
           "mutability": "readWrite",
           "returned": "default",
           "uniqueness": "server",
           "caseExact": false
       },
       {
           "name": "active",
           "type": "boolean",
           "description": "Whether the user is active (maps to UserStatus.ENABLED/DISABLED)",
           "required": false,
           "multiValued": false,
           "mutability": "readWrite",
           "returned": "default",
           "uniqueness": "none"
       },
       {
           "name": "emails",
           "type": "complex",
           "description": "Email addresses for the user",
           "required": false,
           "multiValued": true,
           "mutability": "readWrite",
           "returned": "default",
           "uniqueness": "none",
           "subAttributes": [
               {
                   "name": "value",
                   "type": "string",
                   "description": "The email address value",
                   "required": false,
                   "multiValued": false,
                   "mutability": "readWrite",
                   "returned": "default",
                   "uniqueness": "none",
                   "caseExact": false
               },
               {
                   "name": "type",
                   "type": "string",
                   "description": "Type of email address (defaults to 'work')",
                   "required": false,
                   "multiValued": false,
                   "mutability": "readWrite",
                   "returned": "default",
                   "uniqueness": "none",
                   "caseExact": false,
                   "canonicalValues": [
                       "work",
                       "home",
                       "other"
                   ]
               },
               {
                   "name": "primary",
                   "type": "boolean",
                   "description": "Primary email indicator",
                   "required": false,
                   "multiValued": false,
                   "mutability": "readWrite",
                   "returned": "default",
                   "uniqueness": "none"
               }
           ]
       },
       {
           "name": "groups",
           "type": "complex",
           "description": "Groups this user is associated with",
           "required": false,
           "multiValued": true,
           "mutability": "readOnly",
           "returned": "default",
           "uniqueness": "none",
           "subAttributes": [
               {
                   "name": "value",
                   "type": "string",
                   "description": "The identifier of the user's group",
                   "required": false,
                   "multiValued": false,
                   "mutability": "readOnly",
                   "returned": "default",
                   "uniqueness": "none",
                   "caseExact": false
               }
           ]
       },
       {
           "name": "meta",
           "type": "complex",
           "description": "Resource metadata",
           "required": false,
           "multiValued": false,
           "mutability": "readOnly",
           "returned": "default",
           "uniqueness": "none",
           "subAttributes": [
               {
                   "name": "resourceType",
                   "type": "string",
                   "description": "The type of resource (always 'User')",
                   "required": false,
                   "multiValued": false,
                   "mutability": "readOnly",
                   "returned": "default",
                   "uniqueness": "none",
                   "caseExact": true
               }
           ]
       }
   ],
   "meta": {
       "resourceType": "Schema",
       "location": "/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:User"
   }
}

Sample Response (Group schema):

200- OK

{
   "id": "urn:ietf:params:scim:schemas:core:2.0:Group",
   "name": "Group",
   "description": "Group resource",
   "attributes": [
       {
           "name": "id",
           "type": "string",
           "description": "Unique identifier for the group (same as displayName)",
           "required": true,
           "multiValued": false,
           "mutability": "readOnly",
           "returned": "always",
           "uniqueness": "server",
           "caseExact": false
       },
       {
           "name": "schemas",
           "type": "string",
           "description": "SCIM schemas for the group",
           "required": true,
           "multiValued": true,
           "mutability": "readOnly",
           "returned": "always",
           "uniqueness": "none",
           "caseExact": true
       },
       {
           "name": "displayName",
           "type": "string",
           "description": "A human-readable name for the group",
           "required": true,
           "multiValued": false,
           "mutability": "readWrite",
           "returned": "default",
           "uniqueness": "server",
           "caseExact": false
       },
       {
           "name": "description",
           "type": "string",
           "description": "Description of the group",
           "required": false,
           "multiValued": false,
           "mutability": "readWrite",
           "returned": "default",
           "uniqueness": "none",
           "caseExact": false
       },
       {
           "name": "members",
           "type": "complex",
           "description": "Members of the group",
           "required": false,
           "multiValued": true,
           "mutability": "readWrite",
           "returned": "default",
           "uniqueness": "none",
           "subAttributes": [
               {
                   "name": "value",
                   "type": "string",
                   "description": "The unique identifier of the user (userId)",
                   "required": false,
                   "multiValued": false,
                   "mutability": "readWrite",
                   "returned": "default",
                   "uniqueness": "none",
                   "caseExact": false
               },
               {
                   "name": "display",
                   "type": "string",
                   "description": "A human-readable name for the user (displayName)",
                   "required": false,
                   "multiValued": false,
                   "mutability": "readWrite",
                   "returned": "default",
                   "uniqueness": "none",
                   "caseExact": false
               }
           ]
       },
       {
           "name": "meta",
           "type": "complex",
           "description": "Resource metadata",
           "required": false,
           "multiValued": false,
           "mutability": "readOnly",
           "returned": "default",
           "uniqueness": "none",
           "subAttributes": [
               {
                   "name": "resourceType",
                   "type": "string",
                   "description": "The type of resource (always 'Group')",
                   "required": false,
                   "multiValued": false,
                   "mutability": "readOnly",
                   "returned": "default",
                   "uniqueness": "none",
                   "caseExact": true
               }
           ]
       }
   ],
   "meta": {
       "resourceType": "Schema",
       "location": "/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:Group"
   }
}

Error Response Codes: