Language

English Français 日本語 한국어 Español

Datadog Site

Site help
US1 US3 US5 EU AP1 AP2 US1-FED US2-FED

Get schema

copy Copy pageCopied

GET https://api.ap1.datadoghq.com/api/v2/scim/Schemas/{schema_id}https://api.ap2.datadoghq.com/api/v2/scim/Schemas/{schema_id}https://api.datadoghq.eu/api/v2/scim/Schemas/{schema_id}https://api.ddog-gov.com/api/v2/scim/Schemas/{schema_id}https://api.us2.ddog-gov.com/api/v2/scim/Schemas/{schema_id}https://api.datadoghq.com/api/v2/scim/Schemas/{schema_id}https://api.us3.datadoghq.com/api/v2/scim/Schemas/{schema_id}https://api.us5.datadoghq.com/api/v2/scim/Schemas/{schema_id}

Overview

Get a single SCIM schema using the schema_id. Supported schema_id values are urn:ietf:params:scim:schemas:core:2.0:User and urn:ietf:params:scim:schemas:core:2.0:Group. This endpoint requires all of the following permissions:

  • user_access_invite
  • user_access_manage

    • Arguments

    Path Parameters

    Name

    Type

    Description

    schema_id [required]

    string

    The id of the schema to retrieve.

    Response

    OK

    Definition of a SCIM schema.

    Expand All

    Field

    Type

    Description

    attributes

    [object]

    A list of attributes that make up the schema.

    canonicalValues

    [string]

    A collection of canonical values.

    caseExact

    boolean

    A Boolean value that specifies whether or not a string attribute is case sensitive.

    description

    string

    The attribute's human-readable description.

    multiValued

    boolean

    A Boolean value indicating an attribute's plurality.

    mutability

    string

    A single keyword indicating the circumstances under which the value of the attribute can be (re)defined.

    name

    string

    The attribute's name.

    referenceTypes

    [string]

    A list of resource types or external resources the reference may refer to.

    required

    boolean

    A Boolean value that specifies whether or not the attribute is required.

    returned

    string

    A single keyword that indicates when an attribute and associated values are returned in response to a GET request or in response to a PUT, POST, or PATCH request.

    subAttributes

    [object]

    A list of sub-attributes for complex attributes.

    canonicalValues

    [string]

    A collection of canonical values.

    caseExact

    boolean

    A Boolean value that specifies whether or not a string attribute is case sensitive.

    description

    string

    The attribute's human-readable description.

    multiValued

    boolean

    A Boolean value indicating an attribute's plurality.

    mutability

    string

    A single keyword indicating the circumstances under which the value of the attribute can be (re)defined.

    name

    string

    The sub-attribute's name.

    referenceTypes

    [string]

    A list of resource types or external resources the reference may refer to.

    required

    boolean

    A Boolean value that specifies whether or not the attribute is required.

    returned

    string

    A single keyword that indicates when an attribute and associated values are returned in response to a GET request or in response to a PUT, POST, or PATCH request.

    type

    string

    The data type of the attribute.

    uniqueness

    string

    A single keyword value that specifies how the service provider enforces uniqueness of attribute values.

    type

    string

    The data type of the attribute.

    uniqueness

    string

    A single keyword value that specifies how the service provider enforces uniqueness of attribute values.

    description

    string

    Human-readable description of the schema.

    id

    string

    The unique URI of the schema.

    meta

    object

    Metadata associated with a SCIM schema.

    location

    string

    URL identifying the schema.

    resourceType

    string

    Type of resource.

    name

    string

    The human-readable name of the schema.

    {
  "attributes": [
    {
      "canonicalValues": [],
      "caseExact": false,
      "description": "string",
      "multiValued": false,
      "mutability": "string",
      "name": "string",
      "referenceTypes": [],
      "required": false,
      "returned": "string",
      "subAttributes": [
        {
          "canonicalValues": [],
          "caseExact": false,
          "description": "string",
          "multiValued": false,
          "mutability": "string",
          "name": "string",
          "referenceTypes": [],
          "required": false,
          "returned": "string",
          "type": "string",
          "uniqueness": "string"
        }
      ],
      "type": "string",
      "uniqueness": "string"
    }
  ],
  "description": "User Schema",
  "id": "urn:ietf:params:scim:schemas:core:2.0:User",
  "meta": {
    "location": "https://app.datadoghq.com/api/v2/scim/Schemas/urn:ietf:params:scim:schemas:core:2.0:User",
    "resourceType": "Schema"
  },
  "name": "User"
}

    Not Found

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [string]

    A list of errors.

    {
  "errors": [
    "Bad Request"
  ]
}

    Too many requests

    API error response.

    Expand All

    Field

    Type

    Description

    errors [required]

    [string]

    A list of errors.

    {
  "errors": [
    "Bad Request"
  ]
}

    Code Example

                      # Path parameters
    export schema_id="CHANGE_ME"
    # Curl command
    curl -X GET "https://api.ap1.datadoghq.com"https://api.ap2.datadoghq.com"https://api.datadoghq.eu"https://api.ddog-gov.com"https://api.us2.ddog-gov.com"https://api.datadoghq.com"https://api.us3.datadoghq.com"https://api.us5.datadoghq.com/api/v2/scim/Schemas/${schema_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"