List Users

GET 
/users/

Request

Query Parameters

account boolean
active boolean
exclude string[]

Fields to exclude from the response.

exclude_target string[]
exclude_team string[]
label string[]

A unique Base58 value identifying this object.

label_logical_operator string
Possible values: [and, or]
Logical operator to apply between user labels:
(Defaults to or)
• and - and
• or - or
length integer

Number of results to return per page.

mfa_enabled boolean
no_access boolean
ordering string

Which field to use when ordering the results.

page integer

A page number within the paginated result set.

role string[]

A unique Base58 value identifying this object.

search string

A search term.

target string[]
team string[]

Responses

200

application/json

Schema

Schema

count integer

Total number of results.

page_total integer

Total number of pages.

page integer

Number of the current page.
The first page is 1.
Defaults to 1 if no specific page is requested.

length integer

Number of results returned per page.

results

object[]

Array [

id stringrequired

A unique Base58 value identifying this object.

email emailrequired

Email of the user.

name stringrequired

Possible values: <= 60 characters

Name of the user.

title string

Possible values: [ceo, cto, cso, seceng, dev, devop, manager, other, ``]

Job title:

• ceo - Chief Executive Officer
• cto - Chief Technology Officer
• cso - Chief Security Officer
• seceng - Security engineer
• dev - Developer
• devop - Developer Operations
• manager - Manager
• other - Other

is_billing_admin booleanrequired

If true, the user has permissions to manage billing. Read-only.

changed_by

object

required

User who last made changes.

id stringrequired

A unique Base58 value identifying this object.

email email

Possible values: <= 254 characters

Email of the user.

name stringrequired

Possible values: <= 60 characters

Name of the user.

changed date-timerequired

Date and time of the last change, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302".

active boolean

Default value: true

If true, the user can authenticate to Snyk API & Web to interact with apps and the API.
If false, the user's access to Snyk API & Web's apps and API is blocked.
Defaults to true.

labels

object[]

required

Array [

id stringrequired

A unique Base58 value identifying this object.

name stringrequired

Possible values: <= 255 characters

Name of the label.
The maximum length is 255 characters.

color string

Possible values: Value must match regular expression ^[a-zA-Z0-9#_-]*$

Color of the label, in RGB hexadecimal format prefixed with "#".
For example, "#00FF00" for green.

changed_by

object

required

User who last made changes.

id stringrequired

A unique Base58 value identifying this object.

email email

Possible values: <= 254 characters

Email of the user.

name stringrequired

Possible values: <= 60 characters

Name of the user.

changed date-timerequired

Date and time of the last change, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302".

]

user_roles

object[]

Array [

role

object

required

id stringrequired

Possible values: >= 12 characters and <= 12 characters

A unique Base58 value identifying this object.

name stringrequired

scope

object

required

tier stringrequired

Possible values: [account, team, scope]

• account - account
• team - team
• scope - scope

team

object

id stringrequired

Possible values: >= 12 characters and <= 12 characters

A unique Base58 value identifying this object.

name stringrequired

target

object

id stringrequired

Possible values: >= 12 characters and <= 12 characters

A unique Base58 value identifying this object.

name stringrequired

]

last_login date-timenullablerequired

Date and time of the last login of the user, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302"

is_apiuser booleanrequired

If true, it is an app that interacts with Snyk API & Web through the API.
If false, it is a human who interacts with Snyk API & Web through our web interface.
Defaults to false."

mfa_enabled booleanrequired

If true, the user has MFA (Multi-Factor Authentication) enabled at login.
Defaults to true.

]

Example (from schema)

{
  "count": 6,
  "page_total": 1,
  "page": 1,
  "length": 10,
  "results": [
    {
      "id": "string",
      "email": "[email protected]",
      "name": "string",
      "title": "ceo",
      "is_billing_admin": true,
      "changed_by": {
        "id": "string",
        "email": "[email protected]",
        "name": "string"
      },
      "changed": "2024-07-29T15:51:28.071Z",
      "active": true,
      "labels": [
        {
          "id": "string",
          "name": "string",
          "color": "string",
          "changed_by": {
            "id": "string",
            "email": "[email protected]",
            "name": "string"
          },
          "changed": "2024-07-29T15:51:28.071Z"
        }
      ],
      "user_roles": [
        {
          "role": {
            "id": "string",
            "name": "string"
          },
          "scope": {
            "tier": "account",
            "team": {
              "id": "string",
              "name": "string"
            },
            "target": {
              "id": "string",
              "name": "string"
            }
          }
        }
      ],
      "last_login": "2024-07-29T15:51:28.071Z",
      "is_apiuser": true,
      "mfa_enabled": true
    }
  ]
}

400

application/json

Schema

Schema

<field name> string[]
non_field_errors string[]

Example (from schema)

{
  "<field name>": [
    "Errors related to field <field name>."
  ],
  "non_field_errors": [
    "Errors not related to any field specific field."
  ]
}

401

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Incorrect authentication credentials."
}

500

application/json

Schema

Schema

detail string

Example (from schema)

{
  "detail": "Unexpected error while handling your request."
}

Loading...