Clerk · JSON Structure

Clerk Client Structure

JSON Structure overview of Clerk Client entity.

Type: Properties: 0 Required: 10

AuthenticationAuthorizationB2B SaaSCIAMIdentity ManagementMFAOAuthOpenID ConnectOrganizationsPasskeysSAMLSecuritySessionsSSOUser Management

Clerk Client 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

{
  "$schema": "https://json-structure.org/schema/v0",
  "title": "Clerk Client Structure",
  "description": "JSON Structure overview of Clerk Client entity.",
  "entity": "Client",
  "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": "String representing the identifier of the session.\n",
      "format": null,
      "nullable": false
    },
    {
      "name": "session_ids",
      "type": "array",
      "description": "",
      "format": null,
      "nullable": false
    },
    {
      "name": "sessions",
      "type": "array",
      "description": "",
      "format": null,
      "nullable": false
    },
    {
      "name": "sign_in_id",
      "type": "string",
      "description": "",
      "format": null,
      "nullable": true
    },
    {
      "name": "sign_up_id",
      "type": "string",
      "description": "",
      "format": null,
      "nullable": true
    },
    {
      "name": "last_active_session_id",
      "type": "string",
      "description": "Last active session_id.\n",
      "format": null,
      "nullable": true
    },
    {
      "name": "last_authentication_strategy",
      "type": "string",
      "description": "The authentication strategy that was last used to authenticate the user on this client.\n",
      "format": null,
      "nullable": true
    },
    {
      "name": "updated_at",
      "type": "integer",
      "description": "Unix timestamp of last update.\n",
      "format": "int64",
      "nullable": false
    },
    {
      "name": "created_at",
      "type": "integer",
      "description": "Unix timestamp of creation.\n",
      "format": "int64",
      "nullable": false
    }
  ],
  "required": [
    "object",
    "id",
    "session_ids",
    "sessions",
    "sign_in_id",
    "sign_up_id",
    "last_active_session_id",
    "last_authentication_strategy",
    "updated_at",
    "created_at"
  ]
}