Users
Create User
POST
/
v1
/
accounts
/
{account_id}
/
users
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
account_id
string
requiredThe Account Id
Query Parameters
userId
string
The user ID to use in the user name. e.g. my-user If not specified, a default ID is generated from user.email.
Body
application/json
displayName
string
Human-readable display name of the user. e.g. "Alice" Must be fewer than 64 characters long.
role
string
requiredThe user's role, e.g. admin or user.
email
string
requiredThe user's email address.
state
enum<string>
default: STATE_UNSPECIFIEDThe state of the user.
Available options:
STATE_UNSPECIFIED, CREATING, READY, UPDATING, DELETING status
object
Contains information about the user status.
Response
200 - application/json
name
string
displayName
string
Human-readable display name of the user. e.g. "Alice" Must be fewer than 64 characters long.
createTime
string
The creation time of the user.
role
string
requiredThe user's role, e.g. admin or user.
email
string
requiredThe user's email address.
state
enum<string>
default: STATE_UNSPECIFIEDThe state of the user.
Available options:
STATE_UNSPECIFIED, CREATING, READY, UPDATING, DELETING status
object
Contains information about the user status.
Was this page helpful?