Post
/v1/users/invite
Invite an existing user or a new user to join an existing account.
Security
API Key
Header parameter nameAuthentication
A JWT bearer token to be passed once authenticated.
Body parameters
Request to invite a user.
object
user_email
string Required
User's email address.
roles
Array of string (AccessRoles) Required
string
Roles of a user.
Valid values[
"READER",
"WRITER",
"MANAGER"
]
first_name
string
last_name
string
Responses
201
Invited User details.
object
user_id
string (uuid)
User Id.
first_name
string
First Name.
last_name
string
Last Name.
user_email
string
User Email.
last_logged_in_at
integer (int64)
Last login time of user.
created_at
integer (int64)
Creation time of user.
email_verified
boolean
Whether this user's email has been verified.
status
string
Status of a user.
Valid values[
"ACTIVE",
"PENDING",
"DISABLED"
]
roles
Array of string (AccessRoles)
string
Roles of a user.
Valid values[
"READER",
"WRITER",
"MANAGER"
]
user_account_status
string
Status of an Account for a user.
Valid values[
"ACTIVE",
"PENDING",
"DISABLED"
]
accepted_latest_terms_and_conditions
boolean
Whether this user has accepted latest terms and conditions or not.
new_email
string
User’s new email address before it has been confirmed.