Clerk · Example Payload

Clerk User Example

AuthenticationAuthorizationB2B SaaSCIAMIdentity ManagementMFAOAuthOpenID ConnectOrganizationsPasskeysSAMLSecuritySessionsSSOUser Management

Clerk User Example is an example object payload from Clerk, with 46 top-level fields. It illustrates the shape of data this provider's APIs accept or return.

Top-level fields

idobjectexternal_idprimary_email_address_idprimary_phone_number_idprimary_web3_wallet_idusernamefirst_namelast_namelocaleprofile_image_urlimage_urlhas_imagepublic_metadataprivate_metadataunsafe_metadataemail_addressesphone_numbersweb3_walletspasskeyspassword_enabledtwo_factor_enabledtotp_enabledbackup_code_enabledmfa_enabled_atmfa_disabled_atpassword_last_updated_atexternal_accountssaml_accountsenterprise_accountsorganization_membershipslast_sign_in_atbannedlockeddeprovisionedlockout_expires_in_secondsverification_attempts_remainingupdated_atcreated_atdelete_self_enabledcreate_organization_enabledcreate_organizations_limitlast_active_atlegal_accepted_atbypass_client_trustscim

Example Payload

Raw ↑
{
  "id": "example",
  "object": "user",
  "external_id": "exte_2abc4xyz567Q9zZdEf",
  "primary_email_address_id": "idn_2abc4xyz567Q9zZdEf",
  "primary_phone_number_id": "idn_2abc4xyz567Q9zZdEf",
  "primary_web3_wallet_id": "prim_2abc4xyz567Q9zZdEf",
  "username": "jane.doe",
  "first_name": "Jane",
  "last_name": "Doe",
  "locale": "example",
  "profile_image_url": "example",
  "image_url": "example",
  "has_image": false,
  "public_metadata": {},
  "private_metadata": {},
  "unsafe_metadata": {},
  "email_addresses": [
    {
      "id": "example",
      "object": "email_address",
      "email_address": "jane@example.com",
      "reserved": false,
      "linked_to": [],
      "matches_sso_connection": false,
      "created_at": 0,
      "updated_at": 0
    }
  ],
  "phone_numbers": [
    {
      "id": "example",
      "object": "phone_number",
      "phone_number": "+15551234567",
      "reserved_for_second_factor": false,
      "default_second_factor": false,
      "reserved": false,
      "linked_to": [],
      "backup_codes": [
        "example"
      ],
      "created_at": 0,
      "updated_at": 0
    }
  ],
  "web3_wallets": [
    {
      "id": "example",
      "object": "web3_wallet",
      "web3_wallet": "example",
      "created_at": 0,
      "updated_at": 0
    }
  ],
  "passkeys": [
    {
      "id": "example",
      "object": "passkey",
      "name": "Acme Corp",
      "last_used_at": 0
    }
  ],
  "password_enabled": false,
  "two_factor_enabled": false,
  "totp_enabled": false,
  "backup_code_enabled": false,
  "mfa_enabled_at": 0,
  "mfa_disabled_at": 0,
  "password_last_updated_at": 0,
  "external_accounts": [
    {
      "object": "external_account",
      "id": "example",
      "provider": "example",
      "identification_id": "idn_2abc4xyz567Q9zZdEf",
      "provider_user_id": "prov_2abc4xyz567Q9zZdEf",
      "approved_scopes": "example",
      "email_address": "jane@example.com",
      "email_address_verified": false,
      "first_name": "Jane",
      "last_name": "Doe",
      "avatar_url": "example",
      "image_url": "example",
      "username": "jane.doe",
      "phone_number": "+15551234567",
      "public_metadata": {},
      "label": "example",
      "created_at": 0,
      "updated_at": 0
    }
  ],
  "saml_accounts": [
    {
      "id": "example",
      "object": "saml_account",
      "provider": "example",
      "active": false,
      "email_address": "jane@example.com",
      "first_name": "Jane",
      "last_name": "Doe",
      "provider_user_id": "prov_2abc4xyz567Q9zZdEf",
      "last_authenticated_at": 0,
      "public_metadata": {}
    }
  ],
  "enterprise_accounts": [
    {
      "id": "example",
      "object": "enterprise_account",
      "protocol": "oauth",
      "provider": "example",
      "active": false,
      "email_address": "jane@example.com",
      "first_name": "Jane",
      "last_name": "Doe",
      "provider_user_id": "prov_2abc4xyz567Q9zZdEf",
      "enterprise_connection_id": "ente_2abc4xyz567Q9zZdEf",
      "public_metadata": {},
      "last_authenticated_at": 0
    }
  ],
  "organization_memberships": [
    {
      "id": "example",
      "object": "organization_membership",
      "role": "admin",
      "role_name": "Admin",
      "permissions": [
        "example"
      ],
      "public_metadata": {},
      "private_metadata": {},
      "organization": {},
      "public_user_data": {},
      "created_at": 0,
      "updated_at": 0
    }
  ],
  "last_sign_in_at": 0,
  "banned": false,
  "locked": false,
  "deprovisioned": false,
  "lockout_expires_in_seconds": 1747939800,
  "verification_attempts_remaining": 0,
  "updated_at": 0,
  "created_at": 0,
  "delete_self_enabled": false,
  "create_organization_enabled": false,
  "create_organizations_limit": 0,
  "last_active_at": 1700690400000,
  "legal_accepted_at": 1700690400000,
  "bypass_client_trust": false,
  "scim": {
    "directory_id": "dire_2abc4xyz567Q9zZdEf",
    "directory_enabled": false,
    "external_id": "exte_2abc4xyz567Q9zZdEf"
  }
}