Accept an invitation

POST

/api/v1/invite/{token}

curl --request POST \
  --url http://localhost:3000/api/v1/invite/example \
  --header 'Authorization: Bearer <token>'

As the signed-in person.

Any caller; the scope needed is checked on what it acts on.

Authorizations

• bearer
• session
• None

Parameters

Path Parameters

token

required

string

From the invitation link

Responses

200

Accepted

Media typeapplication/json

object

data

required

object

organizationId

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

projectId

required

Any of:

string

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

null

null

resource

required

string

Allowed values: organization project collection asset brand

scope

required

string

Allowed values: read propose write admin

Example

{
  "data": {
    "resource": "organization",
    "scope": "read"
  }
}

default

An error

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

detail

Example^generated

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