Clerk · JSON Structure

Clerk Organizationinvitation Structure

JSON Structure overview of Clerk OrganizationInvitation entity.

Type: Properties: 0 Required: 12
AuthenticationAuthorizationB2B SaaSCIAMIdentity ManagementMFAOAuthOpenID ConnectOrganizationsPasskeysSAMLSecuritySessionsSSOUser Management

Clerk Organizationinvitation Structure is a JSON Structure definition published by Clerk. It conforms to the https://json-structure.org/schema/v0 meta-schema.

Meta-schema: https://json-structure.org/schema/v0

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/schema/v0",
  "title": "Clerk OrganizationInvitation Structure",
  "description": "JSON Structure overview of Clerk OrganizationInvitation entity.",
  "entity": "OrganizationInvitation",
  "fields": [
    {
      "name": "object",
      "type": "string",
      "description": "String representing the object's type. Objects of the same type share the same value.\n",
      "format": null,
      "nullable": false
    },
    {
      "name": "id",
      "type": "string",
      "description": "",
      "format": null,
      "nullable": false
    },
    {
      "name": "email_address",
      "type": "string",
      "description": "",
      "format": null,
      "nullable": false
    },
    {
      "name": "role",
      "type": "string",
      "description": "",
      "format": null,
      "nullable": false
    },
    {
      "name": "role_name",
      "type": "string",
      "description": "",
      "format": null,
      "nullable": false
    },
    {
      "name": "organization_id",
      "type": "string",
      "description": "",
      "format": null,
      "nullable": false
    },
    {
      "name": "inviter_id",
      "type": "string",
      "description": "",
      "format": null,
      "nullable": true
    },
    {
      "name": "public_inviter_data",
      "type": "object",
      "description": "An organization inviter's public user data",
      "format": null,
      "nullable": true
    },
    {
      "name": "status",
      "type": "string",
      "description": "",
      "format": null,
      "nullable": false
    },
    {
      "name": "public_metadata",
      "type": "object",
      "description": "",
      "format": null,
      "nullable": false
    },
    {
      "name": "private_metadata",
      "type": "object",
      "description": "",
      "format": null,
      "nullable": false
    },
    {
      "name": "url",
      "type": "string",
      "description": "",
      "format": null,
      "nullable": true
    },
    {
      "name": "expires_at",
      "type": "integer",
      "description": "Unix timestamp of expiration.",
      "format": "int64",
      "nullable": true
    },
    {
      "name": "created_at",
      "type": "integer",
      "description": "Unix timestamp of creation.",
      "format": "int64",
      "nullable": false
    },
    {
      "name": "updated_at",
      "type": "integer",
      "description": "Unix timestamp of last update.",
      "format": "int64",
      "nullable": false
    }
  ],
  "required": [
    "object",
    "id",
    "email_address",
    "role",
    "role_name",
    "public_metadata",
    "url",
    "expires_at",
    "created_at",
    "updated_at",
    "inviter_id",
    "public_inviter_data"
  ]
}