openapi

The Clerk REST Backend API, meant to be accessed by backend servers.

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. 2025-04-10. For more information, please see Clerk API Versions.

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

This Dart package is automatically generated by the OpenAPI Generator project:

API version: 2025-11-10
Generator version: 7.9.0
Build package: org.openapitools.codegen.languages.DartClientCodegen For more information, please visit https://clerk.com/support

Requirements

Dart 2.12 or later

Installation & Usage

Github

If this Dart package is published to Github, add the following dependency to your pubspec.yaml

dependencies:
  openapi:
    git: https://github.com/GIT_USER_ID/GIT_REPO_ID.git

Local

To use the package in your local drive, add the following dependency to your pubspec.yaml

dependencies:
  openapi:
    path: /path/to/openapi

Tests

TODO

Getting Started

Please follow the installation procedure and then run the following:

import 'package:openapi/api.dart';

// TODO Configure HTTP Bearer authorization: bearerAuth
// Case 1. Use String Token
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearerAuth').setAccessToken('YOUR_ACCESS_TOKEN');
// Case 2. Use Function which generate token.
// String yourTokenGeneratorFunction() { ... }
//defaultApiClient.getAuthentication<HttpBearerAuth>('bearerAuth').setAccessToken(yourTokenGeneratorFunction);

final api_instance = APIKeysApi();
final createApiKeyRequest = CreateApiKeyRequest(); // CreateApiKeyRequest | 

try {
    final result = api_instance.createApiKey(createApiKeyRequest);
    print(result);
} catch (e) {
    print('Exception when calling APIKeysApi->createApiKey: $e\n');
}

Documentation for API Endpoints

All URIs are relative to https://api.clerk.com/v1

Class	Method	HTTP request	Description
APIKeysApi	createApiKey	POST /api_keys	Create an API Key
APIKeysApi	deleteApiKey	DELETE /api_keys/{apiKeyID}	Delete an API Key
APIKeysApi	getApiKey	GET /api_keys/{apiKeyID}	Get an API Key by ID
APIKeysApi	getApiKeySecret	GET /api_keys/{apiKeyID}/secret	Get an API Key Secret
APIKeysApi	getApiKeys	GET /api_keys	Get API Keys
APIKeysApi	revokeApiKey	POST /api_keys/{apiKeyID}/revoke	Revoke an API Key
APIKeysApi	updateApiKey	PATCH /api_keys/{apiKeyID}	Update an API Key
APIKeysApi	verifyApiKey	POST /api_keys/verify	Verify an API Key
ActorTokensApi	createActorToken	POST /actor_tokens	Create actor token
ActorTokensApi	revokeActorToken	POST /actor_tokens/{actor_token_id}/revoke	Revoke actor token
AllowListBlockListApi	createAllowlistIdentifier	POST /allowlist_identifiers	Add identifier to the allow-list
AllowListBlockListApi	createBlocklistIdentifier	POST /blocklist_identifiers	Add identifier to the block-list
AllowListBlockListApi	deleteAllowlistIdentifier	DELETE /allowlist_identifiers/{identifier_id}	Delete identifier from allow-list
AllowListBlockListApi	deleteBlocklistIdentifier	DELETE /blocklist_identifiers/{identifier_id}	Delete identifier from block-list
AllowListBlockListApi	listAllowlistIdentifiers	GET /allowlist_identifiers	List all identifiers on the allow-list
AllowListBlockListApi	listBlocklistIdentifiers	GET /blocklist_identifiers	List all identifiers on the block-list
BetaFeaturesApi	changeProductionInstanceDomain	POST /instance/change_domain	Update production instance domain
BetaFeaturesApi	updateInstanceAuthConfig	PATCH /beta_features/instance_settings	Update instance settings
BetaFeaturesApi	updateProductionInstanceDomain	PUT /beta_features/domain	Update production instance domain
BillingApi	cancelCommerceSubscriptionItem	DELETE /billing/subscription_items/{subscription_item_id}	Cancel a subscription item
BillingApi	createBillingPrice	POST /billing/prices	Create a custom billing price
BillingApi	createBillingPriceTransition	POST /billing/subscription_items/{subscription_item_id}/price_transition	Create a price transition for a subscription item
BillingApi	extendBillingSubscriptionItemFreeTrial	POST /billing/subscription_items/{subscription_item_id}/extend_free_trial	Extend free trial for a subscription item
BillingApi	getBillingPriceList	GET /billing/prices	List all billing prices
BillingApi	getBillingStatement	GET /billing/statements/{statementID}	Retrieve a billing statement
BillingApi	getBillingStatementList	GET /billing/statements	List all billing statements
BillingApi	getBillingStatementPaymentAttempts	GET /billing/statements/{statementID}/payment_attempts	List payment attempts for a billing statement
BillingApi	getCommercePlanList	GET /billing/plans	List all billing plans
BillingApi	getCommerceSubscriptionItemList	GET /billing/subscription_items	List all subscription items
BillingApi	getOrganizationBillingSubscription_0	GET /organizations/{organization_id}/billing/subscription	Retrieve an organization's billing subscription
BillingApi	getUserBillingSubscription_0	GET /users/{user_id}/billing/subscription	Retrieve a user's billing subscription
ClientsApi	getClient	GET /clients/{client_id}	Get a client
ClientsApi	getClientList	GET /clients	List all clients
ClientsApi	verifyClient	POST /clients/verify	Verify a client
DomainsApi	addDomain	POST /domains	Add a domain
DomainsApi	deleteDomain	DELETE /domains/{domain_id}	Delete a satellite domain
DomainsApi	listDomains	GET /domains	List all instance domains
DomainsApi	updateDomain	PATCH /domains/{domain_id}	Update a domain
EmailAddressesApi	createEmailAddress	POST /email_addresses	Create an email address
EmailAddressesApi	deleteEmailAddress	DELETE /email_addresses/{email_address_id}	Delete an email address
EmailAddressesApi	getEmailAddress	GET /email_addresses/{email_address_id}	Retrieve an email address
EmailAddressesApi	updateEmailAddress	PATCH /email_addresses/{email_address_id}	Update an email address
EmailSMSTemplatesApi	getTemplate	GET /templates/{template_type}/{slug}	Retrieve a template
EmailSMSTemplatesApi	getTemplateList	GET /templates/{template_type}	List all templates
EmailSMSTemplatesApi	previewTemplate	POST /templates/{template_type}/{slug}/preview	Preview changes to a template
EmailSMSTemplatesApi	revertTemplate	POST /templates/{template_type}/{slug}/revert	Revert a template
EmailSMSTemplatesApi	toggleTemplateDelivery	POST /templates/{template_type}/{slug}/toggle_delivery	Toggle the delivery by Clerk for a template of a given type and slug
EmailSMSTemplatesApi	upsertTemplate	PUT /templates/{template_type}/{slug}	Update a template for a given type and slug
InstanceSettingsApi	getInstance	GET /instance	Fetch the current instance
InstanceSettingsApi	getInstanceProtect	GET /instance/protect	Get instance protect settings
InstanceSettingsApi	updateInstance	PATCH /instance	Update instance settings
InstanceSettingsApi	updateInstanceOrganizationSettings	PATCH /instance/organization_settings	Update instance organization settings
InstanceSettingsApi	updateInstanceProtect	PATCH /instance/protect	Update instance protect settings
InstanceSettingsApi	updateInstanceRestrictions	PATCH /instance/restrictions	Update instance restrictions
InvitationsApi	createBulkInvitations	POST /invitations/bulk	Create multiple invitations
InvitationsApi	createInvitation	POST /invitations	Create an invitation
InvitationsApi	listInvitations	GET /invitations	List all invitations
InvitationsApi	revokeInvitation	POST /invitations/{invitation_id}/revoke	Revokes an invitation
JWKSApi	getJWKS	GET /jwks	Retrieve the JSON Web Key Set of the instance
JWTTemplatesApi	createJWTTemplate	POST /jwt_templates	Create a JWT template
JWTTemplatesApi	deleteJWTTemplate	DELETE /jwt_templates/{template_id}	Delete a Template
JWTTemplatesApi	getJWTTemplate	GET /jwt_templates/{template_id}	Retrieve a template
JWTTemplatesApi	listJWTTemplates	GET /jwt_templates	List all templates
JWTTemplatesApi	updateJWTTemplate	PATCH /jwt_templates/{template_id}	Update a JWT template
M2MTokensApi	createM2MToken	POST /m2m_tokens	Create a M2M Token
M2MTokensApi	getM2MTokens	GET /m2m_tokens	Get M2M Tokens
M2MTokensApi	revokeM2MToken	POST /m2m_tokens/{m2m_token_id}/revoke	Revoke a M2M Token
M2MTokensApi	verifyM2MToken	POST /m2m_tokens/verify	Verify a M2M Token
MachinesApi	createMachine	POST /machines	Create a machine
MachinesApi	createMachineScope	POST /machines/{machine_id}/scopes	Create a machine scope
MachinesApi	deleteMachine	DELETE /machines/{machine_id}	Delete a machine
MachinesApi	deleteMachineScope	DELETE /machines/{machine_id}/scopes/{other_machine_id}	Delete a machine scope
MachinesApi	getMachine	GET /machines/{machine_id}	Retrieve a machine
MachinesApi	getMachineSecretKey	GET /machines/{machine_id}/secret_key	Retrieve a machine secret key
MachinesApi	listMachines	GET /machines	Get a list of machines for an instance
MachinesApi	rotateMachineSecretKey	POST /machines/{machine_id}/secret_key/rotate	Rotate a machine's secret key
MachinesApi	updateMachine	PATCH /machines/{machine_id}	Update a machine
MiscellaneousApi	getPublicInterstitial	GET /public/interstitial	Returns the markup for the interstitial page
OAuthAccessTokensApi	verifyOAuthAccessToken	POST /oauth_applications/access_tokens/verify	Verify an OAuth Access Token
OAuthApplicationsApi	createOAuthApplication	POST /oauth_applications	Create an OAuth application
OAuthApplicationsApi	deleteOAuthApplication	DELETE /oauth_applications/{oauth_application_id}	Delete an OAuth application
OAuthApplicationsApi	getOAuthApplication	GET /oauth_applications/{oauth_application_id}	Retrieve an OAuth application by ID
OAuthApplicationsApi	listOAuthApplications	GET /oauth_applications	Get a list of OAuth applications for an instance
OAuthApplicationsApi	rotateOAuthApplicationSecret	POST /oauth_applications/{oauth_application_id}/rotate_secret	Rotate the client secret of the given OAuth application
OAuthApplicationsApi	updateOAuthApplication	PATCH /oauth_applications/{oauth_application_id}	Update an OAuth application
OrganizationDomainsApi	createOrganizationDomain	POST /organizations/{organization_id}/domains	Create a new organization domain.
OrganizationDomainsApi	deleteOrganizationDomain	DELETE /organizations/{organization_id}/domains/{domain_id}	Remove a domain from an organization.
OrganizationDomainsApi	listAllOrganizationDomains	GET /organization_domains	List all organization domains
OrganizationDomainsApi	listOrganizationDomains	GET /organizations/{organization_id}/domains	Get a list of all domains of an organization.
OrganizationDomainsApi	updateOrganizationDomain	PATCH /organizations/{organization_id}/domains/{domain_id}	Update an organization domain.
OrganizationInvitationsApi	createOrganizationInvitation	POST /organizations/{organization_id}/invitations	Create and send an organization invitation
OrganizationInvitationsApi	createOrganizationInvitationBulk	POST /organizations/{organization_id}/invitations/bulk	Bulk create and send organization invitations
OrganizationInvitationsApi	getOrganizationInvitation	GET /organizations/{organization_id}/invitations/{invitation_id}	Retrieve an organization invitation by ID
OrganizationInvitationsApi	listInstanceOrganizationInvitations	GET /organization_invitations	Get a list of organization invitations for the current instance
OrganizationInvitationsApi	listOrganizationInvitations	GET /organizations/{organization_id}/invitations	Get a list of organization invitations
OrganizationInvitationsApi	listPendingOrganizationInvitations	GET /organizations/{organization_id}/invitations/pending	Get a list of pending organization invitations
OrganizationInvitationsApi	revokeOrganizationInvitation	POST /organizations/{organization_id}/invitations/{invitation_id}/revoke	Revoke a pending organization invitation
OrganizationMembershipsApi	createOrganizationMembership	POST /organizations/{organization_id}/memberships	Create a new organization membership
OrganizationMembershipsApi	deleteOrganizationMembership	DELETE /organizations/{organization_id}/memberships/{user_id}	Remove a member from an organization
OrganizationMembershipsApi	instanceGetOrganizationMemberships	GET /organization_memberships	Get a list of all organization memberships within an instance.
OrganizationMembershipsApi	listOrganizationMemberships	GET /organizations/{organization_id}/memberships	Get a list of all members of an organization
OrganizationMembershipsApi	updateOrganizationMembership	PATCH /organizations/{organization_id}/memberships/{user_id}	Update an organization membership
OrganizationMembershipsApi	updateOrganizationMembershipMetadata	PATCH /organizations/{organization_id}/memberships/{user_id}/metadata	Merge and update organization membership metadata
OrganizationPermissionsApi	createOrganizationPermission	POST /organization_permissions	Create a new organization permission
OrganizationPermissionsApi	deleteOrganizationPermission	DELETE /organization_permissions/{permission_id}	Delete an organization permission
OrganizationPermissionsApi	getOrganizationPermission	GET /organization_permissions/{permission_id}	Get an organization permission
OrganizationPermissionsApi	listOrganizationPermissions	GET /organization_permissions	Get a list of all organization permissions
OrganizationPermissionsApi	updateOrganizationPermission	PATCH /organization_permissions/{permission_id}	Update an organization permission
OrganizationRolesApi	assignPermissionToOrganizationRole	POST /organization_roles/{organization_role_id}/permissions/{permission_id}	Assign a permission to an organization role
OrganizationRolesApi	createOrganizationRole	POST /organization_roles	Create an organization role
OrganizationRolesApi	deleteOrganizationRole	DELETE /organization_roles/{organization_role_id}	Delete an organization role
OrganizationRolesApi	getOrganizationRole	GET /organization_roles/{organization_role_id}	Retrieve an organization role
OrganizationRolesApi	listOrganizationRoles	GET /organization_roles	Get a list of organization roles
OrganizationRolesApi	removePermissionFromOrganizationRole	DELETE /organization_roles/{organization_role_id}/permissions/{permission_id}	Remove a permission from an organization role
OrganizationRolesApi	updateOrganizationRole	PATCH /organization_roles/{organization_role_id}	Update an organization role
OrganizationsApi	createOrganization	POST /organizations	Create an organization
OrganizationsApi	deleteOrganization	DELETE /organizations/{organization_id}	Delete an organization
OrganizationsApi	deleteOrganizationLogo	DELETE /organizations/{organization_id}/logo	Delete the organization's logo.
OrganizationsApi	getOrganization	GET /organizations/{organization_id}	Retrieve an organization by ID or slug
OrganizationsApi	getOrganizationBillingSubscription	GET /organizations/{organization_id}/billing/subscription	Retrieve an organization's billing subscription
OrganizationsApi	listOrganizations	GET /organizations	Get a list of organizations for an instance
OrganizationsApi	mergeOrganizationMetadata	PATCH /organizations/{organization_id}/metadata	Merge and update metadata for an organization
OrganizationsApi	updateOrganization	PATCH /organizations/{organization_id}	Update an organization
OrganizationsApi	uploadOrganizationLogo	PUT /organizations/{organization_id}/logo	Upload a logo for the organization
PhoneNumbersApi	createPhoneNumber	POST /phone_numbers	Create a phone number
PhoneNumbersApi	deletePhoneNumber	DELETE /phone_numbers/{phone_number_id}	Delete a phone number
PhoneNumbersApi	getPhoneNumber	GET /phone_numbers/{phone_number_id}	Retrieve a phone number
PhoneNumbersApi	updatePhoneNumber	PATCH /phone_numbers/{phone_number_id}	Update a phone number
ProxyChecksApi	verifyDomainProxy	POST /proxy_checks	Verify the proxy configuration for your domain
RedirectURLsApi	createRedirectURL	POST /redirect_urls	Create a redirect URL
RedirectURLsApi	deleteRedirectURL	DELETE /redirect_urls/{id}	Delete a redirect URL
RedirectURLsApi	getRedirectURL	GET /redirect_urls/{id}	Retrieve a redirect URL
RedirectURLsApi	listRedirectURLs	GET /redirect_urls	List all redirect URLs
RoleSetsApi	addRolesToRoleSet	POST /role_sets/{role_set_key_or_id}/roles	Add roles to a role set
RoleSetsApi	createRoleSet	POST /role_sets	Create a role set
RoleSetsApi	getRoleSet	GET /role_sets/{role_set_key_or_id}	Retrieve a role set
RoleSetsApi	listRoleSets	GET /role_sets	Get a list of role sets
RoleSetsApi	replaceRoleInRoleSet	POST /role_sets/{role_set_key_or_id}/roles/replace	Replace a role in a role set
RoleSetsApi	replaceRoleSet	POST /role_sets/{role_set_key_or_id}/replace	Replace a role set
RoleSetsApi	updateRoleSet	PATCH /role_sets/{role_set_key_or_id}	Update a role set
SAMLConnectionsApi	createSAMLConnection	POST /saml_connections	Create a SAML Connection
SAMLConnectionsApi	deleteSAMLConnection	DELETE /saml_connections/{saml_connection_id}	Delete a SAML Connection
SAMLConnectionsApi	getSAMLConnection	GET /saml_connections/{saml_connection_id}	Retrieve a SAML Connection by ID
SAMLConnectionsApi	listSAMLConnections	GET /saml_connections	Get a list of SAML Connections for an instance
SAMLConnectionsApi	updateSAMLConnection	PATCH /saml_connections/{saml_connection_id}	Update a SAML Connection
SessionsApi	createSession	POST /sessions	Create a new active session
SessionsApi	createSessionToken	POST /sessions/{session_id}/tokens	Create a session token
SessionsApi	createSessionTokenFromTemplate	POST /sessions/{session_id}/tokens/{template_name}	Create a session token from a JWT template
SessionsApi	getSession	GET /sessions/{session_id}	Retrieve a session
SessionsApi	getSessionList	GET /sessions	List all sessions
SessionsApi	refreshSession	POST /sessions/{session_id}/refresh	Refresh a session
SessionsApi	revokeSession	POST /sessions/{session_id}/revoke	Revoke a session
SignInTokensApi	createSignInToken	POST /sign_in_tokens	Create sign-in token
SignInTokensApi	revokeSignInToken	POST /sign_in_tokens/{sign_in_token_id}/revoke	Revoke the given sign-in token
SignUpsApi	getSignUp	GET /sign_ups/{id}	Retrieve a sign-up by ID
SignUpsApi	updateSignUp	PATCH /sign_ups/{id}	Update a sign-up
TestingTokensApi	createTestingToken	POST /testing_tokens	Retrieve a new testing token
UsersApi	banUser	POST /users/{user_id}/ban	Ban a user
UsersApi	createUser	POST /users	Create a new user
UsersApi	deleteBackupCode	DELETE /users/{user_id}/backup_code	Disable all user's Backup codes
UsersApi	deleteExternalAccount	DELETE /users/{user_id}/external_accounts/{external_account_id}	Delete External Account
UsersApi	deleteTOTP	DELETE /users/{user_id}/totp	Delete all the user's TOTPs
UsersApi	deleteUser	DELETE /users/{user_id}	Delete a user
UsersApi	deleteUserProfileImage	DELETE /users/{user_id}/profile_image	Delete user profile image
UsersApi	disableMFA	DELETE /users/{user_id}/mfa	Disable a user's MFA methods
UsersApi	getOAuthAccessToken	GET /users/{user_id}/oauth_access_tokens/{provider}	Retrieve the OAuth access token of a user
UsersApi	getUser	GET /users/{user_id}	Retrieve a user
UsersApi	getUserBillingSubscription	GET /users/{user_id}/billing/subscription	Retrieve a user's billing subscription
UsersApi	getUserList	GET /users	List all users
UsersApi	getUsersCount	GET /users/count	Count users
UsersApi	lockUser	POST /users/{user_id}/lock	Lock a user
UsersApi	setUserPasswordCompromised	POST /users/{user_id}/password/set_compromised	Set a user's password as compromised
UsersApi	setUserProfileImage	POST /users/{user_id}/profile_image	Set user profile image
UsersApi	unbanUser	POST /users/{user_id}/unban	Unban a user
UsersApi	unlockUser	POST /users/{user_id}/unlock	Unlock a user
UsersApi	unsetUserPasswordCompromised	POST /users/{user_id}/password/unset_compromised	Unset a user's password as compromised
UsersApi	updateUser	PATCH /users/{user_id}	Update a user
UsersApi	updateUserMetadata	PATCH /users/{user_id}/metadata	Merge and update a user's metadata
UsersApi	userPasskeyDelete	DELETE /users/{user_id}/passkeys/{passkey_identification_id}	Delete a user passkey
UsersApi	userWeb3WalletDelete	DELETE /users/{user_id}/web3_wallets/{web3_wallet_identification_id}	Delete a user web3 wallet
UsersApi	usersBan	POST /users/ban	Ban multiple users
UsersApi	usersGetOrganizationInvitations	GET /users/{user_id}/organization_invitations	Retrieve all invitations for a user
UsersApi	usersGetOrganizationMemberships	GET /users/{user_id}/organization_memberships	Retrieve all memberships for a user
UsersApi	usersUnban	POST /users/unban	Unban multiple users
UsersApi	verifyPassword	POST /users/{user_id}/verify_password	Verify the password of a user
UsersApi	verifyTOTP	POST /users/{user_id}/verify_totp	Verify a TOTP or backup code for a user
WaitlistEntriesApi	createBulkWaitlistEntries	POST /waitlist_entries/bulk	Create multiple waitlist entries
WaitlistEntriesApi	createWaitlistEntry	POST /waitlist_entries	Create a waitlist entry
WaitlistEntriesApi	deleteWaitlistEntry	DELETE /waitlist_entries/{waitlist_entry_id}	Delete a pending waitlist entry
WaitlistEntriesApi	inviteWaitlistEntry	POST /waitlist_entries/{waitlist_entry_id}/invite	Invite a waitlist entry
WaitlistEntriesApi	listWaitlistEntries	GET /waitlist_entries	List all waitlist entries
WaitlistEntriesApi	rejectWaitlistEntry	POST /waitlist_entries/{waitlist_entry_id}/reject	Reject a waitlist entry
WebhooksApi	createSvixApp	POST /webhooks/svix	Create a Svix app
WebhooksApi	deleteSvixApp	DELETE /webhooks/svix	Delete a Svix app
WebhooksApi	generateSvixAuthURL	POST /webhooks/svix_url	Create a Svix Dashboard URL

Documentation For Models

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

Type: HTTP Bearer authentication

platformToken

Type: HTTP Bearer authentication

Author

support@clerk.com