SpaceInvitation

Where this schema is used

These links are derived from direct references in the protocol snapshot. Follow the calling operation for authentication, accepted fields and runtime behavior; a reusable resource schema is not by itself a complete write request.

• POSTCreate Space Invitation/api/v1/spaces/{space}/invitations
• GETGet Space Invitation/api/v1/spaces/{space}/invitations/{invitation}

Referenced by these component schemas:

• ListSpaceInvitationsResponse
• ListUserSpaceInvitationsResponse

Shape and fields

object

SpaceInvitation is a pending invitation for an existing user to join a space.

Complete schema

Use this complete JSON definition for constraints and nested structure. A field's presence here does not mean it is writable by every caller.

{
  "required": [
    "invitee",
    "role"
  ],
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The resource name. Format: spaces/{space}/invitations/{username}."
    },
    "invitee": {
      "type": "string",
      "description": "Required. The invited user. Format: users/{username}."
    },
    "role": {
      "enum": [
        "ROLE_UNSPECIFIED",
        "ADMIN",
        "USER"
      ],
      "type": "string",
      "description": "Required. The role the user will receive after accepting the invitation.",
      "format": "enum"
    },
    "space": {
      "readOnly": true,
      "allOf": [
        {
          "$ref": "#/components/schemas/Space"
        }
      ],
      "description": "Output only. The Space the user is invited to. This lets an invitee\n understand the invitation without granting membership-based GetSpace access."
    }
  },
  "description": "SpaceInvitation is a pending invitation for an existing user to join a space."
}