Use this call to obtain the supported attributes for resources (*e.g.,* User) and the attribute meta-data.
Method and endpoint
GET
/Schemas
Curl example
curl -X GET https://api.anaplan.com/scim/1/0/v2/Schemas
Response
Below is a sample response. Use the actual SCIM API request to determine the Attribute Meta Data used by the API. The response is presented in application/json.
HTTP/1.1 200 OK
Content-Type: application/scim+json
Location: https://api.anaplan.com/scim/1/0/v2/Schemas
{
"schemas":[
"urn:ietf:params:scim:api:messages:2.0:ListResponse"
],
"totalResults":1,
"startIndex":1,
"itemsPerPage":50,
"Resources":[
{
"meta":{
"resourceType":"Schema",
"location":"/1/0/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:User"
},
"id":"urn:ietf:params:scim:schemas:core:2.0:User",
"name":"User",
"description":"User Account",
"attributes":[
{
"name":"id",
"type":"string",
"multiValued":false,
"description":"Unique identifier for a user by Service Provider. Note - CaseExact=false which is not per RFC.",
"required":true,
"caseExact":false,
"mutability":"readOnly",
"returned":"always",
"uniqueness":"server"
},
{
"name":"externalId",
"active": "True",
"type":"string",
"multiValued":false,
"description":"Unique Identifider for a user as defined by provisioning client. Note - CaseExact=false which is not per RFC.",
"required":false,
"caseExact":false,
"mutability":"readWrite",
"returned":"default",
"uniqueness":"none"
},
{
"name":"userName",
"type":"string",
"multiValued":false,
"description":"Username of the User. It is a Required attribute and uniquely identifies a User",
"required":true,
"caseExact":false,
"mutability":"readOnly",
"returned":"default",
"uniqueness":"server"
},
{
"name":"name",
"type":"complex",
"subAttributes":[
{
"name":"familyName",
"type":"string",
"multiValued":false,
"description":"Family name of the User",
"required":true,
"caseExact":false,
"mutability":"readWrite",
"returned":"default",
"uniqueness":"none"
},
{
"name":"givenName",
"type":"string",
"multiValued":false,
"description":"Given name of the User",
"required":true,
"caseExact":false,
"mutability":"readWrite",
"returned":"default",
"uniqueness":"none"
},
{
"name":"formatted",
"type":"string",
"multiValued":false,
"description":"Formatted name of the User",
"required":false,
"caseExact":false,
"mutability":"readOnly",
"returned":"default",
"uniqueness":"none"
}
],
"multiValued":false,
"description":"Components of users real name",
"required":true,
"caseExact":false,
"mutability":"readWrite",
"returned":"default",
"uniqueness":"none"
},
{
"name":"displayName",
"type":"string",
"multiValued":false,
"description":"Display Name of the User. It is generated by concatenating givenName and familyName.",
"required":false,
"caseExact":false,
"mutability":"readOnly",
"returned":"default",
"uniqueness":"none"
},
{
"name":"active",
"type":"boolean",
"multiValued":false,
"description":"Used to manage whether user can log into Anaplan system or not",
"required":false,
"caseExact":false,
"mutability":"readWrite",
"returned":"default",
"uniqueness":"none"
},
{
"name":"entitlements",
"type":"complex",
"multiValued":true,
"description":"A list of entitlements for the User that represents a thing (such as WORKSPACE) the User has.",
"required":false,
"caseExact":false,
"mutability":"readWrite",
"returned":"default",
"uniqueness":"none"
"subAttributes":[
{
"name":"value",
"type":"string",
"multiValued":false,
"description":"The target resourceId of an entitlement. e.g. a WorkspaceId",
"required":false,
"caseExact":false,
"mutability":"readWrite",
"returned":"default",
"uniqueness":"none"
},
{
"name":"display",
"type":"string",
"multiValued":false,
"description":"A human-readable name for the entitlement. e.g. a Workspace 'name',
"required":false,
"caseExact":false,
"mutability":"readWrite",
"returned":"default",
"uniqueness":"none"
},
{
"name":"type",
"type":"string",
"multiValued":false,
"description":"The type of entitlement. e.g. WORKSPACE",
"required":false,
"caseExact":false,
"mutability":"readOnly",
"returned":"default",
"uniqueness":"none"
},
{
"name":"primary",
"type":"boolean",
"multiValued":false,
"description":"A Boolean value indicating the 'primary' or preferred attribute value for this attribute. The primary attribute value 'true' MUST appear no more than once.",
"required":false,
"caseExact":false,
"mutability":"readOnly",
"returned":"default",
"uniqueness":"none"
}
],
}
]
}
]
}
