Skip to content
Toriidocs

Create an invitation with optional pre-seeded metadata

POST
/api/server/v1/invitations
curl --request POST \
  --url https://api.toriiauth.eu/api/server/v1/invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "email": "example", "expiresInDays": 1, "redirectUrl": "example", "publicMetadata": {}, "privateMetadata": {} }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
email
required
string
expiresInDays
integer | null format: int32
redirectUrl
string | null
publicMetadata
required
object
key
additional properties
any
privateMetadata
required
object
key
additional properties
any
Examplegenerated
{
  "email": "example",
  "expiresInDays": 1,
  "redirectUrl": "example",
  "publicMetadata": {},
  "privateMetadata": {}
}

Responses

Section titled “Responses”

201

Section titled “201”

The created invitation. The email has been sent.

Media typeapplication/json
object
id
required
string format: uuid
environmentId
required
string format: uuid
email
required
string
status
required
string
Allowed values: PENDING ACCEPTED REVOKED EXPIRED
expiresAt
required
string format: date-time
createdAt
required
string format: date-time
acceptedAt
string | null format: date-time
revokedAt
string | null format: date-time
Example
{
  "status": "PENDING"
}

400

Section titled “400”

Invalid body, metadata over the 8KB budget, or the environment has no sign-up URL configured.

Media typeapplication/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  }
}

401

Section titled “401”

Missing or invalid secret key.

Media typeapplication/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  }
}

409

Section titled “409”

This email already has an account in the environment.

Media typeapplication/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  }
}

429

Section titled “429”

The environment’s invitation rate limit is exhausted.

Media typeapplication/problem+json
object
type
string format: uri
title
string
status
integer format: int32
detail
string
instance
string format: uri
properties
object
key
additional properties
Examplegenerated
{
  "type": "https://example.com",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "https://example.com",
  "properties": {
    "additionalProperty": "example"
  }
}