Clerk Frontend API Reference Documentation

Skip to main content

Show sidebar

GET

Server: https://{domain}.clerk.accounts.dev

/.well-known/assetlinks.json

Copy URL

Send Send get request to https://{domain}.clerk.accounts.dev/.well-known/assetlinks.json

GET

Copy URLSend Send get request to https://{domain}.clerk.accounts.dev/.well-known/assetlinks.json

Close Client

Get Android Asset Links

AllAuthCookiesHeadersQuery

All

Authentication

Select Auth Type

No authentication selected

Variables

Enabled Key Value

Cookies

Enabled Key Value

Headers

Enabled Key Value
accept application/json

Query Parameters

Enabled Key Value

Request Body

No Body

None

Code Snippet (Collapsed)

Shell Curl

Response

AllCookiesHeadersBody

All

Powered By Scalar.com

.,,uod8B8bou,,. ..,uod8BBBBBBBBBBBBBBBBRPFT?l!i:. ||||||||||||||!?TFPRBBBBBBBBBBBBBBB8m=, |||| '""^^!!||||||||||TFPRBBBVT!:...! |||| '""^^!!|||||?!:.......! |||| ||||.........! |||| ||||.........! |||| ||||.........! |||| ||||.........! |||| ||||.........! |||| ||||.........! ||||, ||||.........` |||||!!-._ ||||.......;. ':!|||||||||!!-._ ||||.....bBBBBWdou,. bBBBBB86foi!|||||||!!-..:|||!..bBBBBBBBBBBBBBBY! ::!?TFPRBBBBBB86foi!||||||||!!bBBBBBBBBBBBBBBY..! :::::::::!?TFPRBBBBBB86ftiaabBBBBBBBBBBBBBBY....! :::;`"^!:;::::::!?TFPRBBBBBBBBBBBBBBBBBBBY......! ;::::::...''^::::::::::!?TFPRBBBBBBBBBBY........! .ob86foi;::::::::::::::::::::::::!?TFPRBY..........` .b888888888886foi;:::::::::::::::::::::::..........` .b888888888888888888886foi;::::::::::::::::...........b888888888888888888888888888886foi;:::::::::......`!Tf998888888888888888888888888888888886foi;:::....` '"^!|Tf9988888888888888888888888888888888!::..` '"^!|Tf998888888888888888888888889!! '` '"^!|Tf9988888888888888888!!` iBBbo. '"^!|Tf998888888889!` WBBBBbo. '"^!|Tf9989!` YBBBP^' '"^!` `

Send Request

ctrlControl

↵Enter

How can I help you today?

Type a Request To get Started

Clerk Frontend API

Clerk Platform API

Clerk Backend API

Scalar

Scalar

By messaging Agent Scalar you agree to our Terms and Privacy Policy.

Close Client

v1

OpenAPI 3.0.3

Clerk Frontend API

Clerk Team

MIT

Terms of Service

Download OpenAPI Document json Download OpenAPI Document yaml

The Clerk REST Frontend API, meant to be accessed from a browser or native environment.

This is a Form Based API and all the data must be sent and formatted according to the application/x-www-form-urlencoded content type.

Versions

When the API changes in a way that isn't compatible with older versions, a new version is released. Each version is identified by its release date, e.g. 2021-02-05. For more information, please see Clerk API Versions.

Using the Try It Console

The Try It feature of the docs only works for Development Instances when using the DevBrowser security scheme. To use it, first generate a dev instance token from the /v1/dev_browser endpoint.

Please see https://clerk.com/docs for more information.

Server

Server:https://{domain}.clerk.accounts.dev

domain

AuthenticationRequired

Selected Auth Type: DevBrowser & Session
DevBrowser: query
Name :
__dev_session
Clear Value
Value :
Show Password
Session: header
Name :
__session
Clear Value
Value :
Show Password

Client Libraries

Shell

Ruby

Node.js

PHP

Python

MoreSelect from all clients

Shell Curl

Environment (Collapsed)

​Copy link

Used to get and update the current Environment

Environment Operations

Get environment

​Copy link

Auth Optional

Get the current environment. The environment contains information about the settings and features enabled for the current instance.

Responses

Returns the environment.

application/json

Request was not successful

application/json

Request was not successful

application/json

Request Example for get/v1/environment

Shell Curl

curl https://example-destined-camel-13.clerk.accounts.dev/v1/environment

Copy

Copy

Ask AI Agent

Test Request(get /v1/environment)

Status: 200Status: 400Status: 401

Show Schema

{ "auth_config": { "object": "auth_config", "id": "string", "first_name": "on", "last_name": "on", "email_address": "on", "phone_number": "on", "username": "on", "password": "on", "identification_requirements": [\ [\ "string"\ ]\ ], "identification_strategies": [\ "string"\ ], "first_factors": [\ "string"\ ], "second_factors": [\ "string"\ ], "email_address_verification_strategies": [\ "string"\ ], "single_session_mode": true, "enhanced_email_deliverability": true, "test_mode": true, "url_based_session_syncing": true, "claimed_at": null, "reverification": true, "native_settings": { "object": "native_settings", "api_enabled": true, "trusted_device_sign_in_enabled": true, "trusted_device_enrollment_prompt_after_sign_in_enabled": true, "trusted_device_enrollment_prompt_after_sign_up_enabled": true } }, "display_config": { "object": "display_config", "id": "string", "instance_environment_type": "production", "application_name": "string", "theme": {}, "preferred_sign_in_strategy": "password", "logo_image_url": null, "favicon_image_url": null, "home_url": "string", "sign_in_url": "string", "sign_up_url": "string", "user_profile_url": "string", "waitlist_url": "string", "oauth_consent_url": "string", "after_sign_in_url": "string", "after_sign_up_url": "string", "after_sign_out_one_url": "string", "after_sign_out_all_url": "string", "after_switch_session_url": "string", "after_join_waitlist_url": "string", "organization_profile_url": "string", "create_organization_url": "string", "after_leave_organization_url": "string", "after_create_organization_url": "string", "logo_link_url": "string", "support_email": null, "branded": true, "experimental_force_oauth_first": true, "clerk_js_version": null, "show_devmode_warning": true, "google_one_tap_client_id": null, "help_url": null, "privacy_policy_url": null, "terms_url": null, "captcha_public_key": null, "captcha_widget_type": "smart", "captcha_public_key_invisible": null, "captcha_provider": "turnstile", "captcha_oauth_bypass": [\ "string"\ ], "captcha_heartbeat": null }, "user_settings": { "attributes": { "email_address": { "enabled": true, "required": true, "used_for_first_factor": true, "first_factors": [\ "string"\ ], "used_for_second_factor": true, "second_factors": [\ "string"\ ], "verifications": [\ "string"\ ], "verify_at_sign_up": true, "immutable": true }, "phone_number": { "enabled": true, "required": true, "used_for_first_factor": true, "first_factors": [\ "string"\ ], "used_for_second_factor": true, "second_factors": [\ "string"\ ], "verifications": [\ "string"\ ], "verify_at_sign_up": true, "immutable": true }, "username": { "enabled": true, "required": true, "used_for_first_factor": true, "first_factors": [\ "string"\ ], "used_for_second_factor": true, "second_factors": [\ "string"\ ], "verifications": [\ "string"\ ], "verify_at_sign_up": true, "immutable": true }, "web3_wallet": { "enabled": true, "required": true, "used_for_first_factor": true, "first_factors": [\ "string"\ ], "used_for_second_factor": true, "second_factors": [\ "string"\ ], "verifications": [\ "string"\ ], "verify_at_sign_up": true, "immutable": true }, "first_name": { "enabled": true, "required": true, "used_for_first_factor": true, "first_factors": [\ "string"\ ], "used_for_second_factor": true, "second_factors": [\ "string"\ ], "verifications": [\ "string"\ ], "verify_at_sign_up": true, "immutable": true }, "last_name": { "enabled": true, "required": true, "used_for_first_factor": true, "first_factors": [\ "string"\ ], "used_for_second_factor": true, "second_factors": [\ "string"\ ], "verifications": [\ "string"\ ], "verify_at_sign_up": true, "immutable": true }, "password": { "enabled": true, "required": true, "used_for_first_factor": true, "first_factors": [\ "string"\ ], "used_for_second_factor": true, "second_factors": [\ "string"\ ], "verifications": [\ "string"\ ], "verify_at_sign_up": true, "immutable": true }, "authenticator_app": { "enabled": true, "required": true, "used_for_first_factor": true, "first_factors": [\ "string"\ ], "used_for_second_factor": true, "second_factors": [\ "string"\ ], "verifications": [\ "string"\ ], "verify_at_sign_up": true, "immutable": true }, "ticket": { "enabled": true, "required": true, "used_for_first_factor": true, "first_factors": [\ "string"\ ], "used_for_second_factor": true, "second_factors": [\ "string"\ ], "verifications": [\ "string"\ ], "verify_at_sign_up": true, "immutable": true }, "backup_code": { "enabled": true, "required": true, "used_for_first_factor": true, "first_factors": [\ "string"\ ], "used_for_second_factor": true, "second_factors": [\ "string"\ ], "verifications": [\ "string"\ ], "verify_at_sign_up": true, "immutable": true }, "passkey": { "enabled": true, "required": true, "used_for_first_factor": true, "first_factors": [\ "string"\ ], "used_for_second_factor": true, "second_factors": [\ "string"\ ], "verifications": [\ "string"\ ], "verify_at_sign_up": true, "immutable": true } }, "social": { "oauth_apple": { "enabled": true, "required": true, "authenticatable": true, "block_email_subaddresses": true, "strategy": "string", "not_selectable": true, "deprecated": true, "name": "Google", "logo_url": "https://img.clerk.com/static/google.png" }, "oauth_atlassian": { "enabled": true, "required": true, "authenticatable": true, "block_email_subaddresses": true, "strategy": "string", "not_selectable": true, "deprecated": true, "name": "Google", "logo_url": "https://img.clerk.com/static/google.png" }, "oauth_bitbucket": { "enabled": true, "required": true, "authenticatable": true, "block_email_subaddresses": true, "strategy": "string", "not_selectable": true, "deprecated": true, "name": "Google", "logo_url": "https://img.clerk.com/static/google.png" }, "oauth_box": { "enabled": true, "required": true, "authenticatable": true, "block_email_subaddresses": true, "strategy": "string", "not_selectable": true, "deprecated": true, "name": "Google", "logo_url": "https://img.clerk.com/static/google.png" }, "oauth_coinbase": { "enabled": true, "required": true, "authenticatable": true, "block_email_subaddresses": true, "strategy": "string", "not_selectable": true, "deprecated": true, "name": "Google", "logo_url": "https://img.clerk.com/static/google.png" }, "oauth_custom_mock": { "enabled": true, "required": true, "authenticatable": true, "block_email_subaddresses": true, "strategy": "string", "not_selectable": true, "deprecated": true, "name": "Google", "logo_url": "https://img.clerk.com/static/google.png" }, "oauth_discord": { "enabled": true, "required": true, "authenticatable": true, "block_email_subaddresses": true, "strategy": "string", "not_selectable": true, "deprecated": true, "name": "Google", "logo_url": "https://img.clerk.com/static/google.png" }, "oauth_dropbox": { "enabled": true, "required": true, "authenticatable": true, "block_email_subaddresses": true, "strategy": "string", "not_selectable": true, "deprecated": true, "name": "Google", "logo_url": "https://img.clerk.com/static/google.png" }, "oauth_enstall": { "enabled": true, "required": true, "authenticatable": true, "block_email_subaddresses": true, "strategy": "string", "not_selectable": true, "deprecated": true, "name": "Google", "logo_url": "https://img.clerk.com/static/google.png" }, "oauth_expressen": { "enabled": true, "required": true, "authenticatable": true, "block_email_subaddresses": true, "strategy": "string", "not_selectable": true, "deprecated": true, "name": "Google", "logo_url": "https://img.clerk.com/static/google.png" }, "oauth_facebook": { "enabled": true, "required": true, "authenticatable": true, "block_email_subaddresses": true, "strategy": "string", "not_selectable": true, "deprecated": true, "name": "Google", "logo_url": "https://img.clerk.com/static/google.png" }, "oauth_github": { "enabled": true, "required": true, "authenticatable": true, "block_email_subaddresses": true, "strategy": "string", "not_selectable": true, "deprecated": true, "name": "Google", "logo_url": "https://img.clerk.com/static/google.png" }, "oauth_gitlab": { "enabled": true, "required": true, "authenticatable": true, "block_email_subaddresses": true, "strategy": "string", "not_selectable": true, "deprecated": true, "name": "Google", "logo_url": "https://img.clerk.com/static/google.png" }, "oauth_google": { "enabled": true, "required": true, "authenticatable": true, "block_email_subaddresses": true, "strategy": "string", "not_selectable": true, "deprecated": true, "name": "Google", "logo_url": "https://img.clerk.com/static/google.png" }, "oauth_hubspot": { "enabled": true, "required": true, "authenticatable": true, "block_email_subaddresses": true, "strategy": "string", "not_selectable": true, "deprecated": true, "name": "Google", "logo_url": "https://img.clerk.com/static/google.png" }, "oauth_huggingface": { "enabled": true, "required": true, "authenticatable": true, "block_email_subaddresses": true, "strategy": "string", "not_selectable": true, "deprecated": true, "name": "Google", "logo_url": "https://img.clerk.com/static/google.png" }, "oauth_instagram": { "enabled": true, "required": true, "authenticatable": true, "block_email_subaddresses": true, "strategy": "string", "not_selectable": true, "deprecated": true, "name": "Google", "logo_url": "https://img.clerk.com/static/google.png" }, "oauth_line": { "enabled": true, "required": true, "authenticatable": true, "block_email_subaddresses": true, "strategy": "string", "not_selectable": true, "deprecated": true, "name": "Google", "logo_url": "https://img.clerk.com/static/google.png" }, "oauth_linear": { "enabled": true, "required": true, "authenticatable": true, "block_email_subaddresses": true, "strategy": "string", "not_selectable": true, "deprecated": true, "name": "Google", "logo_url": "https://img.clerk.com/static/google.png" }, "oauth_linkedin": { "enabled": true, "required": true, "authenticatable": true, "block_email_subaddresses": true, "strategy": "string", "not_selectable": true, "deprecated": true, "name": "Google", "logo_url": "https://img.clerk.com/static/google.png" }, "oauth_linkedin_oidc": { "enabled": true, "required": true, "authenticatable": true, "block_email_subaddresses": true, "strategy": "string", "not_selectable": true, "deprecated": true, "name": "Google", "logo_url": "https://img.clerk.com/static/google.png" }, "oauth_microsoft": { "enabled": true, "required": true, "authenticatable": true, "block_email_subaddresses": true, "strategy": "string", "not_selectable": true, "deprecated": true, "name": "Google", "logo_url": "https://img.clerk.com/static/google.png" }, "oauth_mock": { "enabled": true, "required": true, "authenticatable": true, "block_email_subaddresses": true, "strategy": "string", "not_selectable": true, "deprecated": true, "name": "Google", "logo_url": "https://img.clerk.com/static/google.png" }, "oauth_notion": { "enabled": true, "required": true, "authenticatable": true, "block_email_subaddresses": true, "strategy": "string", "not_selectable": true, "deprecated": true, "name": "Google", "logo_url": "https://img.clerk.com/static/google.png" }, "oauth_slack": { "enabled": true, "required": true, "authenticatable": true, "block_email_subaddresses": true, "strategy": "string", "not_selectable": true, "deprecated": true, "name": "Google", "logo_url": "https://img.clerk.com/static/google.png" }, "oauth_spotify": { "enabled": true, "required": true, "authenticatable": true, "block_email_subaddresses": true, "strategy": "string", "not_selectable": true, "deprecated": true, "name": "Google", "logo_url": "https://img.clerk.com/static/google.png" }, "oauth_tiktok": { "enabled": true, "required": true, "authenticatable": true, "block_email_subaddresses": true, "strategy": "string", "not_selectable": true, "deprecated": true, "name": "Google", "logo_url": "https://img.clerk.com/static/google.png" }, "oauth_twitch": { "enabled": true, "required": true, "authenticatable": true, "block_email_subaddresses": true, "strategy": "string", "not_selectable": true, "deprecated": true, "name": "Google", "logo_url": "https://img.clerk.com/static/google.png" }, "oauth_twitter": { "enabled": true, "required": true, "authenticatable": true, "block_email_subaddresses": true, "strategy": "string", "not_selectable": true, "deprecated": true, "name": "Google", "logo_url": "https://img.clerk.com/static/google.png" }, "oauth_x": { "enabled": true, "required": true, "authenticatable": true, "block_email_subaddresses": true, "strategy": "string", "not_selectable": true, "deprecated": true, "name": "Google", "logo_url": "https://img.clerk.com/static/google.png" }, "oauth_xero": { "enabled": true, "required": true, "authenticatable": true, "block_email_subaddresses": true, "strategy": "string", "not_selectable": true, "deprecated": true, "name": "Google", "logo_url": "https://img.clerk.com/static/google.png" } }, "saml": { "enabled": true, "self_serve_sso": true }, "enterprise_sso": { "enabled": true, "self_serve_sso": true }, "sign_in": { "second_factor": { "required": true } }, "sign_up": { "captcha_enabled": true, "captcha_widget_type": "smart", "custom_action_required": true, "progressive": true, "mode": "public", "legal_consent_enabled": true }, "restrictions": { "allowlist": { "enabled": true }, "blocklist": { "enabled": true }, "allowlist_blocklist_disabled_on_sign_in": { "enabled": true }, "block_email_subaddresses": { "enabled": true }, "block_disposable_email_domains": { "enabled": true } }, "password_settings": { "disable_hibp": true, "disable_password_reverification": true, "min_length": 1, "max_length": 1, "require_special_char": true, "require_numbers": true, "require_uppercase": true, "require_lowercase": true, "show_zxcvbn": true, "min_zxcvbn_strength": 0, "enforce_hibp_on_sign_in": true, "allowed_special_characters": "string" }, "username_settings": { "min_length": null, "max_length": null, "allow_extended_special_characters": true, "allow_numeric_usernames": true }, "actions": { "delete_self": true, "create_organization": true, "create_organizations_limit": null }, "attack_protection": { "user_lockout": { "enabled": true, "max_attempts": 1, "duration_in_minutes": 1 }, "pii": { "enabled": true }, "email_link": { "require_same_client": true }, "enumeration_protection": { "enabled": true } }, "passkey_settings": { "allow_autofill": true, "show_sign_in_button": true, "satisfies_second_factor": true } }, "organization_settings": { "enabled": true, "max_allowed_memberships": 1, "actions": { "admin_delete": true }, "domains": { "enabled": true, "enrollment_modes": [\ "manual_invitation"\ ], "default_role": "string" }, "slug": { "disabled": true }, "creator_role": "string" }, "fraud_settings": { "object": "fraud_settings", "native": { "device_attestation_mode": "disabled" } }, "commerce_settings": { "billing": { "stripe_publishable_key": null, "free_trial_requires_payment_method": true, "user": { "enabled": true, "has_paid_plans": true }, "organization": { "enabled": true, "has_paid_plans": true } } }, "api_keys_settings": { "enabled": true, "user_api_keys_enabled": true, "orgs_api_keys_enabled": true }, "protect_config": { "loaders": [\ {\ "rollout": 0,\ "type": "string",\ "target": "string",\ "attributes": {\ "additionalProperty": "string"\ },\ "textContent": "string"\ }\ ] }, "client_debug_mode": true, "partitioned_cookies": true, "maintenance_mode": true }

JSONCopy

JSONCopy

Returns the environment.

Update environment

​Copy link

Auth Optional

Update environment using request origin

Headers

Type: string

required

Origin of the request

Responses

Returns the environment.

application/json

Request was not successful

application/json

Request was not successful

application/json

Request Example for patch/v1/environment

Shell Curl

curl https://example-destined-camel-13.clerk.accounts.dev/v1/environment \
  --request PATCH \
  --header 'Origin: '

cURLCopy

cURLCopy

Ask AI Agent

Test Request(patch /v1/environment)

Status: 200Status: 400Status: 401

Show Schema

JSONCopy

JSONCopy

Returns the environment.

Client (Collapsed)

​Copy link

Used to interact with the Client Object.

Client Operations

Show More

Sessions (Collapsed)

​Copy link

Used to interact with the sessions of a client.

Sessions Operations

Show More

Sign Ins (Collapsed)

​Copy link

Used to sign in a user in the current client.

Sign Ins Operations

Show More

Sign Ups (Collapsed)

​Copy link

Used to sign up a new user in the current client.

Sign Ups Operations

Show More

User (Collapsed)

​Copy link

Used to interact with the properties of the current user.

User Operations

Show More

Active Sessions (Collapsed)

​Copy link

Used to interact with the sessions of the current user.

Active Sessions Operations

Show More

Email Addresses (Collapsed)

​Copy link

Used to interact with the email addresses of the logged in user.

Email Addresses Operations

Show More

Phone Numbers (Collapsed)

​Copy link

Used to interact with the phone numbers of the logged in user.

Phone Numbers Operations

Show More

Web3 Wallets (Collapsed)

​Copy link

Used to interact with the web3 wallets of the logged in user.

Web3 Wallets Operations

Show More

Passkeys (Collapsed)

​Copy link

Used to interact with the passkeys of the logged in user.

Passkeys Operations

Show More

Trusted Devices (Collapsed)

​Copy link

Used to interact with native trusted-device credentials of the logged in user.

Trusted Devices Operations

Show More

External Accounts (Collapsed)

​Copy link

Used to interact with the external accounts of the current user.

External Accounts Operations

Show More

TOTP (Collapsed)

​Copy link

Used to interact with One Time Password authenticators of the current user.

TOTP Operations

Show More

Backup Codes (Collapsed)

​Copy link

Used to interact with the two factor authentication backup codes of the current user.

Backup Codes Operations

Show More

Organizations Memberships (Collapsed)

​Copy link

Used to interact with the current user's organization memberships, invitations and suggestions.

Organizations Memberships Operations

Show More

API Keys (Collapsed)

​Copy link

Endpoints for managing API Keys

API Keys Operations

Show More

Organization (Collapsed)

​Copy link

Used to interact with an organization and its properties. The current user must be an administrator to access them.

Organization Operations

Show More

Organization Creation Defaults (Collapsed)

​Copy link

Used to get suggested defaults when creating a new organization.

Organization Creation Defaults Operations

Show More

Invitations (Collapsed)

​Copy link

Used to interact with the invitations of an organization. The current user must be an administrator to access them.

Invitations Operations

Show More

Membership Requests (Collapsed)

​Copy link

Used to interact with the members of an organization. The current user must be an administrator to access them.

Membership Requests Operations

Show More

Members (Collapsed)

​Copy link

Used to interact with the members of an organization. The current user must be an administrator to access them.

Members Operations

Show More

Domains (Collapsed)

​Copy link

Used to interact with the members of an organization. The current user must be an administrator to access them.

Domains Operations

Show More

Roles (Collapsed)

​Copy link

Roles Operations

Show More

Plans (Collapsed)

​Copy link

Used to interact with plans that users and organizations can purchase.

Plans Operations

Show More

Subscriptions (Collapsed)

​Copy link

Used to interact with subscriptions belonging to users and organizations.

Subscriptions Operations

Show More

Subscription Items (Collapsed)

​Copy link

Used to interact with subscription items belonging to users and organizations.

Subscription Items Operations

Show More

Checkouts (Collapsed)

​Copy link

Used to interact with the checkout flow.

Checkouts Operations

Show More

Payment Methods (Collapsed)

​Copy link

Used to interact with payment methods belonging to users and organizations.

Payment Methods Operations

Show More

Statements (Collapsed)

​Copy link

Used to interact with billing statements for users and organizations.

Statements Operations

Show More

Payment Attempts (Collapsed)

​Copy link

Used to interact with payment attempts for users and organizations.

Payment Attempts Operations

Show More

Well Known (Collapsed)

​Copy link

Well-known endpoints like JWKS, deep linking, and openid-configuration.

Well Known Operations

Show More

DevBrowser (Collapsed)

​Copy link

Used to handle dev browsers.

DevBrowser Operations

Show More

DevTools (Collapsed)

​Copy link

Used to configure development instance settings.

Health (Collapsed)

​Copy link

Used to get the health status of the API.

Health Operations

Show More

OAuth2 Identity Provider (Collapsed)

​Copy link

Requests for the OAuth2 authorization flow.

OAuth2 Identity Provider Operations

Show More

OAuth2 Callbacks (Collapsed)

​Copy link

Used to receive callbacks from successful OAuth attempts.

OAuth2 Callbacks Operations

Show More

SAML (Collapsed)

​Copy link

Used in authentication flows using SAML.

SAML Operations

Show More

Waitlist (Collapsed)

​Copy link

Used to interact with the waitlist.

Waitlist Operations

Show More

Enterprise Connections (Collapsed)

​Copy link

Endpoints for managing enterprise connections.

Enterprise Connections Operations

Show More

Get account portal

​Copy link

Auth Required

Get users account portal

Responses

Returns the account portal.

application/json

Request was not successful

application/json

Request was not successful

application/json

Request was not successful

application/json

Request Example for get/v1/account_portal

Shell Curl

curl 'https://example-destined-camel-13.clerk.accounts.dev/v1/account_portal?__dev_session=YOUR_SECRET_TOKEN' \
  --header '__session: YOUR_SECRET_TOKEN'

cURLCopy

cURLCopy

Ask AI Agent

Test Request(get /v1/account_portal)

Status: 200Status: 400Status: 401Status: 404

Show Schema

{
  "object": "account_portal",
  "allowed": true,
  "enabled": true,
  "internal_linking": true,
  "after_sign_in_url": "string",
  "after_sign_up_url": "string",
  "after_join_waitlist_url": "string",
  "after_create_organization_url": "string",
  "after_leave_organization_url": "string",
  "logo_link_url": "string",
  "customization": {
    "appearance": "auto",
    "background_color_dark": null,
    "background_color_light": null,
    "primary_color_dark": null,
    "primary_color_light": null
  }
}

JSONCopy

JSONCopy

Returns the account portal.

Get Proxy Health

​Copy link

Auth Required

Use this endpoint to check the validity of a proxy configuration for a domain. Pass the instance ID and domain ID as query parameters.

Query Parameters

Type: string

required

The ID of the domain

Headers

Type: string

required

The URL of the proxy

Type: string

required

The secret key of the proxy

Type: string

required

The IP address of the client

Responses

Configuration is valid

application/json

Request was not successful

application/json

Configuration is invalid or service is unavailable

application/json

Request Example for get/v1/proxy-health

Shell Curl

curl 'https://example-destined-camel-13.clerk.accounts.dev/v1/proxy-health?domain_id=&__dev_session=YOUR_SECRET_TOKEN' \
  --header 'Clerk-Proxy-Url: ' \
  --header 'Clerk-Secret-Key: ' \
  --header 'X-Forwarded-For: ' \
  --header '__session: YOUR_SECRET_TOKEN'

cURLCopy

cURLCopy

Ask AI Agent

Test Request(get /v1/proxy-health)

Status: 200Status: 400Status: 503

Show Schema

{
  "status": "healthy",
  "x_forwarded_for": "string"
}

JSONCopy

JSONCopy

Configuration is valid

Sync clients across multiple domains

​Copy link

Auth Required

Start the syncing process between a satellite and primary domain.

Query Parameters

Type: string

The satellite domain which should be synced with its primary.

Type: string

The URL to redirect to after the syncing process has been completed.

Responses

Redirect

Request was not successful

application/json

Request was not successful

application/json

Request was not successful

application/json

Request Example for get/v1/client/sync

Shell Curl

curl 'https://example-destined-camel-13.clerk.accounts.dev/v1/client/sync?__dev_session=YOUR_SECRET_TOKEN' \
  --header '__session: YOUR_SECRET_TOKEN'

cURLCopy

cURLCopy

Ask AI Agent

Test Request(get /v1/client/sync)

Status: 307Status: 400Status: 403Status: 422

No Body

Redirect

Link clients across multiple domains

​Copy link

Auth Required

Complete a syncing process between a satellite and primary domains by linking their clients.

Query Parameters

Type: string

The token generated from a sync request.

Responses

Redirect

Request was not successful

application/json

Request was not successful

application/json

Request was not successful

application/json

Request Example for get/v1/client/link

Shell Curl

curl 'https://example-destined-camel-13.clerk.accounts.dev/v1/client/link?__dev_session=YOUR_SECRET_TOKEN' \
  --header '__session: YOUR_SECRET_TOKEN'

cURLCopy

cURLCopy

Ask AI Agent

Test Request(get /v1/client/link)

Status: 307Status: 400Status: 403Status: 422

No Body

Redirect

Post Dev Browser init set cookie

​Copy link

Auth Required

post dev_browser/set_first_party_cookie

Responses

A cookie for the dev browser was set.

Request Example for post/v1/dev_browser/set_first_party_cookie

Shell Curl

curl 'https://example-destined-camel-13.clerk.accounts.dev/v1/dev_browser/set_first_party_cookie?__dev_session=YOUR_SECRET_TOKEN' \
  --request POST \
  --header '__session: YOUR_SECRET_TOKEN'

cURLCopy

cURLCopy

Ask AI Agent

Test Request(post /v1/dev_browser/set_first_party_cookie)

Status: 200

No Body

A cookie for the dev browser was set.

Initialize dev browser for development and staging instances

​Copy link

Auth Required

get dev_browser/init

Query Parameters

Type: string

The origin of the request

Responses

Successfully initialized the dev browser.

Request was not successful

application/json

Request was not successful

application/json

Request Example for get/v1/dev_browser/init

Shell Curl

curl 'https://example-destined-camel-13.clerk.accounts.dev/v1/dev_browser/init?__dev_session=YOUR_SECRET_TOKEN' \
  --header '__session: YOUR_SECRET_TOKEN'

cURLCopy

cURLCopy

Ask AI Agent

Test Request(get /v1/dev_browser/init)

Status: 200Status: 400Status: 500

No Body

Successfully initialized the dev browser.

Set the Clear-Site-Data header

​Copy link

Auth Required

Clear browsing data (cookies, storage, cache) associated with the requesting website

Responses

The Clear-Site-Data header was set with wildcard value.

Request Example for get/v1/clear-site-data

Shell Curl

curl 'https://example-destined-camel-13.clerk.accounts.dev/v1/clear-site-data?__dev_session=YOUR_SECRET_TOKEN' \
  --header '__session: YOUR_SECRET_TOKEN'

cURLCopy

cURLCopy

Ask AI Agent

Test Request(get /v1/clear-site-data)

Status: 200

No Body

The Clear-Site-Data header was set with wildcard value.

Models

Show More

Feedback

What did you think of this content?

It was helpfulIt was not helpfulI have feedback

Show sidebar

GET

Server: https://{domain}.clerk.accounts.dev

/.well-known/assetlinks.json

Copy URL

Send Send get request to https://{domain}.clerk.accounts.dev/.well-known/assetlinks.json

GET

Copy URLSend Send get request to https://{domain}.clerk.accounts.dev/.well-known/assetlinks.json

Close Client

Get Android Asset Links

AllAuthCookiesHeadersQuery

All

Authentication

Selected Auth Type: DevBrowser & Session

Variables

Enabled Key Value

Cookies

Enabled Key Value

Headers

Enabled Key Value
accept application/json

Query Parameters

Enabled Key Value

Request Body

No Body

None

Code Snippet (Collapsed)

Shell Curl

Response

AllCookiesHeadersBody

All

Powered By Scalar.com

Send Request

ctrlControl

↵Enter

Support