Rust · 0.1.0

Create Space Invitation

POST /api/v1/spaces/{space}/invitations

SpaceService · SpaceService_CreateSpaceInvitation

Protocol-derived reference. Authorization and instance policy still apply. Schema descriptions are inherited from the MIT-licensed application contract; examples here are not executed against a live server.

Access

Requires the space ADMIN role as an active member. An instance administrator who is not a space administrator cannot use these governance operations.

Invite an existing account

Send a SpaceInvitation body with invitee as users/{username} and role ADMIN or USER. The invitee must be active. Existing membership or a pending invitation produces ALREADY_EXISTS. The returned invitation name ends in the invitee's username, not an arbitrary invitation ID.

Request

CreateSpaceInvitation invites an existing active user to a space.

POST/api/v1/spaces/{space}/invitations

Parameters

Name / location	Type / requirement	Description
`space` path	string Required	The space id.

Request body

Required

application/json · SpaceInvitation

Responses

200 · OK

application/json · SpaceInvitation

default · Default error response

application/json · Status

Complete operation definition

All declared constraints, media types and response details are retained below. Schema references link to their complete definitions.

Open JSON definition

{
  "tags": [
    "SpaceService"
  ],
  "description": "CreateSpaceInvitation invites an existing active user to a space.",
  "operationId": "SpaceService_CreateSpaceInvitation",
  "parameters": [
    {
      "name": "space",
      "in": "path",
      "description": "The space id.",
      "required": true,
      "schema": {
        "type": "string"
      }
    }
  ],
  "requestBody": {
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/SpaceInvitation"
        }
      }
    },
    "required": true
  },
  "responses": {
    "200": {
      "description": "OK",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/SpaceInvitation"
          }
        }
      }
    },
    "default": {
      "description": "Default error response",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Status"
          }
        }
      }
    }
  }
}