Create User
POST/users/
Request
- application/json
- application/x-www-form-urlencoded
- multipart/form-data
Body
required
ceo
- Chief Executive Officercto
- Chief Technology Officercso
- Chief Security Officerseceng
- Security engineerdev
- Developerdevop
- Developer Operationsmanager
- Managerother
- OtherArray [
]
Array [
account
- accountteam
- teamtarget
- target]
Possible values: <= 60 characters
Name of the user.
Possible values: [ceo
, cto
, cso
, seceng
, dev
, devop
, manager
, other
, ``]
Job title:
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
Possible values: <= 255 characters
Name of the label.
The maximum length is 255 characters.
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.
user_roles
object[]
role
object
required
Possible values: >= 12 characters
and <= 12 characters
A unique Base58 value identifying this object.
scope
object
required
Possible values: [account
, team
, target
]
team
object
Possible values: >= 12 characters
and <= 12 characters
A unique Base58 value identifying this object.
target
object
Possible values: >= 12 characters
and <= 12 characters
A unique Base58 value identifying this object.
Body
required
ceo
- Chief Executive Officercto
- Chief Technology Officercso
- Chief Security Officerseceng
- Security engineerdev
- Developerdevop
- Developer Operationsmanager
- Managerother
- OtherArray [
]
Array [
account
- accountteam
- teamtarget
- target]
Possible values: <= 60 characters
Name of the user.
Possible values: [ceo
, cto
, cso
, seceng
, dev
, devop
, manager
, other
, ``]
Job title:
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
Possible values: <= 255 characters
Name of the label.
The maximum length is 255 characters.
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.
user_roles
object[]
role
object
required
Possible values: >= 12 characters
and <= 12 characters
A unique Base58 value identifying this object.
scope
object
required
Possible values: [account
, team
, target
]
team
object
Possible values: >= 12 characters
and <= 12 characters
A unique Base58 value identifying this object.
target
object
Possible values: >= 12 characters
and <= 12 characters
A unique Base58 value identifying this object.
Body
required
ceo
- Chief Executive Officercto
- Chief Technology Officercso
- Chief Security Officerseceng
- Security engineerdev
- Developerdevop
- Developer Operationsmanager
- Managerother
- OtherArray [
]
Array [
account
- accountteam
- teamtarget
- target]
Possible values: <= 60 characters
Name of the user.
Possible values: [ceo
, cto
, cso
, seceng
, dev
, devop
, manager
, other
, ``]
Job title:
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
Possible values: <= 255 characters
Name of the label.
The maximum length is 255 characters.
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.
user_roles
object[]
role
object
required
Possible values: >= 12 characters
and <= 12 characters
A unique Base58 value identifying this object.
scope
object
required
Possible values: [account
, team
, target
]
team
object
Possible values: >= 12 characters
and <= 12 characters
A unique Base58 value identifying this object.
target
object
Possible values: >= 12 characters
and <= 12 characters
A unique Base58 value identifying this object.
Responses
- 201
- 400
- 401
- 500
- application/json
- Schema
- Example (from schema)
Schema
ceo
- Chief Executive Officercto
- Chief Technology Officercso
- Chief Security Officerseceng
- Security engineerdev
- Developerdevop
- Developer Operationsmanager
- Managerother
- OtherArray [
]
Array [
account
- accountteam
- teamscope
- scope]
A unique Base58 value identifying this object.
Email of the user.
Possible values: <= 60 characters
Name of the user.
Possible values: [ceo
, cto
, cso
, seceng
, dev
, devop
, manager
, other
, ``]
Job title:
If true, the user has permissions to manage billing. Read-only.
changed_by
object
required
User who last made changes.
A unique Base58 value identifying this object.
Possible values: <= 254 characters
Email of the user.
Possible values: <= 60 characters
Name of the user.
Date and time of the last change, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302".
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
A unique Base58 value identifying this object.
Possible values: <= 255 characters
Name of the label.
The maximum length is 255 characters.
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.
A unique Base58 value identifying this object.
Possible values: <= 254 characters
Email of the user.
Possible values: <= 60 characters
Name of the user.
Date and time of the last change, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302".
user_roles
object[]
role
object
required
Possible values: >= 12 characters
and <= 12 characters
A unique Base58 value identifying this object.
scope
object
required
Possible values: [account
, team
, scope
]
team
object
Possible values: >= 12 characters
and <= 12 characters
A unique Base58 value identifying this object.
target
object
Possible values: >= 12 characters
and <= 12 characters
A unique Base58 value identifying this object.
Date and time of the last login of the user, in ISO 8601 UTC format.
For example, "2023-08-09T13:27:43.8208302"
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."
If true, the user has MFA (Multi-Factor Authentication) enabled at login.
Defaults to true.
{
"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
}
- application/json
- Schema
- Example (from schema)
Schema
{
"<field name>": [
"Errors related to field <field name>."
],
"non_field_errors": [
"Errors not related to any field specific field."
]
}
- application/json
- Schema
- Example (from schema)
Schema
{
"detail": "Incorrect authentication credentials."
}
- application/json
- Schema
- Example (from schema)
Schema
{
"detail": "Unexpected error while handling your request."
}