InvitationPreviewResponse

Fields

6 fields

email · required

string

expires_at · required

string (date-time)

invited_by_name

string or null

project_names

array of string

role · required

UserRole

sso_required

boolean

Raw schema (JSON)

{
  "properties": {
    "email": {
      "title": "Email",
      "type": "string"
    },
    "expires_at": {
      "format": "date-time",
      "title": "Expires At",
      "type": "string"
    },
    "invited_by_name": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Invited By Name"
    },
    "project_names": {
      "items": {
        "type": "string"
      },
      "title": "Project Names",
      "type": "array"
    },
    "role": {
      "$ref": "#/components/schemas/UserRole"
    },
    "sso_required": {
      "default": false,
      "title": "Sso Required",
      "type": "boolean"
    }
  },
  "required": [
    "email",
    "role",
    "expires_at"
  ],
  "title": "InvitationPreviewResponse",
  "type": "object"
}

Used by endpoints

One endpoint sends or returns this schema, on its own or inside another schema.

• POST /api/v1/auth/invitations/preview — Preview Invitation

Used by schemas

No other schema contains this one.

More details

• Specification: OpenAPI JSON