Skip to content

Register from an invitation

POST
/api/v1/account/invitations/register
curl --request POST \
--url http://127.0.0.1:8080/api/v1/account/invitations/register \
--header 'Content-Type: application/json' \
--header 'Origin: example' \
--data '{ "display_name": "example", "login": "example", "password": "example", "token": "example" }'

Creates the account and consumes the invitation in one transaction. Browser session and CSRF protection are required for mutations, except invited local registration. Invitation secrets are returned once and must never be logged.

Origin
required
string

Must be the configured public origin.

Media typeapplication/json
object
display_name
required
string
login
required
string
password
required
string
token
required
string
Examplegenerated
{
"display_name": "example",
"login": "example",
"password": "example",
"token": "example"
}

Completed

Media typeapplication/json
object
csrf_token
required
string
user
required
object
display_name
required
string
id
required
string
instance_admin
required
boolean
key
additional properties
any
key
additional properties
any
Examplegenerated
{
"csrf_token": "example",
"user": {
"display_name": "example",
"id": "example",
"instance_admin": true
}
}

The credential sent is invalid (invalid-credentials).

Media typeapplication/problem+json
object
code
required
string
detail
required
string
status
required
integer format: int64
title
required
string
type
required
string
key
additional properties
any
Examplegenerated
{
"code": "example",
"detail": "example",
"status": 1,
"title": "example",
"type": "example"
}