Get a schema | Docker Hub API documentation

Get a schema Run in API Explorer

GET /v2/scim/2.0/Schemas/{id}

Bearer scim auth

Returns a schema by ID.

Path parameters

id string Required

Responses

200 application/scim+json
Hide response attributes Show response attributes object
- schemas array[string]
- id string
- name string
- description string
- attributes array[object]
  
  Hide attributes attributes Show attributes attributes object
  
  name string
  
  type string
  
  Values are string, boolean, or complex.
  
  multiValued boolean
  
  description string
  
  required boolean
  
  caseExact boolean
  
  mutability string
  
  returned string
  
  uniqueness string
  
  subAttributes array[object]
  
  Hide subAttributes attributes Show subAttributes attributes object
  
  name string
  
  type string
  
  Values are string, boolean, or complex.
  
  multiValued boolean
  
  description string
  
  required boolean
  
  caseExact boolean
  
  mutability string
  
  returned string
  
  uniqueness string
401 application/scim+json

Unauthorized
Hide response attributes Show response attributes object
- status string
  
  The status code for the response in string format.
- schemas array[string]
  
  Default value is urn:ietf:params:scim:api:messages:2.0:Error.
- detail string
  
  Details about why the request failed.
404 application/scim+json

Not Found
Hide response attributes Show response attributes object
- status string
  
  The status code for the response in string format.
- schemas array[string]
  
  Default value is urn:ietf:params:scim:api:messages:2.0:Error.
- detail string
  
  Details about why the request failed.
500 application/scim+json

Internal Error
Hide response attributes Show response attributes object
- status string
  
  The status code for the response in string format.
- schemas array[string]
  
  Default value is urn:ietf:params:scim:api:messages:2.0:Error.
- detail string
  
  Details about why the request failed.

GET /v2/scim/2.0/Schemas/{id}

curl \
 --request GET 'https://hub.docker.com/v2/scim/2.0/Schemas/urn:ietf:params:scim:schemas:core:2.0:User' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "schemas": [
    "urn:ietf:params:scim:schemas:core:2.0:Schema"
  ],
  "id": "urn:ietf:params:scim:schemas:core:2.0:User",
  "name": "User",
  "description": "User Account",
  "attributes": [
    {
      "name": "userName",
      "type": "string",
      "multiValued": false,
      "description": "Unique identifier for the User, typically used by the user to directly authenticate to the service provider. Each User MUST include a non-empty userName value. This identifier MUST be unique across the service provider's entire set of Users.",
      "required": true,
      "caseExact": false,
      "mutability": "readWrite",
      "returned": "default",
      "uniqueness": "server",
      "subAttributes": [
        {
          "name": "userName",
          "type": "string",
          "multiValued": false,
          "description": "Unique identifier for the User, typically used by the user to directly authenticate to the service provider. Each User MUST include a non-empty userName value. This identifier MUST be unique across the service provider's entire set of Users.",
          "required": true,
          "caseExact": false,
          "mutability": "readWrite",
          "returned": "default",
          "uniqueness": "server"
        }
      ]
    }
  ]
}

Response examples (401)

{
  "status": "401",
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "detail": "string"
}

Response examples (404)

{
  "status": "404",
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "detail": "string"
}

Response examples (500)

{
  "status": "500",
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:Error"
  ],
  "detail": "string"
}