Skip to main content
POST
Create invite

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
name
string

Their full name

Required string length: 1 - 40
Example:

"Example"

email
string<email>

Their email address

Example:

"name@company.com"

authentication
enum<string>

How should we authenticate them? You should only use "sso" if you have previously configured a SAML2 identity provider

Available options:
password,
sso
Example:

"password"

role
enum<string>

What is their role?

Available options:
viewer,
uploader,
admin,
owner
Example:

"admin"

Response

Invite

success
boolean
required
Example:

true

result
object
required
Example:
errors
object[]
required
Example: