Bulk Update Users

POST 
/users/bulk/update/

Request

application/json

Body

required

ids string[]required

List of object IDs.

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
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 [

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.

]

application/x-www-form-urlencoded

Body

required

ids string[]required

List of object IDs.

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
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 [

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.

]

multipart/form-data

Body

required

ids string[]required

List of object IDs.

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
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 [

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.

]

Responses

200

application/json

Schema

Schema

ids string[]required

List of object IDs.

Example (from schema)

{
  "ids": [
    "string"
  ]
}

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...