rocketkind
Security

Clerk

Clerk is a hosted authentication and user-management service: the users who sign in to your application, the organizations they belong to, the invitations that let new people in and the sessions they are signed in with.

Authentication

  • Secret key

Actions

Generic API request. Call any Clerk API endpoint on this connection, for the case where no shipped action covers it yet. The connection supplies the base URL, the authentication and the egress route, so only the path, query and body are yours to fill.

  • Add organization member (v1)Add an existing user to an organization with a role, e.g. after provisioning the user and the organization for a new customer.
  • Ban user (v1)DestructiveBan a user: every one of their sessions is revoked and they cannot sign in again until unbanned.
  • Create invitation (v1)Invite someone to sign up to your application by email - the right tool when the person has no Clerk account yet (on a restricted or waitlist instance, it is how they get in).
  • Create organization (v1)Create an organization (a tenant, team or workspace in your app), optionally making an existing user its admin.
  • Create user (v1)Create a user in the connected Clerk instance, e.g. to provision an account from an HR or CRM record, or to migrate users in.
  • Delete user (v1)DestructivePermanently delete a user and everything Clerk holds for them - sessions, identifiers, memberships.
  • Get organization (v1)Fetch one organization by its id or slug - name, slug, member and pending-invitation counts, membership cap and metadata.
  • Get user (v1)Fetch one Clerk user by id - their email addresses, phone numbers, names, ban/lock state, last sign-in and the public/private/unsafe metadata maps.
  • List invitations (v1)List the application invitations you have sent, newest first - e.g. to find pending ones to chase or revoke, or to check whether an address was already invited.
  • List organization memberships (v1)List the members of one organization with their role and basic profile, e.g. to audit who holds admin, or to check whether a user already belongs before adding them.
  • List organizations (v1)List or search the organizations (tenants/teams) in the connected Clerk instance, e.g. to find an organization by name or slug, or to list the organizations a user belongs to.
  • List sessions (v1)List one user's sign-in sessions, newest first - e.g. to see where they are signed in before forcing a sign-out, or to find the session id Revoke session needs.
  • List users (v1)Search or page through the users of the connected Clerk instance - to find a user by email, username or free-text query, to export the user base, or to look up the Clerk id of someone you know from another system (externalid).
  • Revoke invitation (v1)DestructiveRevoke a pending invitation so its link stops working, e.g. when an invite went to the wrong address or access was withdrawn.
  • Revoke session (v1)DestructiveSign a user out of one session immediately, e.g. a lost device or a suspicious sign-in.
  • Unban user (v1)DestructiveLift a ban so the user can sign in again.
  • Update user (v1)DestructiveChange a user's profile fields - names, username, externalid, locale and their self-service permissions.

Product names, logos and brands are the property of their respective owners and are used here for identification only. Their use does not imply endorsement by, or affiliation with, those owners.