POST

/api/v1/team/invitations

Create a single-use team invitation

Request#

POSIX shell · curl

curl --fail-with-body --request POST \
  "$ADBR_API_URL/api/v1/team/invitations" \
  -H "Authorization: Bearer $ADBR_API_TOKEN" \
  -H "Content-Type: application/json" \
  --data @request.json

Use the local address and token from API & MCP. Replace path placeholders such as {id} with actual IDs. Create request.json according to the body schema below before running this command.

Authentication and permissions#

Authentication: Bearer token

Scopes: admin

All listed scopes are required; admin satisfies scope checks. Account permissions, request content, vault state and resource permissions can impose additional requirements.

Parameters#

No path or query parameters declared.

Request body#

Required.

Field	Type	Required	Description
`name`	`string`	Yes
`role`	`union`	Yes

Complete body schema

OpenAPI JSON

{
  "required": true,
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "name",
          "role"
        ],
        "properties": {
          "name": {
            "type": "string",
            "minLength": 1,
            "maxLength": 120
          },
          "role": {
            "anyOf": [
              {
                "type": "string",
                "enum": [
                  "admin"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "editor"
                ]
              },
              {
                "type": "string",
                "enum": [
                  "viewer"
                ]
              }
            ]
          }
        },
        "additionalProperties": false
      }
    }
  }
}

Responses#

200 · Default response

OpenAPI JSON

{
  "description": "Default Response",
  "content": {
    "application/json": {
      "schema": {
        "type": "object",
        "required": [
          "invitation_code",
          "expires_at"
        ],
        "properties": {
          "invitation_code": {
            "type": "string"
          },
          "expires_at": {
            "type": "integer"
          }
        }
      }
    }
  }
}

default · HTTP error envelope. The status and error.code identify the failure.

OpenAPI JSON

{
  "description": "HTTP error envelope. The status and error.code identify the failure.",
  "content": {
    "application/json": {
      "schema": {
        "$ref": "#/components/schemas/Error"
      }
    }
  }
}

General authentication and transport errors may occur in addition to the documented responses.

OpenAPI definition#

Complete operation definition

OpenAPI JSON

{
  "summary": "Einmalige Team-Einladung erstellen",
  "tags": [
    "Team"
  ],
  "requestBody": {
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "required": [
            "name",
            "role"
          ],
          "properties": {
            "name": {
              "type": "string",
              "minLength": 1,
              "maxLength": 120
            },
            "role": {
              "anyOf": [
                {
                  "type": "string",
                  "enum": [
                    "admin"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "editor"
                  ]
                },
                {
                  "type": "string",
                  "enum": [
                    "viewer"
                  ]
                }
              ]
            }
          },
          "additionalProperties": false
        }
      }
    }
  },
  "x-required-scopes": [
    "admin"
  ],
  "responses": {
    "200": {
      "description": "Default Response",
      "content": {
        "application/json": {
          "schema": {
            "type": "object",
            "required": [
              "invitation_code",
              "expires_at"
            ],
            "properties": {
              "invitation_code": {
                "type": "string"
              },
              "expires_at": {
                "type": "integer"
              }
            }
          }
        }
      }
    },
    "default": {
      "description": "HTTP error envelope. The status and error.code identify the failure.",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}