---
id: get-schema-by-id
sidebar_label: Returns a Schema based on id.
hide_title: true
hide_table_of_contents: true
api: {"operationId":"getSchemaById","tags":["Schemas"],"description":"The Schema with the matching id is returned. The id is the URN of the SCIM resource. The 'attributes' field holds the schema-specific attributes which differ depending on Schema type.","parameters":[{"name":"schemaId","in":"path","schema":{"type":"string"},"description":"The id of the Schema.","required":true}],"responses":{"200":{"description":"Returns a single Schema based on the id.","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"description":"The id of the Schema. The id is the SCIM URN of the Schema.","type":"string","example":"urn:ietf:params:scim:schemas:sailpoint:1.0:User"},"name":{"description":"Name of the Schema.","type":"string","example":"User"},"description":{"description":"Description of the Schema.","type":"string","example":"Schema for a SCIM User."},"attributes":{"description":"Attributes used to describe this Schema.","type":"array","items":{"properties":{"uniqueness":{"description":"Determines whether there can be other Schema resources with the same value for this attribute. 'none' means there is no concern for uniqueness, 'server' means the uniqueness of this attribute should be guaranteed for this type of resource, and 'global' means the uniqueness should be guaranteed across all resources.","type":"string","example":"none"},"name":{"description":"Name of the attribute.","type":"string","example":"displayName"},"description":{"description":"Description of the attribute.","type":"string","example":"Display name of the User."},"mutability":{"description":"Indicates the ability to change this attribute. Possible values are 'readOnly', 'readWrite', and 'writeOnly'.","type":"string","example":"readOnly"},"type":{"description":"Defined as 'simple' or 'complex', where simple indicates attribute values stored as strings, integers, etc., and complex indicates object-based values.","type":"string","example":"string"},"multiValued":{"description":"Describes whether this attribute is allowed multiple values.","type":"boolean","example":false},"caseExact":{"description":"True if attribute value is case-sensitive; false otherwise.","type":"boolean","example":false},"returned":{"description":"Dictates whether the attribute should be returned in a SCIM response body. Can be 'always', 'default', 'request', or 'never'.","type":"string","example":"default"},"required":{"description":"True if this attribute is required for this Schema; false otherwise.","type":"boolean","example":false},"canonicalValues":{"description":"List of canonical values that could be used to supplement attribute.","type":"array","items":{"type":"string"},"example":["httpbasic","httpdigest","oauth"]},"subAttributes":{"description":"Only required if 'complex' is specified for 'type'. If this attribute is of 'complex' type, an array of objects can be stored in 'subAttributes' with attributes relevant to the respective Schema.","type":"array","items":{"additionalProperties":{"anyOf":[{"type":"object"}]}}}}}},"meta":{"description":"Metadata of the Schema.","type":"object","properties":{"location":{"description":"The location of the Schema.","type":"string","example":"http://localhost:8080/iiq/scim/v2/Schemas/7f0123417e941b00007f9db3702906cb"},"version":{"description":"The version of the Schema.","type":"string","example":"W\"1647617443639\""},"resourceType":{"description":"The SCIM resource type.","type":"string","example":"Schema"}}},"schemas":{"description":"The schema for the Schema resource.","type":"array","items":{"type":"string"},"example":["urn:ietf:params:scim:schemas:core:2.0:Schema"]}}}}}}},"method":"get","path":"/Schemas/{schemaId}","servers":[{"url":"http://localhost:8080/identityiq/scim/v2","description":"IdentityIQ SCIM server basepath and path to API."}],"security":[{"basicAuth":[]}],"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic"}},"info":{"description":"IdentityIQ REST Endpoint Interface Documentation for SCIM\n","version":"8.3","title":"IdentityIQ SCIM REST API"},"postman":{"name":"Returns a Schema based on id.","description":{"content":"The Schema with the matching id is returned. The id is the URN of the SCIM resource. The 'attributes' field holds the schema-specific attributes which differ depending on Schema type.","type":"text/plain"},"url":{"path":["Schemas",":schemaId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"disabled":false,"description":{"content":"(Required) The id of the Schema.","type":"text/plain"},"type":"any","value":"","key":"schemaId"}]},"header":[{"key":"Accept","value":"application/json"}],"method":"GET"}}
sidebar_class_name: "get api-method"
info_path: iiq/api/identityiq-scim-rest-api
custom_edit_url: "https://github.com/sailpoint-oss/developer.sailpoint.com/issues/new?assignees=&labels=&template=bug-report.md&title=%5BBug%5D+Your+Bug+Report+Here Requesting changes to 'Returns a Schema based on id.' (get-schema-by-id)"
---

import ApiTabs from "@theme/ApiTabs";
import MimeTabs from "@theme/MimeTabs";
import ParamsItem from "@theme/ParamsItem";
import ResponseSamples from "@theme/ResponseSamples";
import SchemaItem from "@theme/SchemaItem";
import SchemaTabs from "@theme/SchemaTabs";
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
import TabItem from "@theme/TabItem";

## Returns a Schema based on id.



The Schema with the matching id is returned. The id is the URN of the SCIM resource. The 'attributes' field holds the schema-specific attributes which differ depending on Schema type.

<details style={{"marginBottom":"1rem"}} data-collapsed={false} open={true}><summary style={{}}><strong>Path Parameters</strong></summary><div><ul><ParamsItem className={"paramsItem"} param={{"name":"schemaId","in":"path","schema":{"type":"string"},"description":"The id of the Schema.","required":true}}></ParamsItem></ul></div></details><div><ApiTabs><TabItem label={"200"} value={"200"}><div>

Returns a single Schema based on the id.

</div><div><MimeTabs schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs><TabItem label={"Schema"} value={"Schema"}><details style={{}} data-collapsed={false} open={true}><summary style={{"textAlign":"left"}}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} deprecated={undefined} schemaDescription={"The id of the Schema. The id is the SCIM URN of the Schema."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} deprecated={undefined} schemaDescription={"Name of the Schema."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} deprecated={undefined} schemaDescription={"Description of the Schema."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>attributes</strong><span style={{"opacity":"0.6"}}> undefined[]</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Attributes used to describe this Schema.

</div><SchemaItem collapsible={false} name={"uniqueness"} required={false} deprecated={undefined} schemaDescription={"Determines whether there can be other Schema resources with the same value for this attribute. 'none' means there is no concern for uniqueness, 'server' means the uniqueness of this attribute should be guaranteed for this type of resource, and 'global' means the uniqueness should be guaranteed across all resources."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"name"} required={false} deprecated={undefined} schemaDescription={"Name of the attribute."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} deprecated={undefined} schemaDescription={"Description of the attribute."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"mutability"} required={false} deprecated={undefined} schemaDescription={"Indicates the ability to change this attribute. Possible values are 'readOnly', 'readWrite', and 'writeOnly'."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"type"} required={false} deprecated={undefined} schemaDescription={"Defined as 'simple' or 'complex', where simple indicates attribute values stored as strings, integers, etc., and complex indicates object-based values."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"multiValued"} required={false} deprecated={undefined} schemaDescription={"Describes whether this attribute is allowed multiple values."} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"caseExact"} required={false} deprecated={undefined} schemaDescription={"True if attribute value is case-sensitive; false otherwise."} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"returned"} required={false} deprecated={undefined} schemaDescription={"Dictates whether the attribute should be returned in a SCIM response body. Can be 'always', 'default', 'request', or 'never'."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"required"} required={false} deprecated={undefined} schemaDescription={"True if this attribute is required for this Schema; false otherwise."} schemaName={"boolean"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"canonicalValues"} required={false} deprecated={undefined} schemaDescription={"List of canonical values that could be used to supplement attribute."} schemaName={"string[]"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"subAttributes"} required={false} deprecated={undefined} schemaDescription={"Only required if 'complex' is specified for 'type'. If this attribute is of 'complex' type, an array of objects can be stored in 'subAttributes' with attributes relevant to the respective Schema."} schemaName={"undefined[]"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}}><summary style={{}}><strong>meta</strong><span style={{"opacity":"0.6"}}> object</span></summary><div style={{"marginLeft":"1rem"}}><div style={{"marginTop":".5rem","marginBottom":".5rem"}}>

Metadata of the Schema.

</div><SchemaItem collapsible={false} name={"location"} required={false} deprecated={undefined} schemaDescription={"The location of the Schema."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"version"} required={false} deprecated={undefined} schemaDescription={"The version of the Schema."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem><SchemaItem collapsible={false} name={"resourceType"} required={false} deprecated={undefined} schemaDescription={"The SCIM resource type."} schemaName={"string"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"schemas"} required={false} deprecated={undefined} schemaDescription={"The schema for the Schema resource."} schemaName={"string[]"} qualifierMessage={undefined} defaultValue={undefined}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"id\": \"urn:ietf:params:scim:schemas:sailpoint:1.0:User\",\n  \"name\": \"User\",\n  \"description\": \"Schema for a SCIM User.\",\n  \"attributes\": [\n    {\n      \"uniqueness\": \"none\",\n      \"name\": \"displayName\",\n      \"description\": \"Display name of the User.\",\n      \"mutability\": \"readOnly\",\n      \"type\": \"string\",\n      \"multiValued\": false,\n      \"caseExact\": false,\n      \"returned\": \"default\",\n      \"required\": false,\n      \"canonicalValues\": [\n        \"httpbasic\",\n        \"httpdigest\",\n        \"oauth\"\n      ],\n      \"subAttributes\": [\n        null\n      ]\n    }\n  ],\n  \"meta\": {\n    \"location\": \"http://localhost:8080/iiq/scim/v2/Schemas/7f0123417e941b00007f9db3702906cb\",\n    \"version\": \"W\\\"1647617443639\\\"\",\n    \"resourceType\": \"Schema\"\n  },\n  \"schemas\": [\n    \"urn:ietf:params:scim:schemas:core:2.0:Schema\"\n  ]\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem></ApiTabs></div>