Clerk · JSON Structure

Clerk Organization Structure

JSON Structure overview of Clerk Organization entity.

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

Clerk Organization 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 Organization Structure",
  "description": "JSON Structure overview of Clerk Organization entity.",
  "entity": "Organization",
  "fields": [
    {
      "name": "object",
      "type": "string",
      "description": "",
      "format": null,
      "nullable": false
    },
    {
      "name": "id",
      "type": "string",
      "description": "",
      "format": null,
      "nullable": false
    },
    {
      "name": "name",
      "type": "string",
      "description": "",
      "format": null,
      "nullable": false
    },
    {
      "name": "slug",
      "type": "string",
      "description": "",
      "format": null,
      "nullable": false
    },
    {
      "name": "image_url",
      "type": "string",
      "description": "",
      "format": null,
      "nullable": false
    },
    {
      "name": "has_image",
      "type": "boolean",
      "description": "",
      "format": null,
      "nullable": false
    },
    {
      "name": "members_count",
      "type": "integer",
      "description": "",
      "format": null,
      "nullable": false
    },
    {
      "name": "missing_member_with_elevated_permissions",
      "type": "boolean",
      "description": "",
      "format": null,
      "nullable": false
    },
    {
      "name": "pending_invitations_count",
      "type": "integer",
      "description": "",
      "format": null,
      "nullable": false
    },
    {
      "name": "max_allowed_memberships",
      "type": "integer",
      "description": "",
      "format": null,
      "nullable": false
    },
    {
      "name": "admin_delete_enabled",
      "type": "boolean",
      "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": "created_by",
      "type": "string",
      "description": "",
      "format": null,
      "nullable": false
    },
    {
      "name": "created_at",
      "type": "integer",
      "description": "Unix timestamp of creation.\n",
      "format": "int64",
      "nullable": false
    },
    {
      "name": "updated_at",
      "type": "integer",
      "description": "Unix timestamp of last update.\n",
      "format": "int64",
      "nullable": false
    },
    {
      "name": "last_active_at",
      "type": "integer",
      "description": "Unix timestamp of last activity.\n",
      "format": "int64",
      "nullable": false
    },
    {
      "name": "role_set_key",
      "type": "string",
      "description": "The key of the [role set](https://clerk.com/docs/guides/organizations/control-access/role-sets) assigned to this organization.\n",
      "format": null,
      "nullable": true
    }
  ],
  "required": [
    "object",
    "id",
    "name",
    "slug",
    "has_image",
    "max_allowed_memberships",
    "admin_delete_enabled",
    "public_metadata",
    "created_at",
    "updated_at"
  ]
}