Create a User for a Team
post
/api/v2/teams/{id}/users/
Make a POST request to this resource with the following user fields to create a new user associated with this team.
username
: Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only. (string, required)first_name
: (string, default=""
)last_name
: (string, default=""
)email
: (string, default=""
)is_superuser
: Designates that this user has all permissions without explicitly assigning them. (boolean, default=False
)is_system_auditor
: (boolean, default=False
)password
: Field used to change the password. (string, default=""
)
Add Users for a Team:
Make a POST request to this resource with only an id
field to associate an
existing user with this team.
Remove Users from this Team:
Make a POST request to this resource with id
and disassociate
fields to
remove the user from this team
without deleting the user.
Request
Supported Media Types
- application/json
Path Parameters
Root Schema : User
Type:
Show Source
object
-
created:
string
Title:
Created
Read Only:true
-
email:
string
Title:
Email address
Maximum Length:254
-
external_account:
string
Title:
External account
Read Only:true
Set if the account is managed by an external service -
first_name:
string
Title:
First name
Maximum Length:150
-
id:
integer
Title:
ID
Read Only:true
-
is_superuser:
boolean
Title:
Superuser status
Designates that this user has all permissions without explicitly assigning them. -
is_system_auditor:
boolean
Title:
Is system auditor
-
last_login:
string(date-time)
Title:
Last login
Read Only:true
-
last_name:
string
Title:
Last name
Maximum Length:150
-
ldap_dn:
string
Title:
Ldap dn
Read Only:true
Minimum Length:1
-
modified:
string
Title:
Modified
Read Only:true
-
password:
string
Title:
Password
Minimum Length:1
Field used to change the password. - related: string
-
summary_fields:
string
Title:
Summary fields
Read Only:true
-
type:
string
Title:
Type
Read Only:true
-
url:
string
Title:
Url
Read Only:true
-
username(required):
string
Title:
Username
Minimum Length:1
Maximum Length:150
Pattern:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.
Response
Supported Media Types
- application/json
201 Response
Root Schema : User
Type:
Show Source
object
-
created:
string
Title:
Created
Read Only:true
-
email:
string
Title:
Email address
Maximum Length:254
-
external_account:
string
Title:
External account
Read Only:true
Set if the account is managed by an external service -
first_name:
string
Title:
First name
Maximum Length:150
-
id:
integer
Title:
ID
Read Only:true
-
is_superuser:
boolean
Title:
Superuser status
Designates that this user has all permissions without explicitly assigning them. -
is_system_auditor:
boolean
Title:
Is system auditor
-
last_login:
string(date-time)
Title:
Last login
Read Only:true
-
last_name:
string
Title:
Last name
Maximum Length:150
-
ldap_dn:
string
Title:
Ldap dn
Read Only:true
Minimum Length:1
-
modified:
string
Title:
Modified
Read Only:true
-
password:
string
Title:
Password
Minimum Length:1
Field used to change the password. - related: string
-
summary_fields:
string
Title:
Summary fields
Read Only:true
-
type:
string
Title:
Type
Read Only:true
-
url:
string
Title:
Url
Read Only:true
-
username(required):
string
Title:
Username
Minimum Length:1
Maximum Length:150
Pattern:^[\w.@+-]+$
Required. 150 characters or fewer. Letters, digits and @/./+/-/_ only.