The Clerk REST Backend API, meant to be accessed by backend servers. Please see https://clerk.dev/docs for more information.
For more information, please visit https://clerk.dev/support
This API client was generated by the OpenAPI Generator project. By using the openapi-spec from a remote server, you can easily generate an API client.
org.openapitools.codegen.languages.RustClientCodegenPut the package under your project folder in a directory named openapi and add the following to Cargo.toml under [dependencies]:
openapi = { path = "./openapi" }
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/svix_url | Create a Svix Dashboard URL
To get access to the crate's generated documentation, use:
cargo doc --open
support@clerk.dev