Skip to content

Invite a user

POST
/api/v1/tenant/users

Invite a new user to the tenant by email and role.

Authorizations

Request Body required

Request body for POST /tenant/users.

Attributes: email: Email address to invite. role: Role to assign (e.g. owner, admin, member).

object
email
required
string
>= 1 characters <= 255 characters
role
string
default: member <= 50 characters

Responses

201

Successful Response

Wrapper response for single-user endpoints.

Attributes: data: The user payload.

object
data
required

User record returned by list/invite/update endpoints.

Attributes: id: Unique user identifier. email: User’s email address. name: User’s display name. role: User’s role within the tenant.

object
email
required
string
id
required
string format: uuid
name
required
string
role
required
string

422

Validation Error

object
detail
Array<object>
object
ctx
object
input
loc
required
Array
msg
required
string
type
required
string