Skip to main content
POST
Invite someone to the organization

Authorizations

Authorization
string
header
required

A personal access token (POST /v1/auth/tokens) or a machine identity token (POST /v1/projects/{project_id}/identities/{identity_id}/tokens), both prefixed qumo_pat_. A token's scopes cap what it can do; see Scopes and permissions. A personal token names no organization: on a route whose path names no project or organization, pass ?organization_id=.

Query Parameters

organization_id
string<uuid>

The organization the request acts in. Required with a personal token or a session, which name no organization themselves; an identity token's organization is implied.

Body

application/json
email
string<email>
required
role_id
enum<string>
required

The role the invitee gets on accepting. roles/platform.admin cannot be granted.

Available options:
roles/project.viewer,
roles/project.editor,
roles/project.admin,
roles/organization.admin
Example:

"roles/organization.admin"

Response

The invitation and its link.

invitation
object
required

An invitation not yet accepted.

The link the invitee opens to accept. It is also emailed to them.

Example:

"https://console.qumo-deploy.com/join?token=8c1e3a5f7b9d2c4e6a8f0b1d3e5a7c9f2b4d6e8a0c1e3f5a7b9d1c3e5f7a9b2d"