List users | Docker Hub API documentation

List users Run in API Explorer

GET /v2/scim/2.0/Users

Returns paginated users for an organization. Use startIndex and count query parameters to receive paginated results.

Sorting:

Sorting allows you to specify the order in which resources are returned by specifying a combination of sortBy and sortOrder query parameters.

The sortBy parameter specifies the attribute whose value will be used to order the returned responses. The sortOrder parameter defines the order in which the sortBy parameter is applied. Allowed values are "ascending" and "descending".

Filtering:

You can request a subset of resources by specifying the filter query parameter containing a filter expression. Attribute names and attribute operators used in filters are case insensitive. The filter parameter must contain at least one valid expression. Each expression must contain an attribute name followed by an attribute operator and an optional value.

Supported operators are listed below.

eq equal
ne not equal
co contains
sw starts with
and Logical "and"
or Logical "or"
not "Not" function
() Precedence grouping

Query parameters

startIndex integer

Minimum value is 1.
count integer

Minimum value is 1, maximum value is 200.
filter string
attributes string

Comma delimited list of attributes to limit to in the response.
sortOrder string

Values are ascending or descending.
sortBy string

User attribute to sort by.

Responses

200 application/scim+json
Hide response attributes Show response attributes object
- schemas array[string]
- totalResults integer
- startIndex integer
- itemsPerPage integer
- resources array[object]
  
  Hide resources attributes Show resources attributes object
  
  schemas array[string]
  
  id string
  
  The unique identifier for the user. A v4 UUID.
  
  userName string
  
  The user's email address. This must be reachable via email.
  
  name object
  
  Hide name attributes Show name attributes object
  
  givenName string
  
  familyName string
  
  displayName string
  
  The username in Docker. Also known as the "Docker ID".
  
  active boolean
  
  emails array[object]
  
  Hide emails attributes Show emails attributes object
  
  value string
  
  display string
  
  primary boolean
  
  groups array[object]
  
  Hide groups attributes Show groups attributes object
  
  value string
  
  display string
  
  meta object
  
  Hide meta attributes Show meta attributes object
  
  resourceType string
  
  location string
  
  created string(date-time)
  
  The creation date for the user as a RFC3339 formatted string.
  
  lastModified string(date-time)
  
  The date the user was last modified as a RFC3339 formatted string.
400 application/scim+json

Bad Request
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.
- scimType string
  
  Some types of errors will return this per the specification.
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.
403 application/scim+json

Forbidden
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/Users

curl \
 --request GET 'https://hub.docker.com/v2/scim/2.0/Users' \
 --header "Authorization: Bearer $ACCESS_TOKEN"

Response examples (200)

{
  "schemas": [
    "urn:ietf:params:scim:api:messages:2.0:ListResponse"
  ],
  "totalResults": 1,
  "startIndex": 1,
  "itemsPerPage": 10,
  "resources": [
    {
      "schemas": [
        "urn:ietf:params:scim:schemas:core:2.0:User"
      ],
      "id": "d80f7c79-7730-49d8-9a41-7c42fb622d9c",
      "userName": "jon.snow@docker.com",
      "name": {
        "givenName": "Jon",
        "familyName": "Snow"
      },
      "displayName": "jonsnow",
      "active": true,
      "emails": [
        {
          "value": "jon.snow@docker.com",
          "display": "jon.snow@docker.com",
          "primary": true
        }
      ],
      "groups": [
        {
          "value": "nightswatch",
          "display": "nightswatch"
        }
      ],
      "meta": {
        "resourceType": "User",
        "location": "https://hub.docker.com/v2/scim/2.0/Users/d80f7c79-7730-49d8-9a41-7c42fb622d9c",
        "created": "2022-05-20T00:54:18Z",
        "lastModified": "2022-05-20T00:54:18Z"
      }
    }
  ]
}

Response examples (400)

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

Response examples (401)

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

Response examples (403)

{
  "status": "403",
  "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"
}