3.0.0
Search…
⌃K
Links

Users

This object represents a verified user in your instance.

Available requests

  • GET /v1/users/:id
  • GET /v1/users
  • GET /v1/users/count
  • POST /v1/users
  • PATCH/v1/users/:id
  • PATCH/v1/users/:id/metadata
  • POST /v1/users/:id/profile_image
  • POST /v1/users/:id/verify_password
  • DELETE /v1/users/:id
  • GET /v1/users/:id/oauth_access_tokens/:provider
  • GET/v1/users/:id/organization_memberships
  • DELETE /v1/users/:id/mfa

Example user schema

{
"id": "user_1oBNj55jOjSK9rOYrT5QHqj7eaK",
"object": "user",
"external_id": "my_previous_auth_solution_id",
"username": null,
"first_name": "Boss",
"last_name": "Clerk",
"profile_image_url": "https://images.clerk.services/clerk/default-profile.svg",
"primary_email_address_id": "idn_1oBNgISXFbSf5m0uP2Wl0qWtNGX",
"primary_phone_number_id": null,
"primary_web3_wallet_id": null,
"password_enabled": true,
"two_factor_enabled": false,
"totp_enabled": false,
"backup_code_enabled": false,
"email_addresses": [
{
"id": "idn_1oBNgISXFbSf5m0uP2Wl0qWtNGX",
"object": "email_address",
"email_address": "[email protected]",
"verification": {
"status": "verified",
"strategy": "email_code",
"attempts": 1,
"expire_at": 1612756733
},
"linked_to": []
}
],
"phone_numbers": [
{
"id": "idn_1q8Uq8Mc4t7WWMy9Z6Og0gNJVui",
"object": "phone_number",
"phone_number": "+15555555555",
"reserved_for_second_factor": false,
"verification": {
"status": "verified",
"strategy": "phone_code",
"attempts": 1,
"expire_at": 1616461499
},
"linked_to": []
}
],
"web3_wallets": [
{
"id": "idn_23xyKkHEPpQQk9RzTCJVHsKoOTW",
"object": "web3_wallet",
"web3_wallet": "0x0000000000000000000000000000000000000000",
"verification": {
"status": "verified",
"strategy": "web3_metamask_signature",
"attempts": 1,
"expire_at": 1642690572653,
"nonce": "foz4bbtrtw283h0bz72r101d9t9uyjdyx0t84krg"
}
}
],
"external_accounts": [],
"public_metadata": {},
"private_metadata": {},
"created_at": 1612756155,
"updated_at": 1612756155
}

get
https://api.clerk.dev
/v1/users/:id
Retrieve a user
get
https://api.clerk.dev
/v1/users
List all users
get
https://api.clerk.dev
/v1/users/count
Count users
post
https://api.clerk.dev
/v1/users
Create a user
patch
https://api.clerk.dev
/v1/users/:id
Update a user
patch
https://api.clerk.dev
/v1/users/:id/metadata
Merge and update a user's metadata
post
https://api.clerk.dev
/v1/users/:id/profile_image
Set a user's profile image
post
https://api.clerk.dev
/v1/users/:id/verify_password
Verify a user's password
delete
https://api.clerk.dev
/v1/users/:id
Delete a user
get
https://api.clerk.dev/
v1/users/:id/oauth_access_tokens/:provider
Retrieve the OAuth access token of a user
get
https://api.clerk.dev
/v1/users/:id/organization_memberships
Retrieve all memberships for a user
delete
https://api.clerk.dev
/v1/users/:id/mfa
Disable all MFA configurations of a user