> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Clerk

> How to set up the Clerk connector, plus the actions and events that are available.

![Clerk](https://stackone-logos.com/api/clerk/filled/svg)

Previewv0.1.0[See changelog](https://docs.stackone.com/connectors/clerk/changelog.md)

[56 actions](#actions) · [25 events](#events) · 1 auth method

IAM

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and set up a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> **[Connector Profile · API Key](https://docs.stackone.com/connectors/clerk/guides/connector-profile/api-key.md)**
>
> Uses a Clerk Backend API secret key (sk\_...) as a bearer token. The key scopes all requests to one application instance...

Optionally, configure receiving Events for Clerk into StackOne.

> **[Webhooks setup](https://docs.stackone.com/connectors/clerk/guides/webhook-setup.md)**

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> **[Link Account · API Key](https://docs.stackone.com/connectors/clerk/guides/link-account/api-key.md)**

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/connect/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

56 actions

ActionDescription

List Allowlist Identifiers`clerk_allowlist_identifiers_list`

Retrieve a paginated list of allowlist identifiers from your Clerk instance.

Create Allowlist Identifier`clerk_allowlist_identifiers_create`

Create a new allowlist identifier in your Clerk instance.

Delete Allowlist Identifier`clerk_allowlist_identifiers_delete`

Permanently delete a allowlist identifier from your Clerk instance.

List Blocklist Identifiers`clerk_blocklist_identifiers_list`

Retrieve a paginated list of blocklist identifiers from your Clerk instance.

Create Blocklist Identifier`clerk_blocklist_identifiers_create`

Create a new blocklist identifier in your Clerk instance.

Delete Blocklist Identifier`clerk_blocklist_identifiers_delete`

Permanently delete a blocklist identifier from your Clerk instance.

List Invitations`clerk_invitations_list`

Retrieve a paginated list of invitations from your Clerk instance.

Create Invitation`clerk_invitations_create`

Create a new instance-level invitation in your Clerk instance.

Revoke Invitation`clerk_invitations_revoke`

Revoke a pending instance-level invitation so it can no longer be accepted.

List JWT Templates`clerk_jwt_templates_list`

Retrieve a paginated list of JWT templates from your Clerk instance.

Create JWT Template`clerk_jwt_templates_create`

Create a new JWT template in your Clerk instance.

Get JWT Template`clerk_jwt_templates_get`

Retrieve the details of a single JWT template by its unique identifier.

Update JWT Template`clerk_jwt_templates_update`

Update an existing JWT template with the provided fields.

Delete JWT Template`clerk_jwt_templates_delete`

Permanently delete a JWT template from your Clerk instance.

List Organization Domains`clerk_organization_domains_list`

Retrieve a paginated list of organization domains from your Clerk instance.

Create Organization Domain`clerk_organization_domains_create`

Create a new organization domain in your Clerk instance.

Update Organization Domain`clerk_organization_domains_update`

Update an existing organization domain with the provided fields.

Delete Organization Domain`clerk_organization_domains_delete`

Permanently delete a organization domain from your Clerk instance.

Create Organization Invitation`clerk_organization_invitations_create`

Create a new organization invitation in your Clerk instance.

List Organization Invitations`clerk_organization_invitations_list`

Retrieve a paginated list of organization invitations from your Clerk instance.

Get Organization Invitation`clerk_organization_invitations_get`

Retrieve the details of a single organization invitation by its unique identifier.

Revoke Organization Invitation`clerk_organization_invitations_revoke`

Revoke a pending organization invitation so it can no longer be accepted.

Create Organization Membership`clerk_organization_memberships_create`

Create a new organization membership in your Clerk instance.

List Organization Memberships`clerk_organization_memberships_list`

Retrieve a paginated list of organization memberships from your Clerk instance.

Update Organization Membership`clerk_organization_memberships_update`

Update an existing organization membership with the provided fields.

Delete Organization Membership`clerk_organization_memberships_delete`

Permanently delete a organization membership from your Clerk instance.

List Organization Roles`clerk_organization_roles_list`

Retrieve a paginated list of organization roles from your Clerk instance.

Create Organization Role`clerk_organization_roles_create`

Create a new organization role in your Clerk instance.

Get Organization Role`clerk_organization_roles_get`

Retrieve the details of a single organization role by its unique identifier.

Update Organization Role`clerk_organization_roles_update`

Update an existing organization role with the provided fields.

Delete Organization Role`clerk_organization_roles_delete`

Permanently delete a organization role from your Clerk instance.

List Organizations`clerk_organizations_list`

Retrieve a paginated list of organizations from your Clerk instance.

Create Organization`clerk_organizations_create`

Create a new organization in your Clerk instance.

Get Organization`clerk_organizations_get`

Retrieve the details of a single organization by its unique identifier.

Update Organization`clerk_organizations_update`

Update an existing organization with the provided fields.

Delete Organization`clerk_organizations_delete`

Permanently delete a organization from your Clerk instance.

List Redirect URLs`clerk_redirect_urls_list`

Retrieve a paginated list of redirect URLs from your Clerk instance.

Create Redirect URL`clerk_redirect_urls_create`

Create a new redirect URL in your Clerk instance.

Get Redirect URL`clerk_redirect_urls_get`

Retrieve the details of a single redirect URL by its unique identifier.

Delete Redirect URL`clerk_redirect_urls_delete`

Permanently delete a redirect URL from your Clerk instance.

List Sessions`clerk_sessions_list`

Retrieve a paginated list of sessions from your Clerk instance.

Get Session`clerk_sessions_get`

Retrieve the details of a single session by its unique identifier.

Revoke Session`clerk_sessions_revoke`

Revoke a session so the associated user is signed out.

Create Session Token`clerk_sessions_create_token`

Create a new session token for an active session.

List Users`clerk_users_list`

Retrieve a paginated list of users from your Clerk instance.

Create User`clerk_users_create`

Create a new user in your Clerk instance.

Count Users`clerk_users_count`

Return the total number of users in your Clerk instance, with optional filtering.

Get User`clerk_users_get`

Retrieve the details of a single user by its unique identifier.

Update User`clerk_users_update`

Update an existing user with the provided fields.

Delete User`clerk_users_delete`

Permanently delete a user from your Clerk instance.

Ban User`clerk_users_ban`

Ban a user, marking them as banned and preventing them from signing in.

Unban User`clerk_users_unban`

Remove the ban from a user so that they are able to sign in again.

Lock User`clerk_users_lock`

Lock a user, temporarily preventing them from signing in to your application.

Unlock User`clerk_users_unlock`

Unlock a previously locked user so that they can sign in again.

Update User Metadata`clerk_users_update_metadata`

Merge new values into a user's public, private and unsafe metadata.

List User Organization Memberships`clerk_users_list_organization_memberships`

Retrieve a paginated list of organization memberships for a specific user.

## Events

Tags

Select all
|
Clear

Organization Domains

Organization Invitations

Organization Memberships

Organization Roles

Organizations

Permissions

Sessions

Users

Webhooks

No tags found

25 events

EventDescriptionTags

User Created`clerk_webhook_user_created`

Fired when a new user signs up or is created in your Clerk instance.

UsersWebhooks

User Updated`clerk_webhook_user_updated`

Fired when a user's profile data changes.

UsersWebhooks

User Deleted`clerk_webhook_user_deleted`

Fired when a user account is removed from your Clerk instance.

UsersWebhooks

Session Created`clerk_webhook_session_created`

Fired when a user successfully signs in and a new session is created.

SessionsWebhooks

Session Ended`clerk_webhook_session_ended`

Fired when a user signs out or their session expires naturally.

SessionsWebhooks

Session Removed`clerk_webhook_session_removed`

Fired when a session is removed, typically after all its sign-ins have ended or expired.

SessionsWebhooks

Session Revoked`clerk_webhook_session_revoked`

Fired when a session is forcefully terminated (for example, by an admin or the user from another device).

SessionsWebhooks

Organization Created`clerk_webhook_organization_created`

Fired when a new organization is created in your Clerk instance.

OrganizationsWebhooks

Organization Updated`clerk_webhook_organization_updated`

Fired when an organization's settings change.

OrganizationsWebhooks

Organization Deleted`clerk_webhook_organization_deleted`

Fired when an organization is deleted from your Clerk instance.

OrganizationsWebhooks

Organization Domain Created`clerk_webhook_organization_domain_created`

Fired when a verified or unverified domain is added to an organization.

Organization DomainsWebhooks

Organization Domain Updated`clerk_webhook_organization_domain_updated`

Fired when an organization domain's verification status or enrollment mode changes.

Organization DomainsWebhooks

Organization Domain Deleted`clerk_webhook_organization_domain_deleted`

Fired when a domain is removed from an organization.

Organization DomainsWebhooks

Organization Membership Created`clerk_webhook_organization_membership_created`

Fired when a user joins an organization.

Organization MembershipsWebhooks

Organization Membership Updated`clerk_webhook_organization_membership_updated`

Fired when a membership's role changes.

Organization MembershipsWebhooks

Organization Membership Deleted`clerk_webhook_organization_membership_deleted`

Fired when a user is removed from an organization.

Organization MembershipsWebhooks

Organization Invitation Created`clerk_webhook_organization_invitation_created`

Fired when a user is invited to join an organization.

Organization InvitationsWebhooks

Organization Invitation Accepted`clerk_webhook_organization_invitation_accepted`

Fired when an invited user accepts an organization invitation.

Organization InvitationsWebhooks

Organization Invitation Revoked`clerk_webhook_organization_invitation_revoked`

Fired when a pending organization invitation is revoked.

Organization InvitationsWebhooks

Role Created`clerk_webhook_role_created`

Fired when a new organization role is created.

Organization RolesWebhooks

Role Updated`clerk_webhook_role_updated`

Fired when an organization role's name, key, description or permissions change.

Organization RolesWebhooks

Role Deleted`clerk_webhook_role_deleted`

Fired when an organization role is deleted.

Organization RolesWebhooks

Permission Created`clerk_webhook_permission_created`

Fired when a new custom permission is created.

PermissionsWebhooks

Permission Updated`clerk_webhook_permission_updated`

Fired when a custom permission's name, key or description changes.

PermissionsWebhooks

Permission Deleted`clerk_webhook_permission_deleted`

Fired when a custom permission is deleted.

PermissionsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.