Get schema - SCIM - Datadog API

GEThttps://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}https://api.datadoghq.eu/api/v2/scim/Schemas/{schema_id}https://api.ap1.datadoghq.com/api/v2/scim/Schemas/{schema_id}https://api.ap2.datadoghq.com/api/v2/scim/Schemas/{schema_id}https://api.uk1.datadoghq.com/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}

Descripción general

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

Argumentos

Parámetros de ruta

Nombre

Type

Descripción

schema_id [required]

string

The id of the schema to retrieve.

Respuesta

Definition of a SCIM schema.

Campo

Type

Descripción

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.

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.

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.

Campo

Type

Descripción

errors [required]

[string]

A list of errors.

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

Too many requests

API error response.

Campo

Type

Descripción

errors [required]

[string]

A list of errors.

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

Ejemplo de código

Get schema

# Path parameters
export schema_id="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="datadoghq.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/scim/Schemas/${schema_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

# Path parameters
export schema_id="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="us3.datadoghq.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/scim/Schemas/${schema_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

# Path parameters
export schema_id="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="us5.datadoghq.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/scim/Schemas/${schema_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

# Path parameters
export schema_id="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="datadoghq.eu"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/scim/Schemas/${schema_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

# Path parameters
export schema_id="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="ap1.datadoghq.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/scim/Schemas/${schema_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

# Path parameters
export schema_id="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="ap2.datadoghq.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/scim/Schemas/${schema_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

# Path parameters
export schema_id="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="uk1.datadoghq.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/scim/Schemas/${schema_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

# Path parameters
export schema_id="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="ddog-gov.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/scim/Schemas/${schema_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"

# Path parameters
export schema_id="CHANGE_ME"

# Set your Datadog site and credentials
export DD_SITE="us2.ddog-gov.com"
export DD_BEARER_TOKEN="<DD_BEARER_TOKEN>"

curl -X GET "https://api.${DD_SITE}/api/v2/scim/Schemas/${schema_id}" \
-H "Accept: application/json" \
-H "Authorization: Bearer ${DD_BEARER_TOKEN}"