IRironcladapp
Schemas

Retrieve a Schema

Documentation on retrieving a schema via SCIM.

OAuth Scope required: scim.schemas.readSchemas

get/Schemas/{schemaId}

Request

  • Base URL
    https://ironcladapp.com/scim/v2
  • URL
    https://ironcladapp.com/scim/v2/Schemas/{schemaId}
  • Auth
    API key in header Authorization

Path parameters

schemaIdstring required

A schema's unique id can be identified using the Retrieve all Schemas endpoint

Headers

x-as-user-emailstring
Example:jane.doe@test.com

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-id is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. A token produced from the Authorization Code grant (which is already scoped to a user) may also use this header to act as a different user in the same company, provided the token carries the identity.users.impersonate scope and the token's own user has been granted the API User Impersonation permission. A request that sends this header without both never acts as the named user; depending on the company's configuration it either proceeds as the token's own user or is rejected with a 403. More information about permissions.

x-as-user-idstring
Example:5f0375c4cdc1927a3c5edcd3

Denotes the actor of the request. When used, the API will take into account this user's permissions and access. This or x-as-user-email is required when the associated token was produced from the Client Credentials grant or with legacy bearer tokens on select endpoints. A token produced from the Authorization Code grant (which is already scoped to a user) may also use this header to act as a different user in the same company, provided the token carries the identity.users.impersonate scope and the token's own user has been granted the API User Impersonation permission. A request that sends this header without both never acts as the named user; depending on the company's configuration it either proceeds as the token's own user or is rejected with a 403. More information about permissions.

Response

200 OK

OR
OR
OR

Example response

{
  "id": "urn:ietf:params:scim:schemas:core:2.0:Group",
  "name": "Group",
  "description": "Group",
  "attributes": [
    {
      "type": "string",
      "description": "A human-readable name for the Group.  REQUIRED.",
      "required": true,
      "mutability": "readWrite",
      "returned": "default",
      "uniqueness": "none",
      "name": "displayName"
    }
  ],
  "meta": {
    "resourceType": "Schema",
    "location": "https://ironcladapp.com/scim/v2/Schemas/urn:ietf:params:scim:schemas:core:2.0:Group"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.