# Clerk API (unofficial showcase) > Clerk API (unofficial showcase) API documentation ## Actor_tokens - [POST /actor_tokens](https://octri-c7vy4azv5yd9.octri.dev/post-actor_tokens): Create actor token - [POST /actor_tokens/{actor_token_id}/revoke](https://octri-c7vy4azv5yd9.octri.dev/post-actor_tokens-actor_token_id-revoke): Revoke an actor token ## Admin_portal_link_tokens - [POST /admin_portal_link_tokens](https://octri-c7vy4azv5yd9.octri.dev/post-admin_portal_link_tokens): Create an admin portal link token - [POST /admin_portal_link_tokens/{adminPortalLinkTokenID}/revoke](https://octri-c7vy4azv5yd9.octri.dev/post-admin_portal_link_tokens-adminportallinktokenid-revoke): Revoke an admin portal link token ## Agents - [POST /agents/tasks](https://octri-c7vy4azv5yd9.octri.dev/post-agents-tasks): Create agent task - [POST /agents/tasks/{agent_task_id}/revoke](https://octri-c7vy4azv5yd9.octri.dev/post-agents-tasks-agent_task_id-revoke): Revoke an agent task ## Allowlist_identifiers - [GET /allowlist_identifiers](https://octri-c7vy4azv5yd9.octri.dev/get-allowlist_identifiers): List all identifiers on the allow-list - [POST /allowlist_identifiers](https://octri-c7vy4azv5yd9.octri.dev/post-allowlist_identifiers): Add identifier to the allow-list - [DELETE /allowlist_identifiers/{identifier_id}](https://octri-c7vy4azv5yd9.octri.dev/delete-allowlist_identifiers-identifier_id): Delete an identifier from the allow-list ## Api_keys - [GET /api_keys](https://octri-c7vy4azv5yd9.octri.dev/get-api_keys): List API keys for a subject - [POST /api_keys](https://octri-c7vy4azv5yd9.octri.dev/post-api_keys): Create an API key - [GET /api_keys/{apiKeyID}](https://octri-c7vy4azv5yd9.octri.dev/get-api_keys-apikeyid): Get an API key by ID - [PATCH /api_keys/{apiKeyID}](https://octri-c7vy4azv5yd9.octri.dev/patch-api_keys-apikeyid): Update an API key - [DELETE /api_keys/{apiKeyID}](https://octri-c7vy4azv5yd9.octri.dev/delete-api_keys-apikeyid): Delete an API key - [POST /api_keys/{apiKeyID}/revoke](https://octri-c7vy4azv5yd9.octri.dev/post-api_keys-apikeyid-revoke): Revoke an API key - [GET /api_keys/{apiKeyID}/secret](https://octri-c7vy4azv5yd9.octri.dev/get-api_keys-apikeyid-secret): Get an API key secret - [POST /api_keys/verify](https://octri-c7vy4azv5yd9.octri.dev/post-api_keys-verify): Verify an API key ## Beta_features - [PUT /beta_features/domain](https://octri-c7vy4azv5yd9.octri.dev/put-beta_features-domain): Update production instance domain - [PATCH /beta_features/instance_settings](https://octri-c7vy4azv5yd9.octri.dev/patch-beta_features-instance_settings): Update instance authentication settings ## Billing - [GET /billing/plans](https://octri-c7vy4azv5yd9.octri.dev/get-billing-plans): List all billing plans - [GET /billing/prices](https://octri-c7vy4azv5yd9.octri.dev/get-billing-prices): List all billing prices - [POST /billing/prices](https://octri-c7vy4azv5yd9.octri.dev/post-billing-prices): Create a custom billing price - [GET /billing/statements](https://octri-c7vy4azv5yd9.octri.dev/get-billing-statements): List all billing statements - [GET /billing/statements/{statementID}](https://octri-c7vy4azv5yd9.octri.dev/get-billing-statements-statementid): Get a billing statement - [GET /billing/statements/{statementID}/payment_attempts](https://octri-c7vy4azv5yd9.octri.dev/get-billing-statements-statementid-payment_attempts): List payment attempts for a billing statement - [GET /billing/subscription_items](https://octri-c7vy4azv5yd9.octri.dev/get-billing-subscription_items): List all subscription items - [DELETE /billing/subscription_items/{subscription_item_id}](https://octri-c7vy4azv5yd9.octri.dev/delete-billing-subscription_items-subscription_item_id): Cancel a subscription item - [POST /billing/subscription_items/{subscription_item_id}/discounts](https://octri-c7vy4azv5yd9.octri.dev/post-billing-subscription_items-subscription_item_id-discounts): Apply a discount to a subscription item - [DELETE /billing/subscription_items/{subscription_item_id}/discounts/{discount_id}](https://octri-c7vy4azv5yd9.octri.dev/delete-billing-subscription_items-subscription_item_id-discounts-discount_id): Remove a discount from a subscription item - [POST /billing/subscription_items/{subscription_item_id}/extend_free_trial](https://octri-c7vy4azv5yd9.octri.dev/post-billing-subscription_items-subscription_item_id-extend_free_trial): Extend free trial for a subscription item - [POST /billing/subscription_items/{subscription_item_id}/price_transition](https://octri-c7vy4azv5yd9.octri.dev/post-billing-subscription_items-subscription_item_id-price_transition): Create a price transition for a subscription item ## Blocklist_identifiers - [GET /blocklist_identifiers](https://octri-c7vy4azv5yd9.octri.dev/get-blocklist_identifiers): List all identifiers on the block-list - [POST /blocklist_identifiers](https://octri-c7vy4azv5yd9.octri.dev/post-blocklist_identifiers): Add identifier to the block-list - [DELETE /blocklist_identifiers/{identifier_id}](https://octri-c7vy4azv5yd9.octri.dev/delete-blocklist_identifiers-identifier_id): Delete an identifier from the block-list ## Clients - [GET /clients](https://octri-c7vy4azv5yd9.octri.dev/get-clients): List all clients - [GET /clients/{client_id}](https://octri-c7vy4azv5yd9.octri.dev/get-clients-client_id): Get a client - [POST /clients/verify](https://octri-c7vy4azv5yd9.octri.dev/post-clients-verify): Verify a client ## Directories - [GET /directories](https://octri-c7vy4azv5yd9.octri.dev/get-directories): List all directories - [POST /directories](https://octri-c7vy4azv5yd9.octri.dev/post-directories): Create a directory - [GET /directories/{directory_id}](https://octri-c7vy4azv5yd9.octri.dev/get-directories-directory_id): Retrieve a directory - [PATCH /directories/{directory_id}](https://octri-c7vy4azv5yd9.octri.dev/patch-directories-directory_id): Update a directory - [DELETE /directories/{directory_id}](https://octri-c7vy4azv5yd9.octri.dev/delete-directories-directory_id): Delete a directory - [GET /directories/{directory_id}/group_role_mappings](https://octri-c7vy4azv5yd9.octri.dev/get-directories-directory_id-group_role_mappings): List directory group role mappings - [POST /directories/{directory_id}/group_role_mappings](https://octri-c7vy4azv5yd9.octri.dev/post-directories-directory_id-group_role_mappings): Create a directory group role mapping - [PUT /directories/{directory_id}/group_role_mappings](https://octri-c7vy4azv5yd9.octri.dev/put-directories-directory_id-group_role_mappings): Replace directory group role mappings - [DELETE /directories/{directory_id}/group_role_mappings/{mapping_id}](https://octri-c7vy4azv5yd9.octri.dev/delete-directories-directory_id-group_role_mappings-mapping_id): Delete a directory group role mapping - [POST /directories/{directory_id}/rotate_api_key](https://octri-c7vy4azv5yd9.octri.dev/post-directories-directory_id-rotate_api_key): Rotate a directory's API key ## Domains - [GET /domains](https://octri-c7vy4azv5yd9.octri.dev/get-domains): List all instance domains - [POST /domains](https://octri-c7vy4azv5yd9.octri.dev/post-domains): Add a domain - [PATCH /domains/{domain_id}](https://octri-c7vy4azv5yd9.octri.dev/patch-domains-domain_id): Update a domain - [DELETE /domains/{domain_id}](https://octri-c7vy4azv5yd9.octri.dev/delete-domains-domain_id): Delete a domain ## Email_addresses - [POST /email_addresses](https://octri-c7vy4azv5yd9.octri.dev/post-email_addresses): Create an email address - [GET /email_addresses/{email_address_id}](https://octri-c7vy4azv5yd9.octri.dev/get-email_addresses-email_address_id): Get an email address - [PATCH /email_addresses/{email_address_id}](https://octri-c7vy4azv5yd9.octri.dev/patch-email_addresses-email_address_id): Update an email address - [DELETE /email_addresses/{email_address_id}](https://octri-c7vy4azv5yd9.octri.dev/delete-email_addresses-email_address_id): Delete an email address - [POST /email_addresses/{email_address_id}/attempt_verification](https://octri-c7vy4azv5yd9.octri.dev/post-email_addresses-email_address_id-attempt_verification): Verify a code sent to an email address - [POST /email_addresses/{email_address_id}/prepare_verification](https://octri-c7vy4azv5yd9.octri.dev/post-email_addresses-email_address_id-prepare_verification): Send a verification code to an email address ## Enterprise_connections - [GET /enterprise_connections](https://octri-c7vy4azv5yd9.octri.dev/get-enterprise_connections): List enterprise connections - [POST /enterprise_connections](https://octri-c7vy4azv5yd9.octri.dev/post-enterprise_connections): Create an enterprise connection - [GET /enterprise_connections/{enterprise_connection_id}](https://octri-c7vy4azv5yd9.octri.dev/get-enterprise_connections-enterprise_connection_id): Retrieve an enterprise connection - [PATCH /enterprise_connections/{enterprise_connection_id}](https://octri-c7vy4azv5yd9.octri.dev/patch-enterprise_connections-enterprise_connection_id): Update an enterprise connection - [DELETE /enterprise_connections/{enterprise_connection_id}](https://octri-c7vy4azv5yd9.octri.dev/delete-enterprise_connections-enterprise_connection_id): Delete an enterprise connection - [GET /enterprise_connections/{enterprise_connection_id}/test_runs](https://octri-c7vy4azv5yd9.octri.dev/get-enterprise_connections-enterprise_connection_id-test_runs): List enterprise connection test runs - [POST /enterprise_connections/{enterprise_connection_id}/test_runs](https://octri-c7vy4azv5yd9.octri.dev/post-enterprise_connections-enterprise_connection_id-test_runs): Create an enterprise connection test run ## Instance - [GET /instance](https://octri-c7vy4azv5yd9.octri.dev/get-instance): Get instance settings - [PATCH /instance](https://octri-c7vy4azv5yd9.octri.dev/patch-instance): Update instance settings - [POST /instance/change_domain](https://octri-c7vy4azv5yd9.octri.dev/post-instance-change_domain): Update production instance domain - [GET /instance/communication](https://octri-c7vy4azv5yd9.octri.dev/get-instance-communication): Get instance communication settings - [PATCH /instance/communication](https://octri-c7vy4azv5yd9.octri.dev/patch-instance-communication): Update instance communication settings - [GET /instance/oauth_application_settings](https://octri-c7vy4azv5yd9.octri.dev/get-instance-oauth_application_settings): Get OAuth application settings - [PATCH /instance/oauth_application_settings](https://octri-c7vy4azv5yd9.octri.dev/patch-instance-oauth_application_settings): Update OAuth application settings - [GET /instance/organization_settings](https://octri-c7vy4azv5yd9.octri.dev/get-instance-organization_settings): Get instance organization settings - [PATCH /instance/organization_settings](https://octri-c7vy4azv5yd9.octri.dev/patch-instance-organization_settings): Update instance organization settings - [GET /instance/protect](https://octri-c7vy4azv5yd9.octri.dev/get-instance-protect): Get instance Protect settings - [PATCH /instance/protect](https://octri-c7vy4azv5yd9.octri.dev/patch-instance-protect): Update instance Protect settings - [PATCH /instance/restrictions](https://octri-c7vy4azv5yd9.octri.dev/patch-instance-restrictions): Update instance restrictions ## Invitations - [GET /invitations](https://octri-c7vy4azv5yd9.octri.dev/get-invitations): List all invitations - [POST /invitations](https://octri-c7vy4azv5yd9.octri.dev/post-invitations): Create an invitation - [DELETE /invitations/{invitation_id}](https://octri-c7vy4azv5yd9.octri.dev/delete-invitations-invitation_id): Delete an invitation - [POST /invitations/{invitation_id}/revoke](https://octri-c7vy4azv5yd9.octri.dev/post-invitations-invitation_id-revoke): Revokes an invitation - [POST /invitations/bulk](https://octri-c7vy4azv5yd9.octri.dev/post-invitations-bulk): Create multiple invitations ## Jwks - [GET /jwks](https://octri-c7vy4azv5yd9.octri.dev/get-jwks): Get the instance JSON Web Key Set ## Jwt_templates - [GET /jwt_templates](https://octri-c7vy4azv5yd9.octri.dev/get-jwt_templates): List JWT templates - [POST /jwt_templates](https://octri-c7vy4azv5yd9.octri.dev/post-jwt_templates): Create a JWT template - [GET /jwt_templates/{template_id}](https://octri-c7vy4azv5yd9.octri.dev/get-jwt_templates-template_id): Get a JWT template - [PATCH /jwt_templates/{template_id}](https://octri-c7vy4azv5yd9.octri.dev/patch-jwt_templates-template_id): Update a JWT template - [DELETE /jwt_templates/{template_id}](https://octri-c7vy4azv5yd9.octri.dev/delete-jwt_templates-template_id): Delete a JWT template ## M2m_tokens - [GET /m2m_tokens](https://octri-c7vy4azv5yd9.octri.dev/get-m2m_tokens): List M2M tokens for a machine - [POST /m2m_tokens](https://octri-c7vy4azv5yd9.octri.dev/post-m2m_tokens): Create an M2M token - [POST /m2m_tokens/{m2m_token_id}/revoke](https://octri-c7vy4azv5yd9.octri.dev/post-m2m_tokens-m2m_token_id-revoke): Revoke an M2M token - [POST /m2m_tokens/verify](https://octri-c7vy4azv5yd9.octri.dev/post-m2m_tokens-verify): Verify an M2M token ## Machines - [GET /machines](https://octri-c7vy4azv5yd9.octri.dev/get-machines): Get a list of machines for an instance - [POST /machines](https://octri-c7vy4azv5yd9.octri.dev/post-machines): Create a machine - [GET /machines/{machine_id}](https://octri-c7vy4azv5yd9.octri.dev/get-machines-machine_id): Retrieve a machine - [PATCH /machines/{machine_id}](https://octri-c7vy4azv5yd9.octri.dev/patch-machines-machine_id): Update a machine - [DELETE /machines/{machine_id}](https://octri-c7vy4azv5yd9.octri.dev/delete-machines-machine_id): Delete a machine - [POST /machines/{machine_id}/scopes](https://octri-c7vy4azv5yd9.octri.dev/post-machines-machine_id-scopes): Create a machine scope - [DELETE /machines/{machine_id}/scopes/{other_machine_id}](https://octri-c7vy4azv5yd9.octri.dev/delete-machines-machine_id-scopes-other_machine_id): Delete a machine scope - [GET /machines/{machine_id}/secret_key](https://octri-c7vy4azv5yd9.octri.dev/get-machines-machine_id-secret_key): Retrieve a machine secret key - [POST /machines/{machine_id}/secret_key/rotate](https://octri-c7vy4azv5yd9.octri.dev/post-machines-machine_id-secret_key-rotate): Rotate a machine's secret key ## Oauth_applications - [GET /oauth_applications](https://octri-c7vy4azv5yd9.octri.dev/get-oauth_applications): Get a list of OAuth applications for an instance - [POST /oauth_applications](https://octri-c7vy4azv5yd9.octri.dev/post-oauth_applications): Create an OAuth application - [GET /oauth_applications/{oauth_application_id}](https://octri-c7vy4azv5yd9.octri.dev/get-oauth_applications-oauth_application_id): Retrieve an OAuth application by ID - [PATCH /oauth_applications/{oauth_application_id}](https://octri-c7vy4azv5yd9.octri.dev/patch-oauth_applications-oauth_application_id): Update an OAuth application - [DELETE /oauth_applications/{oauth_application_id}](https://octri-c7vy4azv5yd9.octri.dev/delete-oauth_applications-oauth_application_id): Delete an OAuth application - [PUT /oauth_applications/{oauth_application_id}/logo](https://octri-c7vy4azv5yd9.octri.dev/put-oauth_applications-oauth_application_id-logo): Upload an OAuth application logo - [POST /oauth_applications/{oauth_application_id}/revoke_token](https://octri-c7vy4azv5yd9.octri.dev/post-oauth_applications-oauth_application_id-revoke_token): Revoke an OAuth application token - [POST /oauth_applications/{oauth_application_id}/rotate_secret](https://octri-c7vy4azv5yd9.octri.dev/post-oauth_applications-oauth_application_id-rotate_secret): Rotate the client secret of the given OAuth application - [POST /oauth_applications/access_tokens/verify](https://octri-c7vy4azv5yd9.octri.dev/post-oauth_applications-access_tokens-verify): Verify an OAuth access token ## Organization_domains - [GET /organization_domains](https://octri-c7vy4azv5yd9.octri.dev/get-organization_domains): List all organization domains ## Organization_invitations - [GET /organization_invitations](https://octri-c7vy4azv5yd9.octri.dev/get-organization_invitations): Get a list of organization invitations for the current instance ## Organization_memberships - [GET /organization_memberships](https://octri-c7vy4azv5yd9.octri.dev/get-organization_memberships): Get a list of all organization memberships within an instance. ## Organization_permissions - [GET /organization_permissions](https://octri-c7vy4azv5yd9.octri.dev/get-organization_permissions): Get a list of all organization permissions - [POST /organization_permissions](https://octri-c7vy4azv5yd9.octri.dev/post-organization_permissions): Create a new organization permission - [GET /organization_permissions/{permission_id}](https://octri-c7vy4azv5yd9.octri.dev/get-organization_permissions-permission_id): Get an organization permission - [PATCH /organization_permissions/{permission_id}](https://octri-c7vy4azv5yd9.octri.dev/patch-organization_permissions-permission_id): Update an organization permission - [DELETE /organization_permissions/{permission_id}](https://octri-c7vy4azv5yd9.octri.dev/delete-organization_permissions-permission_id): Delete an organization permission ## Organization_roles - [GET /organization_roles](https://octri-c7vy4azv5yd9.octri.dev/get-organization_roles): Get a list of organization roles - [POST /organization_roles](https://octri-c7vy4azv5yd9.octri.dev/post-organization_roles): Create an organization role - [GET /organization_roles/{organization_role_id}](https://octri-c7vy4azv5yd9.octri.dev/get-organization_roles-organization_role_id): Retrieve an organization role - [PATCH /organization_roles/{organization_role_id}](https://octri-c7vy4azv5yd9.octri.dev/patch-organization_roles-organization_role_id): Update an organization role - [DELETE /organization_roles/{organization_role_id}](https://octri-c7vy4azv5yd9.octri.dev/delete-organization_roles-organization_role_id): Delete an organization role - [POST /organization_roles/{organization_role_id}/permissions/{permission_id}](https://octri-c7vy4azv5yd9.octri.dev/post-organization_roles-organization_role_id-permissions-permission_id): Assign a permission to an organization role - [DELETE /organization_roles/{organization_role_id}/permissions/{permission_id}](https://octri-c7vy4azv5yd9.octri.dev/delete-organization_roles-organization_role_id-permissions-permission_id): Remove a permission from an organization role ## Organizations - [GET /organizations](https://octri-c7vy4azv5yd9.octri.dev/get-organizations): Get a list of organizations for an instance - [POST /organizations](https://octri-c7vy4azv5yd9.octri.dev/post-organizations): Create an organization - [GET /organizations/{organization_id}](https://octri-c7vy4azv5yd9.octri.dev/get-organizations-organization_id): Retrieve an organization by ID or slug - [PATCH /organizations/{organization_id}](https://octri-c7vy4azv5yd9.octri.dev/patch-organizations-organization_id): Update an organization - [DELETE /organizations/{organization_id}](https://octri-c7vy4azv5yd9.octri.dev/delete-organizations-organization_id): Delete an organization - [GET /organizations/{organization_id}/billing/credits](https://octri-c7vy4azv5yd9.octri.dev/get-organizations-organization_id-billing-credits): Retrieve an organization's credit balance - [POST /organizations/{organization_id}/billing/credits](https://octri-c7vy4azv5yd9.octri.dev/post-organizations-organization_id-billing-credits): Adjust an organization's credit balance - [GET /organizations/{organization_id}/billing/subscription](https://octri-c7vy4azv5yd9.octri.dev/get-organizations-organization_id-billing-subscription): Retrieve an organization's billing subscription - [GET /organizations/{organization_id}/domains](https://octri-c7vy4azv5yd9.octri.dev/get-organizations-organization_id-domains): List domains for an organization - [POST /organizations/{organization_id}/domains](https://octri-c7vy4azv5yd9.octri.dev/post-organizations-organization_id-domains): Create a new organization domain. - [PATCH /organizations/{organization_id}/domains/{domain_id}](https://octri-c7vy4azv5yd9.octri.dev/patch-organizations-organization_id-domains-domain_id): Update an organization domain. - [DELETE /organizations/{organization_id}/domains/{domain_id}](https://octri-c7vy4azv5yd9.octri.dev/delete-organizations-organization_id-domains-domain_id): Remove a domain from an organization - [POST /organizations/{organization_id}/domains/{domain_id}/verify_ownership](https://octri-c7vy4azv5yd9.octri.dev/post-organizations-organization_id-domains-domain_id-verify_ownership): Mark an organization domain's ownership as verified - [GET /organizations/{organization_id}/invitations](https://octri-c7vy4azv5yd9.octri.dev/get-organizations-organization_id-invitations): Get a list of organization invitations - [POST /organizations/{organization_id}/invitations](https://octri-c7vy4azv5yd9.octri.dev/post-organizations-organization_id-invitations): Create and send an organization invitation - [GET /organizations/{organization_id}/invitations/{invitation_id}](https://octri-c7vy4azv5yd9.octri.dev/get-organizations-organization_id-invitations-invitation_id): Retrieve an organization invitation by ID - [POST /organizations/{organization_id}/invitations/{invitation_id}/revoke](https://octri-c7vy4azv5yd9.octri.dev/post-organizations-organization_id-invitations-invitation_id-revoke): Revoke a pending organization invitation - [POST /organizations/{organization_id}/invitations/bulk](https://octri-c7vy4azv5yd9.octri.dev/post-organizations-organization_id-invitations-bulk): Create and send organization invitations in bulk - [GET /organizations/{organization_id}/invitations/pending](https://octri-c7vy4azv5yd9.octri.dev/get-organizations-organization_id-invitations-pending): Get a list of pending organization invitations - [PUT /organizations/{organization_id}/logo](https://octri-c7vy4azv5yd9.octri.dev/put-organizations-organization_id-logo): Upload an organization logo - [DELETE /organizations/{organization_id}/logo](https://octri-c7vy4azv5yd9.octri.dev/delete-organizations-organization_id-logo): Delete an organization logo - [GET /organizations/{organization_id}/memberships](https://octri-c7vy4azv5yd9.octri.dev/get-organizations-organization_id-memberships): Get a list of all members of an organization - [POST /organizations/{organization_id}/memberships](https://octri-c7vy4azv5yd9.octri.dev/post-organizations-organization_id-memberships): Create a new organization membership - [PATCH /organizations/{organization_id}/memberships/{user_id}](https://octri-c7vy4azv5yd9.octri.dev/patch-organizations-organization_id-memberships-user_id): Update an organization membership - [DELETE /organizations/{organization_id}/memberships/{user_id}](https://octri-c7vy4azv5yd9.octri.dev/delete-organizations-organization_id-memberships-user_id): Remove a member from an organization - [PATCH /organizations/{organization_id}/memberships/{user_id}/metadata](https://octri-c7vy4azv5yd9.octri.dev/patch-organizations-organization_id-memberships-user_id-metadata): Merge and update organization membership metadata - [PUT /organizations/{organization_id}/metadata](https://octri-c7vy4azv5yd9.octri.dev/put-organizations-organization_id-metadata): Replace metadata for an organization - [PATCH /organizations/{organization_id}/metadata](https://octri-c7vy4azv5yd9.octri.dev/patch-organizations-organization_id-metadata): Merge and update metadata for an organization ## Phone_numbers - [POST /phone_numbers](https://octri-c7vy4azv5yd9.octri.dev/post-phone_numbers): Create a phone number - [GET /phone_numbers/{phone_number_id}](https://octri-c7vy4azv5yd9.octri.dev/get-phone_numbers-phone_number_id): Retrieve a phone number - [PATCH /phone_numbers/{phone_number_id}](https://octri-c7vy4azv5yd9.octri.dev/patch-phone_numbers-phone_number_id): Update a phone number - [DELETE /phone_numbers/{phone_number_id}](https://octri-c7vy4azv5yd9.octri.dev/delete-phone_numbers-phone_number_id): Delete a phone number - [POST /phone_numbers/{phone_number_id}/attempt_verification](https://octri-c7vy4azv5yd9.octri.dev/post-phone_numbers-phone_number_id-attempt_verification): Verify a code sent to a phone number - [POST /phone_numbers/{phone_number_id}/prepare_verification](https://octri-c7vy4azv5yd9.octri.dev/post-phone_numbers-phone_number_id-prepare_verification): Send a verification code to a phone number ## Proxy_checks - [POST /proxy_checks](https://octri-c7vy4azv5yd9.octri.dev/post-proxy_checks): Verify the proxy configuration for your domain ## Public - [GET /public/interstitial](https://octri-c7vy4azv5yd9.octri.dev/get-public-interstitial): Returns the markup for the interstitial page ## Redirect_urls - [GET /redirect_urls](https://octri-c7vy4azv5yd9.octri.dev/get-redirect_urls): List all redirect URLs - [POST /redirect_urls](https://octri-c7vy4azv5yd9.octri.dev/post-redirect_urls): Create a redirect URL - [GET /redirect_urls/{id}](https://octri-c7vy4azv5yd9.octri.dev/get-redirect_urls-id): Retrieve a redirect URL - [DELETE /redirect_urls/{id}](https://octri-c7vy4azv5yd9.octri.dev/delete-redirect_urls-id): Delete a redirect URL ## Role_sets - [GET /role_sets](https://octri-c7vy4azv5yd9.octri.dev/get-role_sets): Get a list of role sets - [POST /role_sets](https://octri-c7vy4azv5yd9.octri.dev/post-role_sets): Create a role set - [GET /role_sets/{role_set_key_or_id}](https://octri-c7vy4azv5yd9.octri.dev/get-role_sets-role_set_key_or_id): Get a role set - [PATCH /role_sets/{role_set_key_or_id}](https://octri-c7vy4azv5yd9.octri.dev/patch-role_sets-role_set_key_or_id): Update a role set - [POST /role_sets/{role_set_key_or_id}/replace](https://octri-c7vy4azv5yd9.octri.dev/post-role_sets-role_set_key_or_id-replace): Replace a role set - [POST /role_sets/{role_set_key_or_id}/roles](https://octri-c7vy4azv5yd9.octri.dev/post-role_sets-role_set_key_or_id-roles): Add roles to a role set - [POST /role_sets/{role_set_key_or_id}/roles/replace](https://octri-c7vy4azv5yd9.octri.dev/post-role_sets-role_set_key_or_id-roles-replace): Replace a role in a role set ## Saml_connections - [GET /saml_connections](https://octri-c7vy4azv5yd9.octri.dev/get-saml_connections): Get a list of SAML Connections for an instance - [POST /saml_connections](https://octri-c7vy4azv5yd9.octri.dev/post-saml_connections): Create a SAML Connection - [GET /saml_connections/{saml_connection_id}](https://octri-c7vy4azv5yd9.octri.dev/get-saml_connections-saml_connection_id): Retrieve a SAML Connection by ID - [PATCH /saml_connections/{saml_connection_id}](https://octri-c7vy4azv5yd9.octri.dev/patch-saml_connections-saml_connection_id): Update a SAML Connection - [DELETE /saml_connections/{saml_connection_id}](https://octri-c7vy4azv5yd9.octri.dev/delete-saml_connections-saml_connection_id): Delete a SAML Connection ## Scim_directories - [GET /scim_directories](https://octri-c7vy4azv5yd9.octri.dev/get-scim_directories): List all directories - [POST /scim_directories](https://octri-c7vy4azv5yd9.octri.dev/post-scim_directories): Create a SCIM directory - [GET /scim_directories/{scim_directory_id}](https://octri-c7vy4azv5yd9.octri.dev/get-scim_directories-scim_directory_id): Retrieve a SCIM directory - [PATCH /scim_directories/{scim_directory_id}](https://octri-c7vy4azv5yd9.octri.dev/patch-scim_directories-scim_directory_id): Update a SCIM directory - [DELETE /scim_directories/{scim_directory_id}](https://octri-c7vy4azv5yd9.octri.dev/delete-scim_directories-scim_directory_id): Delete a directory - [GET /scim_directories/{scim_directory_id}/group_role_mappings](https://octri-c7vy4azv5yd9.octri.dev/get-scim_directories-scim_directory_id-group_role_mappings): List SCIM group role mappings - [POST /scim_directories/{scim_directory_id}/group_role_mappings](https://octri-c7vy4azv5yd9.octri.dev/post-scim_directories-scim_directory_id-group_role_mappings): Create a SCIM group role mapping - [PUT /scim_directories/{scim_directory_id}/group_role_mappings](https://octri-c7vy4azv5yd9.octri.dev/put-scim_directories-scim_directory_id-group_role_mappings): Replace SCIM group role mappings - [DELETE /scim_directories/{scim_directory_id}/group_role_mappings/{mapping_id}](https://octri-c7vy4azv5yd9.octri.dev/delete-scim_directories-scim_directory_id-group_role_mappings-mapping_id): Delete a SCIM group role mapping - [POST /scim_directories/{scim_directory_id}/rotate_api_key](https://octri-c7vy4azv5yd9.octri.dev/post-scim_directories-scim_directory_id-rotate_api_key): Rotate a directory's API key ## Sessions - [GET /sessions](https://octri-c7vy4azv5yd9.octri.dev/get-sessions): List all sessions - [POST /sessions](https://octri-c7vy4azv5yd9.octri.dev/post-sessions): Create a new active session - [GET /sessions/{session_id}](https://octri-c7vy4azv5yd9.octri.dev/get-sessions-session_id): Retrieve a session - [POST /sessions/{session_id}/refresh](https://octri-c7vy4azv5yd9.octri.dev/post-sessions-session_id-refresh): Refresh a session - [GET /sessions/{session_id}/reverifications/{reverification_id}](https://octri-c7vy4azv5yd9.octri.dev/get-sessions-session_id-reverifications-reverification_id): Retrieve a reverification - [POST /sessions/{session_id}/revoke](https://octri-c7vy4azv5yd9.octri.dev/post-sessions-session_id-revoke): Revoke a session - [POST /sessions/{session_id}/tokens](https://octri-c7vy4azv5yd9.octri.dev/post-sessions-session_id-tokens): Create a session token - [POST /sessions/{session_id}/tokens/{template_name}](https://octri-c7vy4azv5yd9.octri.dev/post-sessions-session_id-tokens-template_name): Create a session token from a JWT template ## Sign_in_tokens - [POST /sign_in_tokens](https://octri-c7vy4azv5yd9.octri.dev/post-sign_in_tokens): Create sign-in token - [POST /sign_in_tokens/{sign_in_token_id}/revoke](https://octri-c7vy4azv5yd9.octri.dev/post-sign_in_tokens-sign_in_token_id-revoke): Revoke a sign-in token ## Sign_ups - [GET /sign_ups/{id}](https://octri-c7vy4azv5yd9.octri.dev/get-sign_ups-id): Retrieve a sign-up by ID - [PATCH /sign_ups/{id}](https://octri-c7vy4azv5yd9.octri.dev/patch-sign_ups-id): Update a sign-up ## Sso_bypass_allowlist_users - [GET /sso_bypass_allowlist_users](https://octri-c7vy4azv5yd9.octri.dev/get-sso_bypass_allowlist_users): List the SSO bypass allowlist - [POST /sso_bypass_allowlist_users](https://octri-c7vy4azv5yd9.octri.dev/post-sso_bypass_allowlist_users): Add a user to the SSO bypass allowlist - [DELETE /sso_bypass_allowlist_users/{userID}](https://octri-c7vy4azv5yd9.octri.dev/delete-sso_bypass_allowlist_users-userid): Remove a user from the SSO bypass allowlist ## Templates - [GET /templates/{template_type}](https://octri-c7vy4azv5yd9.octri.dev/get-templates-template_type): List all templates - [GET /templates/{template_type}/{slug}](https://octri-c7vy4azv5yd9.octri.dev/get-templates-template_type-slug): Retrieve a template - [PUT /templates/{template_type}/{slug}](https://octri-c7vy4azv5yd9.octri.dev/put-templates-template_type-slug): Update a template for a given type and slug - [POST /templates/{template_type}/{slug}/preview](https://octri-c7vy4azv5yd9.octri.dev/post-templates-template_type-slug-preview): Preview changes to a template - [POST /templates/{template_type}/{slug}/revert](https://octri-c7vy4azv5yd9.octri.dev/post-templates-template_type-slug-revert): Revert a template to its default - [POST /templates/{template_type}/{slug}/toggle_delivery](https://octri-c7vy4azv5yd9.octri.dev/post-templates-template_type-slug-toggle_delivery): Toggle the delivery by Clerk for a template of a given type and slug ## Testing_tokens - [POST /testing_tokens](https://octri-c7vy4azv5yd9.octri.dev/post-testing_tokens): Create a testing token ## Users - [GET /users](https://octri-c7vy4azv5yd9.octri.dev/get-users): List all users - [POST /users](https://octri-c7vy4azv5yd9.octri.dev/post-users): Create a new user - [GET /users/{user_id}](https://octri-c7vy4azv5yd9.octri.dev/get-users-user_id): Retrieve a user - [PATCH /users/{user_id}](https://octri-c7vy4azv5yd9.octri.dev/patch-users-user_id): Update a user - [DELETE /users/{user_id}](https://octri-c7vy4azv5yd9.octri.dev/delete-users-user_id): Delete a user - [DELETE /users/{user_id}/backup_code](https://octri-c7vy4azv5yd9.octri.dev/delete-users-user_id-backup_code): Delete all backup codes for a user - [POST /users/{user_id}/ban](https://octri-c7vy4azv5yd9.octri.dev/post-users-user_id-ban): Ban a user - [GET /users/{user_id}/billing/credits](https://octri-c7vy4azv5yd9.octri.dev/get-users-user_id-billing-credits): Retrieve a user's credit balance - [POST /users/{user_id}/billing/credits](https://octri-c7vy4azv5yd9.octri.dev/post-users-user_id-billing-credits): Adjust a user's credit balance - [GET /users/{user_id}/billing/subscription](https://octri-c7vy4azv5yd9.octri.dev/get-users-user_id-billing-subscription): Retrieve a user's billing subscription - [GET /users/{user_id}/biometric_credentials](https://octri-c7vy4azv5yd9.octri.dev/get-users-user_id-biometric_credentials): List a user's biometric credentials - [DELETE /users/{user_id}/biometric_credentials/{biometric_credential_id}](https://octri-c7vy4azv5yd9.octri.dev/delete-users-user_id-biometric_credentials-biometric_credential_id): Revoke a user's biometric credential - [PUT /users/{user_id}/email_address](https://octri-c7vy4azv5yd9.octri.dev/put-users-user_id-email_address): Replace a user's email address - [DELETE /users/{user_id}/external_accounts/{external_account_id}](https://octri-c7vy4azv5yd9.octri.dev/delete-users-user_id-external_accounts-external_account_id): Delete a user's external account - [POST /users/{user_id}/lock](https://octri-c7vy4azv5yd9.octri.dev/post-users-user_id-lock): Lock a user - [PUT /users/{user_id}/metadata](https://octri-c7vy4azv5yd9.octri.dev/put-users-user_id-metadata): Replace a user's metadata - [PATCH /users/{user_id}/metadata](https://octri-c7vy4azv5yd9.octri.dev/patch-users-user_id-metadata): Merge and update a user's metadata - [DELETE /users/{user_id}/mfa](https://octri-c7vy4azv5yd9.octri.dev/delete-users-user_id-mfa): Disable a user's MFA methods - [GET /users/{user_id}/oauth_access_tokens/{provider}](https://octri-c7vy4azv5yd9.octri.dev/get-users-user_id-oauth_access_tokens-provider): Retrieve the OAuth access token of a user - [GET /users/{user_id}/organization_invitations](https://octri-c7vy4azv5yd9.octri.dev/get-users-user_id-organization_invitations): Retrieve all invitations for a user - [GET /users/{user_id}/organization_memberships](https://octri-c7vy4azv5yd9.octri.dev/get-users-user_id-organization_memberships): Retrieve all memberships for a user - [DELETE /users/{user_id}/passkeys/{passkey_identification_id}](https://octri-c7vy4azv5yd9.octri.dev/delete-users-user_id-passkeys-passkey_identification_id): Delete a user passkey - [POST /users/{user_id}/password/set_compromised](https://octri-c7vy4azv5yd9.octri.dev/post-users-user_id-password-set_compromised): Mark a user's password as compromised - [POST /users/{user_id}/password/unset_compromised](https://octri-c7vy4azv5yd9.octri.dev/post-users-user_id-password-unset_compromised): Unset a user's password as compromised - [PUT /users/{user_id}/phone_number](https://octri-c7vy4azv5yd9.octri.dev/put-users-user_id-phone_number): Replace a user's phone number - [POST /users/{user_id}/profile_image](https://octri-c7vy4azv5yd9.octri.dev/post-users-user_id-profile_image): Set a user profile image - [DELETE /users/{user_id}/profile_image](https://octri-c7vy4azv5yd9.octri.dev/delete-users-user_id-profile_image): Delete a user profile image - [POST /users/{user_id}/remove_password](https://octri-c7vy4azv5yd9.octri.dev/post-users-user_id-remove_password): Remove a user's password - [DELETE /users/{user_id}/totp](https://octri-c7vy4azv5yd9.octri.dev/delete-users-user_id-totp): Delete all of a user's TOTPs - [GET /users/{user_id}/trusted_devices](https://octri-c7vy4azv5yd9.octri.dev/get-users-user_id-trusted_devices): List a user's trusted devices - [DELETE /users/{user_id}/trusted_devices/{trusted_device_id}](https://octri-c7vy4azv5yd9.octri.dev/delete-users-user_id-trusted_devices-trusted_device_id): Revoke a user's trusted device - [POST /users/{user_id}/unban](https://octri-c7vy4azv5yd9.octri.dev/post-users-user_id-unban): Unban a user - [POST /users/{user_id}/unlock](https://octri-c7vy4azv5yd9.octri.dev/post-users-user_id-unlock): Unlock a user - [POST /users/{user_id}/verify_password](https://octri-c7vy4azv5yd9.octri.dev/post-users-user_id-verify_password): Verify the password of a user - [POST /users/{user_id}/verify_totp](https://octri-c7vy4azv5yd9.octri.dev/post-users-user_id-verify_totp): Verify a TOTP or backup code for a user - [DELETE /users/{user_id}/web3_wallets/{web3_wallet_identification_id}](https://octri-c7vy4azv5yd9.octri.dev/delete-users-user_id-web3_wallets-web3_wallet_identification_id): Delete a user web3 wallet - [POST /users/ban](https://octri-c7vy4azv5yd9.octri.dev/post-users-ban): Ban multiple users - [GET /users/count](https://octri-c7vy4azv5yd9.octri.dev/get-users-count): Count users - [POST /users/unban](https://octri-c7vy4azv5yd9.octri.dev/post-users-unban): Unban multiple users ## Waitlist_entries - [GET /waitlist_entries](https://octri-c7vy4azv5yd9.octri.dev/get-waitlist_entries): List all waitlist entries - [POST /waitlist_entries](https://octri-c7vy4azv5yd9.octri.dev/post-waitlist_entries): Create a waitlist entry - [DELETE /waitlist_entries/{waitlist_entry_id}](https://octri-c7vy4azv5yd9.octri.dev/delete-waitlist_entries-waitlist_entry_id): Delete a pending waitlist entry - [POST /waitlist_entries/{waitlist_entry_id}/invite](https://octri-c7vy4azv5yd9.octri.dev/post-waitlist_entries-waitlist_entry_id-invite): Invite a waitlist entry - [POST /waitlist_entries/{waitlist_entry_id}/reject](https://octri-c7vy4azv5yd9.octri.dev/post-waitlist_entries-waitlist_entry_id-reject): Reject a waitlist entry - [POST /waitlist_entries/bulk](https://octri-c7vy4azv5yd9.octri.dev/post-waitlist_entries-bulk): Create multiple waitlist entries ## Webhooks - [POST /webhooks/svix](https://octri-c7vy4azv5yd9.octri.dev/post-webhooks-svix): Create a Svix app - [DELETE /webhooks/svix](https://octri-c7vy4azv5yd9.octri.dev/delete-webhooks-svix): Delete a Svix app - [POST /webhooks/svix_url](https://octri-c7vy4azv5yd9.octri.dev/post-webhooks-svix_url): Create a Svix Dashboard URL ## Optional - [Changelog](https://octri-c7vy4azv5yd9.octri.dev/changelog): API version history and breaking changes