Create an Invite link

POST

/api/v1/auth/invites

curl --request POST \
  --url https://example.com/api/v1/auth/invites \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "quota_override_bytes": 1, "role": "owner", "ttl_secs": 1 }'

Creates an Invite link. It requires a signed-in User with the admin scope and the admin or owner Role. It also requires a recent passkey check. It can return 401 if the session is missing or expired, 403 if access is denied and 429 if the request limit is reached. Route: /api/v1/auth/invites. Inputs: . A recent account assertion is required. Do not automatically replay this operation after an uncertain result.

Authorizations

• installationBearer
• browserSession

Request Body^required

Media typeapplication/json

object

quota_override_bytes

None inherits the Instance default; zero means unlimited.

integer | null format: int64

role

required

string

Allowed values: owner admin member guest

ttl_secs

required

integer format: int64

Responses

200

Media typeapplication/json

object

expires_at

required

integer format: int64

quota_override_bytes

integer | null format: int64

role

required

string

Allowed values: owner admin member guest

token

required

string

url

required

string

Example

{
  "role": "owner"
}

429

Media typeapplication/json

object

code

required

string

message

required

string

Example^generated

{
  "code": "example",
  "message": "example"
}