CloudTruth · Schema

InvitationPublic

Serializer for the unauthenticated invite landing page that shows an invitee what they're being invited to before they sign in or create an account. Returns only the fields needed to render that page — no hyperlinks requiring auth context, no membership references. The invitee's own email is included because they already know it (the link came in their inbox) and the landing page renders "invited as " to confirm they're acting on the right invitation.

CompanyConfigManagementDevOpsCloudSecurity

Properties

Name Type Description
id string The unique identifier of an invitation.
email string The email address of the user to be invited.
role object The role that the user will have in the organization, should the user accept. * `OWNER` - Owner * `ADMIN` - Administrator * `CONTRIB` - Contributor * `VIEWER` - Viewer * `NO_SECRETS` - NoSecretsViewer
role_label string Human-readable role label (the underlying value is in `role`).
inviter_name string The name of the user that created the invitation.
organization_id string UUID of the organization. Used by the landing page to construct the post-login accept URL.
organization_name string Display name of the organization extending the invitation.
auth0_organization_id stringnull Auth0 Organization ID to pass as the `organization` parameter when redirecting the invitee to Auth0. Only populated when the organization has SSO enabled — the accept endpoint requires an org-scoped A
state string The current state of the invitation.
View JSON Schema on GitHub

JSON Schema

cloudtruth-invitation-public-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/cloudtruth/json-schema/cloudtruth-invitation-public-schema.json",
  "title": "InvitationPublic",
  "description": "Serializer for the unauthenticated invite landing page that shows an\ninvitee what they're being invited to before they sign in or create\nan account. Returns only the fields needed to render that page — no\nhyperlinks requiring auth context, no membership references. The\ninvitee's own email is included because they already know it (the\nlink came in their inbox) and the landing page renders \"invited as\n<email>\" to confirm they're acting on the right invitation.",
  "x-generated": "2026-11-10",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/cloudtruth-invitations-api-openapi.yml#/components/schemas/InvitationPublic",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "format": "uuid",
      "readOnly": true,
      "description": "The unique identifier of an invitation."
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "The email address of the user to be invited.",
      "maxLength": 254
    },
    "role": {
      "allOf": [
        {
          "$ref": "#/$defs/RoleEnum"
        }
      ],
      "description": "The role that the user will have in the organization, should the user accept.\n\n* `OWNER` - Owner\n* `ADMIN` - Administrator\n* `CONTRIB` - Contributor\n* `VIEWER` - Viewer\n* `NO_SECRETS` - NoSecretsViewer"
    },
    "role_label": {
      "type": "string",
      "readOnly": true,
      "description": "Human-readable role label (the underlying value is in `role`)."
    },
    "inviter_name": {
      "type": "string",
      "readOnly": true,
      "description": "The name of the user that created the invitation."
    },
    "organization_id": {
      "type": "string",
      "readOnly": true,
      "description": "UUID of the organization. Used by the landing page to construct the post-login accept URL."
    },
    "organization_name": {
      "type": "string",
      "readOnly": true,
      "description": "Display name of the organization extending the invitation."
    },
    "auth0_organization_id": {
      "type": [
        "string",
        "null"
      ],
      "readOnly": true,
      "description": "Auth0 Organization ID to pass as the `organization` parameter when redirecting the invitee to Auth0. Only populated when the organization has SSO enabled — the accept endpoint requires an org-scoped Auth0 login in that case; non-SSO logins must not be org-scoped or Auth0 may reject connections not enabled for the org."
    },
    "state": {
      "type": "string",
      "readOnly": true,
      "description": "The current state of the invitation."
    }
  },
  "required": [
    "auth0_organization_id",
    "email",
    "id",
    "inviter_name",
    "organization_id",
    "organization_name",
    "role",
    "role_label",
    "state"
  ],
  "$defs": {
    "RoleEnum": {
      "enum": [
        "OWNER",
        "ADMIN",
        "CONTRIB",
        "VIEWER",
        "NO_SECRETS"
      ],
      "type": "string",
      "description": "* `OWNER` - Owner\n* `ADMIN` - Administrator\n* `CONTRIB` - Contributor\n* `VIEWER` - Viewer\n* `NO_SECRETS` - NoSecretsViewer"
    }
  }
}

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/cloudtruth-invitation-public"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.