Get SCIM Schemas

GET /Schemas

Returns available fields for each schema, including the attributes of the User that we support. The supported attributes include:

  • userName: A unique identifier for the User, required for authentication.
  • name: The components of the user's real name, which includes both givenName and familyName, and can be returned as a full name or individual components.
  • externalId: The provider unique ID of a SCIM resource.
  • title: The user's title, such as 'Vice President'.
  • timezone: The User's time zone in the 'Olson' time zone database format.
  • active: A Boolean indicating the User's administrative status.
  • emails: Only one email address is supported, which must be of type 'work'.

Responses

GET /Schemas 
curl \
 -X GET https://setup.adra.com/api/organizations/{organizationSid}/scim/Schemas
Response examples (200) 
{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "Resources": [
    {
      "id": "urn:ietf:params:scim:schemas:core:2.0:User",
      "name": "User",
      "attributes": [
        {
          "name": "id",
          "type": "string",
          "required": false,
          "caseExact": false,
          "mutability": "readOnly",
          "uniqueness": "server",
          "description": "Unique identifier for the SCIM resource as defined by the Service Provider.",
          "multiValued": false
        }
      ],
      "description": "SCIM core resource for representing users"
    }
  ],
  "startIndex": 1,
  "itemsPerPage": 6,
  "totalResults": 6
}