The Clerk REST Backend API, meant to be accessed by backend servers. Please see https://clerk.com/docs for more information.
[dependencies]
clerk-sdk-rust-communtiy = { version = "1" }
All URIs are relative to https://api.clerk.dev/v1
| Class | Method | HTTP request | Description | | ---------------------------- | ------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ------------------------------------------------- | | ActorTokensApi | createactortoken | POST /actortokens | Create actor token | | _ActorTokensApi | revokeactortoken | POST /actortokens/{actortokenid}/revoke | Revoke actor token | | _AllowListBlockListApi | createallowlistidentifier | POST /allowlistidentifiers | Add identifier to the allow-list | | _AllowListBlockListApi | createblocklistidentifier | POST /blocklistidentifiers | Add identifier to the block-list | | _AllowListBlockListApi | deleteallowlistidentifier | DELETE /allowlistidentifiers/{identifierid} | Delete identifier from allow-list | | AllowListBlockListApi | deleteblocklistidentifier | DELETE /blocklistidentifiers/{identifierid} | Delete identifier from block-list | | AllowListBlockListApi | listallowlistidentifiers | GET /allowlistidentifiers | List all identifiers on the allow-list | | _AllowListBlockListApi | listblocklistidentifiers | GET /blocklistidentifiers | List all identifiers on the block-list | | _BetaFeaturesApi | updateinstanceauthconfig | PATCH /betafeatures/instancesettings | Update instance settings | | _BetaFeaturesApi | updateproductioninstancedomain | PUT /betafeatures/domain | Update production instance domain | | ClientsApi | getclient | GET /clients/{clientid} | Get a client | | ClientsApi | getclientlastactivesession | GET /clients/{clientid}/lastactivesession | Get the last active session of a client | | _ClientsApi | getclientlist | GET /clients | List all clients | | ClientsApi | verifyclient | POST /clients/verify | Verify a client | | _EmailAddressesApi | createemailaddress | POST /emailaddresses | Create an email address | | _EmailAddressesApi | deleteemailaddress | DELETE /emailaddresses/{emailaddressid} | Delete an email address | | _EmailAddressesApi | getemailaddress | GET /emailaddresses/{emailaddressid} | Retrieve an email address | | _EmailAddressesApi | updateemailaddress | PATCH /emailaddresses/{emailaddressid} | Update an email address | | _EmailSmsTemplatesApi | gettemplate | GET /templates/{templatetype}/{slug} | Retrieve a template | | EmailSmsTemplatesApi | gettemplatelist | GET /templates/{templatetype} | List all templates | | _EmailSmsTemplatesApi | previewtemplate | POST /templates/{templatetype}/{slug}/preview | Preview changes to a template | | EmailSmsTemplatesApi | reverttemplate | POST /templates/{templatetype}/{slug}/revert | Revert a template | | EmailSmsTemplatesApi | upserttemplate | PUT /templates/{templatetype}/{slug} | Update a template for a given type and slug | | EmailsApi | createemail | POST /emails | Create an email | | _InstanceSettingsApi | updateinstance | PATCH /instance | Update instance settings | | _InstanceSettingsApi | updateinstanceorganizationsettings | PATCH /instance/organizationsettings | Update instance organization settings | | InstanceSettingsApi | updateinstancerestrictions | PATCH /instance/restrictions | Update instance restrictions | | InvitationsApi | createinvitation | POST /invitations | Create an invitation | | _InvitationsApi | listinvitations | GET /invitations | List all invitations | | _InvitationsApi | revokeinvitation | POST /invitations/{invitationid}/revoke | Revokes an invitation | | JwksApi | getjwks | GET /jwks | Retrieve the JSON Web Key Set of the instance | | _JwtTemplatesApi | createjwttemplate | POST /jwttemplates | Create a JWT template | | _JwtTemplatesApi | deletejwttemplate | DELETE /jwttemplates/{templateid} | Delete a Template | | JwtTemplatesApi | getjwttemplate | GET /jwttemplates/{templateid} | Retrieve a template | | JwtTemplatesApi | listjwttemplates | GET /jwttemplates | List all templates | | _JwtTemplatesApi | updatejwttemplate | PATCH /jwttemplates/{templateid} | Update a JWT template | | MiscellaneousApi | createdemoinstance | POST /public/demoinstance | Create a demo development instance | | _MiscellaneousApi | getpublicinterstitial | GET /public/interstitial | Returns the markup for the interstitial page | | OrganizationInvitationsApi | createorganizationinvitation | POST /organizations/{organizationid}/invitations | Create and send an organization invitation | | _OrganizationInvitationsApi | listpendingorganizationinvitations | GET /organizations/{organizationid}/invitations/pending | Get a list of pending organization invitations | | OrganizationInvitationsApi | revokeorganizationinvitation | POST /organizations/{organizationid}/invitations/{invitationid}/revoke | Revoke a pending organization invitation | | OrganizationMembershipsApi | createorganizationmembership | POST /organizations/{organizationid}/memberships | Create a new organization membership | | _OrganizationMembershipsApi | deleteorganizationmembership | DELETE /organizations/{organizationid}/memberships/{userid} | Remove a member from an organization | | OrganizationMembershipsApi | listorganizationmemberships | GET /organizations/{organizationid}/memberships | Get a list of all members of an organization | | _OrganizationMembershipsApi | updateorganizationmembership | PATCH /organizations/{organizationid}/memberships/{userid} | Update an organization membership | | OrganizationMembershipsApi | updateorganizationmembershipmetadata | PATCH /organizations/{organizationid}/memberships/{userid}/metadata | Merge and update organization membership metadata | | _OrganizationsApi | createorganization | POST /organizations | Create an organization | | _OrganizationsApi | deleteorganization | DELETE /organizations/{organizationid} | Delete an organization | | OrganizationsApi | getorganization | GET /organizations/{organizationid} | Retrieve an organization by ID or slug | | OrganizationsApi | listorganizations | GET /organizations | Get a list of organizations for an instance | | _OrganizationsApi | mergeorganizationmetadata | PATCH /organizations/{organizationid}/metadata | Merge and update metadata for an organization | | _OrganizationsApi | updateorganization | PATCH /organizations/{organizationid} | Update an organization | | OrganizationsApi | uploadorganizationlogo | PUT /organizations/{organizationid}/logo | Upload a logo for the organization | | _PhoneNumbersApi | createphonenumber | POST /phonenumbers | Create a phone number | | _PhoneNumbersApi | deletephonenumber | DELETE /phonenumbers/{phonenumberid} | Delete a phone number | | _PhoneNumbersApi | getphonenumber | GET /phonenumbers/{phonenumberid} | Retrieve a phone number | | _PhoneNumbersApi | updatephonenumber | PATCH /phonenumbers/{phonenumberid} | Update a phone number | | _RedirectUrlsApi | createredirecturl | POST /redirecturls | | _RedirectUrlsApi | deleteredirecturl | DELETE /redirecturls/{id} | Delete a redirect URL | | _RedirectUrlsApi | getredirecturl | GET /redirecturls/{id} | Retrieve a redirect URL | | _RedirectUrlsApi | listredirecturls | GET /redirecturls | List all redirect URLs | | _SmsMessagesApi | createsmsmessage | POST /smsmessages | Create an SMS message | | _SessionsApi | createsessiontokenfromtemplate | POST /sessions/{sessionid}/tokens/{templatename} | Create a session token from a jwt template | | SessionsApi | getsession | GET /sessions/{sessionid} | Retrieve a session | | SessionsApi | getsessionlist | GET /sessions | List all sessions | | SessionsApi | revokesession | POST /sessions/{sessionid}/revoke | Revoke a session | | SessionsApi | verifysession | POST /sessions/{sessionid}/verify | Verify a session | | SignInTokensApi | createsignintoken | POST /signintokens | Create sign-in token | | _SignInTokensApi | revokesignintoken | POST /signintokens/{signintokenid}/revoke | Revoke the given sign-in token | | SignUpsApi | updatesignup | PATCH /signups/{id} | Update a sign-up | | _UsersApi | banuser | POST /users/{userid}/ban | Ban a user | | UsersApi | createuser | POST /users | Create a new user | | _UsersApi | deleteuser | DELETE /users/{userid} | Delete a user | | UsersApi | disablemfa | DELETE /users/{userid}/mfa | Disable a user's MFA methods | | UsersApi | getoauthaccesstoken | GET /users/{userid}/oauthaccesstokens/{provider} | Retrieve the OAuth access token of a user | | _UsersApi | getuser | GET /users/{userid} | Retrieve a user | | UsersApi | getuserlist | GET /users | List all users | | UsersApi | getuserscount | GET /users/count | Count users | | UsersApi | unbanuser | POST /users/{userid}/unban | Unban a user | | UsersApi | updateuser | PATCH /users/{userid} | Update a user | | UsersApi | updateusermetadata | PATCH /users/{userid}/metadata | Merge and update a user's metadata | | _UsersApi | usersgetorganizationmemberships | GET /users/{userid}/organizationmemberships | Retrieve all memberships for a user | | _UsersApi | verifypassword | POST /users/{userid}/verifypassword | Verify the password of a user | | _UsersApi | verifytotp | POST /users/{userid}/verifytotp | Verify a TOTP or backup code for a user | | _WebhooksApi | createsvixapp | POST /webhooks/svix | Create a Svix app | | WebhooksApi | deletesvixapp | DELETE /webhooks/svix | Delete a Svix app | | WebhooksApi | generatesvixauthurl | POST /webhooks/svixurl | Create a Svix Dashboard URL |