Clerk Ruby HTTP Client
ClerkHttpClient - the Ruby gem for the Clerk Backend API
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. 2021-02-05. For more information, please see Clerk API Versions.
Please see https://clerk.com/docs for more information.
This SDK is automatically generated by the OpenAPI Generator project and is designed to be used soley with the Clerk Ruby SDK.
- API version: v1
- Package version: 1.0.0
- Generator version: unset
- Build package: org.openapitools.codegen.languages.ClerkRubyClientCodegen
For more information, please visit https://clerk.com/support
Getting Started
Please note that this client is not meant to be used directly. It is designed to be used soley with the Clerk Ruby SDK. Please review that repository for setup information.
Installation
gem 'clerk-sdk-ruby', '~> 4.0', require: 'clerk'
Generate a client
bin/generate
Documentation for API Endpoints
All URIs are relative to https://api.clerk.com/v1
| Class | Method | HTTP request | Description |
|---|---|---|---|
| Clerk::SDK.actor_tokens | create_actor_token | POST /actor_tokens | Create actor token |
| Clerk::SDK.actor_tokens | revoke_actor_token | POST /actor_tokens/actor_token_id/revoke | Revoke actor token |
| Clerk::SDK.allow_list_block_list | create_allowlist_identifier | POST /allowlist_identifiers | Add identifier to the allow-list |
| Clerk::SDK.allow_list_block_list | create_blocklist_identifier | POST /blocklist_identifiers | Add identifier to the block-list |
| Clerk::SDK.allow_list_block_list | delete_allowlist_identifier | DELETE /allowlist_identifiers/identifier_id | Delete identifier from allow-list |
| Clerk::SDK.allow_list_block_list | delete_blocklist_identifier | DELETE /blocklist_identifiers/identifier_id | Delete identifier from block-list |
| Clerk::SDK.allow_list_block_list | list_allowlist_identifiers | GET /allowlist_identifiers | List all identifiers on the allow-list |
| Clerk::SDK.allow_list_block_list | list_blocklist_identifiers | GET /blocklist_identifiers | List all identifiers on the block-list |
| Clerk::SDK.beta_features | change_production_instance_domain | POST /instance/change_domain | Update production instance domain |
| Clerk::SDK.beta_features | update_instance_auth_config | PATCH /beta_features/instance_settings | Update instance settings |
| Clerk::SDK.beta_features | update_production_instance_domain | PUT /beta_features/domain | Update production instance domain |
| Clerk::SDK.clients | get_client | GET /clients/client_id | Get a client |
| Clerk::SDK.clients | get_client_list | GET /clients | List all clients |
| Clerk::SDK.clients | verify_client | POST /clients/verify | Verify a client |
| Clerk::SDK.domains | add_domain | POST /domains | Add a domain |
| Clerk::SDK.domains | delete_domain | DELETE /domains/domain_id | Delete a satellite domain |
| Clerk::SDK.domains | list_domains | GET /domains | List all instance domains |
| Clerk::SDK.domains | update_domain | PATCH /domains/domain_id | Update a domain |
| Clerk::SDK.email_addresses | create_email_address | POST /email_addresses | Create an email address |
| Clerk::SDK.email_addresses | delete_email_address | DELETE /email_addresses/email_address_id | Delete an email address |
| Clerk::SDK.email_addresses | get_email_address | GET /email_addresses/email_address_id | Retrieve an email address |
| Clerk::SDK.email_addresses | update_email_address | PATCH /email_addresses/email_address_id | Update an email address |
| Clerk::SDK.email_sms_templates | get_template | GET /templates/template_type/slug | Retrieve a template |
| Clerk::SDK.email_sms_templates | get_template_list | GET /templates/template_type | List all templates |
| Clerk::SDK.email_sms_templates | preview_template | POST /templates/template_type/slug/preview | Preview changes to a template |
| Clerk::SDK.email_sms_templates | revert_template | POST /templates/template_type/slug/revert | Revert a template |
| Clerk::SDK.email_sms_templates | toggle_template_delivery | POST /templates/template_type/slug/toggle_delivery | Toggle the delivery by Clerk for a template of a given type and slug |
| Clerk::SDK.email_sms_templates | upsert_template | PUT /templates/template_type/slug | Update a template for a given type and slug |
| Clerk::SDK.instance_settings | get_instance | GET /instance | Fetch the current instance |
| Clerk::SDK.instance_settings | update_instance | PATCH /instance | Update instance settings |
| Clerk::SDK.instance_settings | update_instance_organization_settings | PATCH /instance/organization_settings | Update instance organization settings |
| Clerk::SDK.instance_settings | update_instance_restrictions | PATCH /instance/restrictions | Update instance restrictions |
| Clerk::SDK.invitations | create_bulk_invitations | POST /invitations/bulk | Create multiple invitations |
| Clerk::SDK.invitations | create_invitation | POST /invitations | Create an invitation |
| Clerk::SDK.invitations | list_invitations | GET /invitations | List all invitations |
| Clerk::SDK.invitations | revoke_invitation | POST /invitations/invitation_id/revoke | Revokes an invitation |
| Clerk::SDK.jwks | get_jwks | GET /jwks | Retrieve the JSON Web Key Set of the instance |
| Clerk::SDK.jwt_templates | create_jwt_template | POST /jwt_templates | Create a JWT template |
| Clerk::SDK.jwt_templates | delete_jwt_template | DELETE /jwt_templates/template_id | Delete a Template |
| Clerk::SDK.jwt_templates | get_jwt_template | GET /jwt_templates/template_id | Retrieve a template |
| Clerk::SDK.jwt_templates | list_jwt_templates | GET /jwt_templates | List all templates |
| Clerk::SDK.jwt_templates | update_jwt_template | PATCH /jwt_templates/template_id | Update a JWT template |
| Clerk::SDK.miscellaneous | get_public_interstitial | GET /public/interstitial | Returns the markup for the interstitial page |
| Clerk::SDK.oauth_applications | create_oauth_application | POST /oauth_applications | Create an OAuth application |
| Clerk::SDK.oauth_applications | delete_oauth_application | DELETE /oauth_applications/oauth_application_id | Delete an OAuth application |
| Clerk::SDK.oauth_applications | get_oauth_application | GET /oauth_applications/oauth_application_id | Retrieve an OAuth application by ID |
| Clerk::SDK.oauth_applications | list_oauth_applications | GET /oauth_applications | Get a list of OAuth applications for an instance |
| Clerk::SDK.oauth_applications | rotate_oauth_application_secret | POST /oauth_applications/oauth_application_id/rotate_secret | Rotate the client secret of the given OAuth application |
| Clerk::SDK.oauth_applications | update_oauth_application | PATCH /oauth_applications/oauth_application_id | Update an OAuth application |
| Clerk::SDK.organization_domains | create_organization_domain | POST /organizations/organization_id/domains | Create a new organization domain. |
| Clerk::SDK.organization_domains | delete_organization_domain | DELETE /organizations/organization_id/domains/domain_id | Remove a domain from an organization. |
| Clerk::SDK.organization_domains | list_organization_domains | GET /organizations/organization_id/domains | Get a list of all domains of an organization. |
| Clerk::SDK.organization_domains | update_organization_domain | PATCH /organizations/organization_id/domains/domain_id | Update an organization domain. |
| Clerk::SDK.organization_invitations | create_organization_invitation | POST /organizations/organization_id/invitations | Create and send an organization invitation |
| Clerk::SDK.organization_invitations | create_organization_invitation_bulk | POST /organizations/organization_id/invitations/bulk | Bulk create and send organization invitations |
| Clerk::SDK.organization_invitations | get_organization_invitation | GET /organizations/organization_id/invitations/invitation_id | Retrieve an organization invitation by ID |
| Clerk::SDK.organization_invitations | list_instance_organization_invitations | GET /organization_invitations | Get a list of organization invitations for the current instance |
| Clerk::SDK.organization_invitations | list_organization_invitations | GET /organizations/organization_id/invitations | Get a list of organization invitations |
| Clerk::SDK.organization_invitations | list_pending_organization_invitations | GET /organizations/organization_id/invitations/pending | Get a list of pending organization invitations |
| Clerk::SDK.organization_invitations | revoke_organization_invitation | POST /organizations/organization_id/invitations/invitation_id/revoke | Revoke a pending organization invitation |
| Clerk::SDK.organization_memberships | create_organization_membership | POST /organizations/organization_id/memberships | Create a new organization membership |
| Clerk::SDK.organization_memberships | delete_organization_membership | DELETE /organizations/organization_id/memberships/user_id | Remove a member from an organization |
| Clerk::SDK.organization_memberships | instance_get_organization_memberships | GET /organization_memberships | Get a list of all organization memberships within an instance. |
| Clerk::SDK.organization_memberships | list_organization_memberships | GET /organizations/organization_id/memberships | Get a list of all members of an organization |
| Clerk::SDK.organization_memberships | update_organization_membership | PATCH /organizations/organization_id/memberships/user_id | Update an organization membership |
| Clerk::SDK.organization_memberships | update_organization_membership_metadata | PATCH /organizations/organization_id/memberships/user_id/metadata | Merge and update organization membership metadata |
| Clerk::SDK.organizations | create_organization | POST /organizations | Create an organization |
| Clerk::SDK.organizations | delete_organization | DELETE /organizations/organization_id | Delete an organization |
| Clerk::SDK.organizations | delete_organization_logo | DELETE /organizations/organization_id/logo | |
| Clerk::SDK.organizations | get_organization | GET /organizations/organization_id | Retrieve an organization by ID or slug |
| Clerk::SDK.organizations | list_organizations | GET /organizations | Get a list of organizations for an instance |
| Clerk::SDK.organizations | merge_organization_metadata | PATCH /organizations/organization_id/metadata | Merge and update metadata for an organization |
| Clerk::SDK.organizations | update_organization | PATCH /organizations/organization_id | Update an organization |
| Clerk::SDK.organizations | upload_organization_logo | PUT /organizations/organization_id/logo | Upload a logo for the organization |
| Clerk::SDK.phone_numbers | create_phone_number | POST /phone_numbers | Create a phone number |
| Clerk::SDK.phone_numbers | delete_phone_number | DELETE /phone_numbers/phone_number_id | Delete a phone number |
| Clerk::SDK.phone_numbers | get_phone_number | GET /phone_numbers/phone_number_id | Retrieve a phone number |
| Clerk::SDK.phone_numbers | update_phone_number | PATCH /phone_numbers/phone_number_id | Update a phone number |
| Clerk::SDK.proxy_checks | verify_domain_proxy | POST /proxy_checks | Verify the proxy configuration for your domain |
| Clerk::SDK.redirect_urls | create_redirect_url | POST /redirect_urls | Create a redirect URL |
| Clerk::SDK.redirect_urls | delete_redirect_url | DELETE /redirect_urls/id | Delete a redirect URL |
| Clerk::SDK.redirect_urls | get_redirect_url | GET /redirect_urls/id | Retrieve a redirect URL |
| Clerk::SDK.redirect_urls | list_redirect_urls | GET /redirect_urls | List all redirect URLs |
| Clerk::SDK.saml_connections | create_saml_connection | POST /saml_connections | Create a SAML Connection |
| Clerk::SDK.saml_connections | delete_saml_connection | DELETE /saml_connections/saml_connection_id | Delete a SAML Connection |
| Clerk::SDK.saml_connections | get_saml_connection | GET /saml_connections/saml_connection_id | Retrieve a SAML Connection by ID |
| Clerk::SDK.saml_connections | list_saml_connections | GET /saml_connections | Get a list of SAML Connections for an instance |
| Clerk::SDK.saml_connections | update_saml_connection | PATCH /saml_connections/saml_connection_id | Update a SAML Connection |
| Clerk::SDK.sessions | create_session | POST /sessions | Create a new active session |
| Clerk::SDK.sessions | create_session_token | POST /sessions/session_id/tokens | Create a session token |
| Clerk::SDK.sessions | create_session_token_from_template | POST /sessions/session_id/tokens/template_name | Create a session token from a jwt template |
| Clerk::SDK.sessions | get_session | GET /sessions/session_id | Retrieve a session |
| Clerk::SDK.sessions | get_session_list | GET /sessions | List all sessions |
| Clerk::SDK.sessions | revoke_session | POST /sessions/session_id/revoke | Revoke a session |
| Clerk::SDK.sessions | verify_session | POST /sessions/session_id/verify | Verify a session |
| Clerk::SDK.sign_in_tokens | create_sign_in_token | POST /sign_in_tokens | Create sign-in token |
| Clerk::SDK.sign_in_tokens | revoke_sign_in_token | POST /sign_in_tokens/sign_in_token_id/revoke | Revoke the given sign-in token |
| Clerk::SDK.sign_ups | update_sign_up | PATCH /sign_ups/id | Update a sign-up |
| Clerk::SDK.testing_tokens | create_testing_token | POST /testing_tokens | Retrieve a new testing token |
| Clerk::SDK.users | ban_user | POST /users/user_id/ban | Ban a user |
| Clerk::SDK.users | create_user | POST /users | Create a new user |
| Clerk::SDK.users | create_user_totp | POST /users/user_id/totp | Create a TOTP for a user |
| Clerk::SDK.users | delete_backup_code | DELETE /users/user_id/backup_code | Disable all user's Backup codes |
| Clerk::SDK.users | delete_external_account | DELETE /users/user_id/external_accounts/external_account_id | Delete External Account |
| Clerk::SDK.users | delete_totp | DELETE /users/user_id/totp | Delete all the user's TOTPs |
| Clerk::SDK.users | delete_user | DELETE /users/user_id | Delete a user |
| Clerk::SDK.users | delete_user_profile_image | DELETE /users/user_id/profile_image | Delete user profile image |
| Clerk::SDK.users | disable_mfa | DELETE /users/user_id/mfa | Disable a user's MFA methods |
| Clerk::SDK.users | get_oauth_access_token | GET /users/user_id/oauth_access_tokens/provider | Retrieve the OAuth access token of a user |
| Clerk::SDK.users | get_user | GET /users/user_id | Retrieve a user |
| Clerk::SDK.users | get_user_list | GET /users | List all users |
| Clerk::SDK.users | get_users_count | GET /users/count | Count users |
| Clerk::SDK.users | lock_user | POST /users/user_id/lock | Lock a user |
| Clerk::SDK.users | set_user_profile_image | POST /users/user_id/profile_image | Set user profile image |
| Clerk::SDK.users | unban_user | POST /users/user_id/unban | Unban a user |
| Clerk::SDK.users | unlock_user | POST /users/user_id/unlock | Unlock a user |
| Clerk::SDK.users | update_user | PATCH /users/user_id | Update a user |
| Clerk::SDK.users | update_user_metadata | PATCH /users/user_id/metadata | Merge and update a user's metadata |
| Clerk::SDK.users | user_passkey_delete | DELETE /users/user_id/passkeys/passkey_identification_id | Delete a user passkey |
| Clerk::SDK.users | user_web3_wallet_delete | DELETE /users/user_id/web3_wallets/web3_wallet_identification_id | Delete a user web3 wallet |
| Clerk::SDK.users | users_get_organization_invitations | GET /users/user_id/organization_invitations | Retrieve all invitations for a user |
| Clerk::SDK.users | users_get_organization_memberships | GET /users/user_id/organization_memberships | Retrieve all memberships for a user |
| Clerk::SDK.users | verify_password | POST /users/user_id/verify_password | Verify the password of a user |
| Clerk::SDK.users | verify_totp | POST /users/user_id/verify_totp | Verify a TOTP or backup code for a user |
| Clerk::SDK.waitlist_entries | create_waitlist_entry | POST /waitlist_entries | Create a waitlist entry |
| Clerk::SDK.waitlist_entries | list_waitlist_entries | GET /waitlist_entries | List all waitlist entries |
| Clerk::SDK.webhooks | create_svix_app | POST /webhooks/svix | Create a Svix app |
| Clerk::SDK.webhooks | delete_svix_app | DELETE /webhooks/svix | Delete a Svix app |
| Clerk::SDK.webhooks | generate_svix_auth_url | POST /webhooks/svix_url | Create a Svix Dashboard URL |
Documentation for Models
- ClerkHttpClient::ActorToken
- ClerkHttpClient::AddDomainRequest
- ClerkHttpClient::Admin
- ClerkHttpClient::AllowlistIdentifier
- ClerkHttpClient::BlocklistIdentifier
- ClerkHttpClient::BlocklistIdentifiers
- ClerkHttpClient::CNameTarget
- ClerkHttpClient::ChangeProductionInstanceDomainRequest
- ClerkHttpClient::ClerkError
- ClerkHttpClient::ClerkErrors
- ClerkHttpClient::Client
- ClerkHttpClient::CreateActorTokenRequest
- ClerkHttpClient::CreateAllowlistIdentifierRequest
- ClerkHttpClient::CreateBlocklistIdentifierRequest
- ClerkHttpClient::CreateBulkInvitationsRequestInner
- ClerkHttpClient::CreateEmailAddressRequest
- ClerkHttpClient::CreateInvitationRequest
- ClerkHttpClient::CreateJWTTemplateRequest
- ClerkHttpClient::CreateOAuthApplicationRequest
- ClerkHttpClient::CreateOrganizationDomainRequest
- ClerkHttpClient::CreateOrganizationInvitationBulkRequestInner
- ClerkHttpClient::CreateOrganizationInvitationRequest
- ClerkHttpClient::CreateOrganizationMembershipRequest
- ClerkHttpClient::CreateOrganizationRequest
- ClerkHttpClient::CreatePhoneNumberRequest
- ClerkHttpClient::CreateRedirectURLRequest
- ClerkHttpClient::CreateSAMLConnectionRequest
- ClerkHttpClient::CreateSAMLConnectionRequestAttributeMapping
- ClerkHttpClient::CreateSessionRequest
- ClerkHttpClient::CreateSessionToken200Response
- ClerkHttpClient::CreateSessionTokenFromTemplateRequest
- ClerkHttpClient::CreateSessionTokenRequest
- ClerkHttpClient::CreateSignInTokenRequest
- ClerkHttpClient::CreateUserRequest
- ClerkHttpClient::CreateWaitlistEntryRequest
- ClerkHttpClient::DeletedObject
- ClerkHttpClient::DisableMFA200Response
- ClerkHttpClient::Domain
- ClerkHttpClient::Domains
- ClerkHttpClient::EmailAddress
- ClerkHttpClient::EmailAddressVerification
- ClerkHttpClient::FromOAuth
- ClerkHttpClient::FromOAuthError
- ClerkHttpClient::GetOAuthAccessToken200ResponseInner
- ClerkHttpClient::IdentificationLink
- ClerkHttpClient::Instance
- ClerkHttpClient::InstanceRestrictions
- ClerkHttpClient::Invitation
- ClerkHttpClient::JWKS
- ClerkHttpClient::JWKSKeysInner
- ClerkHttpClient::JWTTemplate
- ClerkHttpClient::ListWaitlistEntries200Response
- ClerkHttpClient::MergeOrganizationMetadataRequest
- ClerkHttpClient::OAuthApplication
- ClerkHttpClient::OAuthApplicationWithSecret
- ClerkHttpClient::OAuthApplications
- ClerkHttpClient::OTP
- ClerkHttpClient::Organization
- ClerkHttpClient::OrganizationDomain
- ClerkHttpClient::OrganizationDomainVerification
- ClerkHttpClient::OrganizationDomains
- ClerkHttpClient::OrganizationInvitation
- ClerkHttpClient::OrganizationInvitationWithPublicOrganizationData
- ClerkHttpClient::OrganizationInvitationWithPublicOrganizationDataPublicOrganizationData
- ClerkHttpClient::OrganizationInvitations
- ClerkHttpClient::OrganizationInvitationsWithPublicOrganizationData
- ClerkHttpClient::OrganizationMembership
- ClerkHttpClient::OrganizationMembershipPublicUserData
- ClerkHttpClient::OrganizationMemberships
- ClerkHttpClient::OrganizationSettings
- ClerkHttpClient::OrganizationWithLogo
- ClerkHttpClient::Organizations
- ClerkHttpClient::Passkey
- ClerkHttpClient::PhoneNumber
- ClerkHttpClient::PhoneNumberVerification
- ClerkHttpClient::PreviewTemplateRequest
- ClerkHttpClient::ProxyCheck
- ClerkHttpClient::RedirectURL
- ClerkHttpClient::RevokeInvitation200Response
- ClerkHttpClient::RevokeOrganizationInvitationRequest
- ClerkHttpClient::SAML
- ClerkHttpClient::SAMLAccount
- ClerkHttpClient::SAMLAccountSamlConnection
- ClerkHttpClient::SAMLAccountVerification
- ClerkHttpClient::SAMLConnection
- ClerkHttpClient::SAMLConnections
- ClerkHttpClient::SchemasPasskey
- ClerkHttpClient::SchemasPasskeyVerification
- ClerkHttpClient::SchemasSAMLConnection
- ClerkHttpClient::SchemasSAMLConnectionAttributeMapping
- ClerkHttpClient::Session
- ClerkHttpClient::SessionLatestActivity
- ClerkHttpClient::SignInToken
- ClerkHttpClient::SignUp
- ClerkHttpClient::SvixURL
- ClerkHttpClient::TOTP
- ClerkHttpClient::Template
- ClerkHttpClient::TestingToken
- ClerkHttpClient::Ticket
- ClerkHttpClient::ToggleTemplateDeliveryRequest
- ClerkHttpClient::TotalCount
- ClerkHttpClient::UpdateDomainRequest
- ClerkHttpClient::UpdateEmailAddressRequest
- ClerkHttpClient::UpdateInstanceAuthConfig200Response
- ClerkHttpClient::UpdateInstanceAuthConfigRequest
- ClerkHttpClient::UpdateInstanceOrganizationSettingsRequest
- ClerkHttpClient::UpdateInstanceRequest
- ClerkHttpClient::UpdateInstanceRestrictionsRequest
- ClerkHttpClient::UpdateOAuthApplicationRequest
- ClerkHttpClient::UpdateOrganizationDomainRequest
- ClerkHttpClient::UpdateOrganizationMembershipMetadataRequest
- ClerkHttpClient::UpdateOrganizationMembershipRequest
- ClerkHttpClient::UpdateOrganizationRequest
- ClerkHttpClient::UpdatePhoneNumberRequest
- ClerkHttpClient::UpdateProductionInstanceDomainRequest
- ClerkHttpClient::UpdateSAMLConnectionRequest
- ClerkHttpClient::UpdateSAMLConnectionRequestAttributeMapping
- ClerkHttpClient::UpdateSignUpRequest
- ClerkHttpClient::UpdateUserMetadataRequest
- ClerkHttpClient::UpdateUserRequest
- ClerkHttpClient::UpsertTemplateRequest
- ClerkHttpClient::User
- ClerkHttpClient::VerifyClientRequest
- ClerkHttpClient::VerifyDomainProxyRequest
- ClerkHttpClient::VerifyPassword200Response
- ClerkHttpClient::VerifyPasswordRequest
- ClerkHttpClient::VerifySessionRequest
- ClerkHttpClient::VerifyTOTP200Response
- ClerkHttpClient::VerifyTOTPRequest
- ClerkHttpClient::WaitlistEntry
- ClerkHttpClient::Web3Signature
- ClerkHttpClient::Web3Wallet
- ClerkHttpClient::Web3WalletVerification
Documentation for Authorization
Authentication schemes defined for the API:
bearerAuth
- Type: Bearer authentication (sk_
_ )