Module: ClerkHttpClient

Defined in:
lib/clerk-http-client/version.rb,
lib/clerk-http-client.rb,
lib/clerk-http-client/api_error.rb,
lib/clerk-http-client/api_client.rb,
lib/clerk-http-client/models/otp.rb,
lib/clerk-http-client/models/jwks.rb,
lib/clerk-http-client/models/saml.rb,
lib/clerk-http-client/models/totp.rb,
lib/clerk-http-client/models/user.rb,
lib/clerk-http-client/api/jwks_api.rb,
lib/clerk-http-client/models/admin.rb,
lib/clerk-http-client/models/oauth.rb,
lib/clerk-http-client/api/users_api.rb,
lib/clerk-http-client/configuration.rb,
lib/clerk-http-client/models/client.rb,
lib/clerk-http-client/models/domain.rb,
lib/clerk-http-client/models/ticket.rb,
lib/clerk-http-client/models/domains.rb,
lib/clerk-http-client/models/passkey.rb,
lib/clerk-http-client/models/session.rb,
lib/clerk-http-client/models/sign_up.rb,
lib/clerk-http-client/api/clients_api.rb,
lib/clerk-http-client/api/domains_api.rb,
lib/clerk-http-client/models/instance.rb,
lib/clerk-http-client/models/svix_url.rb,
lib/clerk-http-client/models/template.rb,
lib/clerk-http-client/api/sessions_api.rb,
lib/clerk-http-client/api/sign_ups_api.rb,
lib/clerk-http-client/api/webhooks_api.rb,
lib/clerk-http-client/models/from_oauth.rb,
lib/clerk-http-client/models/invitation.rb,
lib/clerk-http-client/models/actor_token.rb,
lib/clerk-http-client/models/clerk_error.rb,
lib/clerk-http-client/models/from_o_auth.rb,
lib/clerk-http-client/models/oauth_error.rb,
lib/clerk-http-client/models/proxy_check.rb,
lib/clerk-http-client/models/total_count.rb,
lib/clerk-http-client/models/web3_wallet.rb,
lib/clerk-http-client/api/invitations_api.rb,
lib/clerk-http-client/models/clerk_errors.rb,
lib/clerk-http-client/models/cname_target.rb,
lib/clerk-http-client/models/jwt_template.rb,
lib/clerk-http-client/models/organization.rb,
lib/clerk-http-client/models/phone_number.rb,
lib/clerk-http-client/models/redirect_url.rb,
lib/clerk-http-client/models/saml_account.rb,
lib/clerk-http-client/api/actor_tokens_api.rb,
lib/clerk-http-client/api/proxy_checks_api.rb,
lib/clerk-http-client/models/email_address.rb,
lib/clerk-http-client/models/organizations.rb,
lib/clerk-http-client/models/sign_in_token.rb,
lib/clerk-http-client/models/testing_token.rb,
lib/clerk-http-client/api/beta_features_api.rb,
lib/clerk-http-client/api/jwt_templates_api.rb,
lib/clerk-http-client/api/miscellaneous_api.rb,
lib/clerk-http-client/api/organizations_api.rb,
lib/clerk-http-client/api/phone_numbers_api.rb,
lib/clerk-http-client/api/redirect_urls_api.rb,
lib/clerk-http-client/models/deleted_object.rb,
lib/clerk-http-client/models/waitlist_entry.rb,
lib/clerk-http-client/models/web3_signature.rb,
lib/clerk-http-client/api/sign_in_tokens_api.rb,
lib/clerk-http-client/api/testing_tokens_api.rb,
lib/clerk-http-client/models/jwks_keys_inner.rb,
lib/clerk-http-client/models/saml_connection.rb,
lib/clerk-http-client/models/schemas_passkey.rb,
lib/clerk-http-client/models/well_known_jwks.rb,
lib/clerk-http-client/api/email_addresses_api.rb,
lib/clerk-http-client/models/from_oauth_error.rb,
lib/clerk-http-client/models/saml_connections.rb,
lib/clerk-http-client/api/saml_connections_api.rb,
lib/clerk-http-client/api/waitlist_entries_api.rb,
lib/clerk-http-client/models/from_o_auth_error.rb,
lib/clerk-http-client/models/oauth_application.rb,
lib/clerk-http-client/api/instance_settings_api.rb,
lib/clerk-http-client/models/add_domain_request.rb,
lib/clerk-http-client/models/o_auth_application.rb,
lib/clerk-http-client/models/oauth_applications.rb,
lib/clerk-http-client/api/oauth_applications_api.rb,
lib/clerk-http-client/models/create_user_request.rb,
lib/clerk-http-client/models/identification_link.rb,
lib/clerk-http-client/models/o_auth_applications.rb,
lib/clerk-http-client/models/organization_domain.rb,
lib/clerk-http-client/models/update_user_request.rb,
lib/clerk-http-client/models/verify_totp_request.rb,
lib/clerk-http-client/api/email_sms_templates_api.rb,
lib/clerk-http-client/api/organization_domain_api.rb,
lib/clerk-http-client/models/allowlist_identifier.rb,
lib/clerk-http-client/models/blocklist_identifier.rb,
lib/clerk-http-client/models/organization_domains.rb,
lib/clerk-http-client/api/organization_domains_api.rb,
lib/clerk-http-client/models/blocklist_identifiers.rb,
lib/clerk-http-client/models/instance_restrictions.rb,
lib/clerk-http-client/models/organization_settings.rb,
lib/clerk-http-client/models/update_domain_request.rb,
lib/clerk-http-client/models/verify_client_request.rb,
lib/clerk-http-client/api/allow_list_block_list_api.rb,
lib/clerk-http-client/models/create_session_request.rb,
lib/clerk-http-client/models/organization_with_logo.rb,
lib/clerk-http-client/models/update_sign_up_request.rb,
lib/clerk-http-client/models/verify_session_request.rb,
lib/clerk-http-client/models/disable_mfa200_response.rb,
lib/clerk-http-client/models/organization_invitation.rb,
lib/clerk-http-client/models/organization_membership.rb,
lib/clerk-http-client/models/schemas_saml_connection.rb,
lib/clerk-http-client/models/session_latest_activity.rb,
lib/clerk-http-client/models/update_instance_request.rb,
lib/clerk-http-client/models/upsert_template_request.rb,
lib/clerk-http-client/models/verify_password_request.rb,
lib/clerk-http-client/models/verify_totp200_response.rb,
lib/clerk-http-client/models/organization_invitations.rb,
lib/clerk-http-client/models/organization_memberships.rb,
lib/clerk-http-client/models/preview_template_request.rb,
lib/clerk-http-client/models/web3_wallet_verification.rb,
lib/clerk-http-client/api/organization_invitations_api.rb,
lib/clerk-http-client/api/organization_memberships_api.rb,
lib/clerk-http-client/models/create_invitation_request.rb,
lib/clerk-http-client/models/phone_number_verification.rb,
lib/clerk-http-client/models/saml_account_verification.rb,
lib/clerk-http-client/models/waitlist_entry_invitation.rb,
lib/clerk-http-client/models/create_actor_token_request.rb,
lib/clerk-http-client/models/email_address_verification.rb,
lib/clerk-http-client/models/well_known_jwks_keys_inner.rb,
lib/clerk-http-client/models/create_jwt_template_request.rb,
lib/clerk-http-client/models/create_organization_request.rb,
lib/clerk-http-client/models/create_phone_number_request.rb,
lib/clerk-http-client/models/create_redirect_url_request.rb,
lib/clerk-http-client/models/update_organization_request.rb,
lib/clerk-http-client/models/update_phone_number_request.rb,
lib/clerk-http-client/models/verify_domain_proxy_request.rb,
lib/clerk-http-client/models/verify_password200_response.rb,
lib/clerk-http-client/models/create_email_address_request.rb,
lib/clerk-http-client/models/create_session_token_request.rb,
lib/clerk-http-client/models/create_sign_in_token_request.rb,
lib/clerk-http-client/models/saml_account_saml_connection.rb,
lib/clerk-http-client/models/schemas_passkey_verification.rb,
lib/clerk-http-client/models/update_email_address_request.rb,
lib/clerk-http-client/models/update_user_metadata_request.rb,
lib/clerk-http-client/models/create_waitlist_entry_request.rb,
lib/clerk-http-client/models/oauth_application_with_secret.rb,
lib/clerk-http-client/models/revoke_invitation200_response.rb,
lib/clerk-http-client/models/create_saml_connection_request.rb,
lib/clerk-http-client/models/o_auth_application_with_secret.rb,
lib/clerk-http-client/models/update_saml_connection_request.rb,
lib/clerk-http-client/models/create_oauth_application_request.rb,
lib/clerk-http-client/models/create_session_token200_response.rb,
lib/clerk-http-client/models/organization_domain_verification.rb,
lib/clerk-http-client/models/toggle_template_delivery_request.rb,
lib/clerk-http-client/models/update_oauth_application_request.rb,
lib/clerk-http-client/models/list_waitlist_entries200_response.rb,
lib/clerk-http-client/models/create_organization_domain_request.rb,
lib/clerk-http-client/models/update_organization_domain_request.rb,
lib/clerk-http-client/models/create_allowlist_identifier_request.rb,
lib/clerk-http-client/models/create_blocklist_identifier_request.rb,
lib/clerk-http-client/models/merge_organization_metadata_request.rb,
lib/clerk-http-client/models/update_instance_auth_config_request.rb,
lib/clerk-http-client/models/update_instance_restrictions_request.rb,
lib/clerk-http-client/models/create_bulk_invitations_request_inner.rb,
lib/clerk-http-client/models/create_organization_invitation_request.rb,
lib/clerk-http-client/models/create_organization_membership_request.rb,
lib/clerk-http-client/models/revoke_organization_invitation_request.rb,
lib/clerk-http-client/models/update_organization_membership_request.rb,
lib/clerk-http-client/models/update_instance_auth_config200_response.rb,
lib/clerk-http-client/models/get_oauth_access_token200_response_inner.rb,
lib/clerk-http-client/models/organization_membership_public_user_data.rb,
lib/clerk-http-client/models/change_production_instance_domain_request.rb,
lib/clerk-http-client/models/schemas_saml_connection_attribute_mapping.rb,
lib/clerk-http-client/models/update_production_instance_domain_request.rb,
lib/clerk-http-client/models/create_session_token_from_template_request.rb,
lib/clerk-http-client/models/update_instance_organization_settings_request.rb,
lib/clerk-http-client/models/create_session_token_from_template200_response.rb,
lib/clerk-http-client/models/update_organization_membership_metadata_request.rb,
lib/clerk-http-client/models/create_saml_connection_request_attribute_mapping.rb,
lib/clerk-http-client/models/update_saml_connection_request_attribute_mapping.rb,
lib/clerk-http-client/models/create_organization_invitation_bulk_request_inner.rb,
lib/clerk-http-client/models/organization_invitation_with_public_organization_data.rb,
lib/clerk-http-client/models/organization_invitations_with_public_organization_data.rb,
lib/clerk-http-client/models/organization_invitation_with_public_organization_data_public_organization_data.rb

Overview

#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](clerk.com/docs/backend-requests/versioning/overview). Please see clerk.com/docs for more information.

The version of the OpenAPI document: v1 Contact: [email protected] Generated by: openapi-generator.tech Generator version: unset

Defined Under Namespace

Modules: EmailAddressVerification, FromOAuthError, OauthError, PhoneNumberVerification, SAMLAccountSamlConnection, SAMLAccountVerification, SchemasPasskeyVerification, Web3WalletVerification Classes: ActorToken, ActorTokensApi, AddDomainRequest, Admin, AllowListBlockListApi, AllowlistIdentifier, ApiClient, ApiError, BetaFeaturesApi, BlocklistIdentifier, BlocklistIdentifiers, CNameTarget, ChangeProductionInstanceDomainRequest, ClerkError, ClerkErrors, Client, ClientsApi, Configuration, CreateActorTokenRequest, CreateAllowlistIdentifierRequest, CreateBlocklistIdentifierRequest, CreateBulkInvitationsRequestInner, CreateEmailAddressRequest, CreateInvitationRequest, CreateJWTTemplateRequest, CreateOAuthApplicationRequest, CreateOrganizationDomainRequest, CreateOrganizationInvitationBulkRequestInner, CreateOrganizationInvitationRequest, CreateOrganizationMembershipRequest, CreateOrganizationRequest, CreatePhoneNumberRequest, CreateRedirectURLRequest, CreateSAMLConnectionRequest, CreateSAMLConnectionRequestAttributeMapping, CreateSessionRequest, CreateSessionToken200Response, CreateSessionTokenFromTemplate200Response, CreateSessionTokenFromTemplateRequest, CreateSessionTokenRequest, CreateSignInTokenRequest, CreateUserRequest, CreateWaitlistEntryRequest, DeletedObject, DisableMFA200Response, Domain, Domains, DomainsApi, EmailAddress, EmailAddressesApi, EmailSMSTemplatesApi, FromOAuth, GetOAuthAccessToken200ResponseInner, IdentificationLink, Instance, InstanceRestrictions, InstanceSettingsApi, Invitation, InvitationsApi, JWKS, JWKSApi, JWKSKeysInner, JWTTemplate, JWTTemplatesApi, ListWaitlistEntries200Response, MergeOrganizationMetadataRequest, MiscellaneousApi, OAuthApplication, OAuthApplicationWithSecret, OAuthApplications, OAuthApplicationsApi, OTP, Oauth, Organization, OrganizationDomain, OrganizationDomainApi, OrganizationDomainVerification, OrganizationDomains, OrganizationDomainsApi, OrganizationInvitation, OrganizationInvitationWithPublicOrganizationData, OrganizationInvitationWithPublicOrganizationDataPublicOrganizationData, OrganizationInvitations, OrganizationInvitationsApi, OrganizationInvitationsWithPublicOrganizationData, OrganizationMembership, OrganizationMembershipPublicUserData, OrganizationMemberships, OrganizationMembershipsApi, OrganizationSettings, OrganizationWithLogo, Organizations, OrganizationsApi, Passkey, PhoneNumber, PhoneNumbersApi, PreviewTemplateRequest, ProxyCheck, ProxyChecksApi, RedirectURL, RedirectURLsApi, RevokeInvitation200Response, RevokeOrganizationInvitationRequest, SAML, SAMLAccount, SAMLConnection, SAMLConnections, SAMLConnectionsApi, SDK, SchemasPasskey, SchemasSAMLConnection, SchemasSAMLConnectionAttributeMapping, Session, SessionLatestActivity, SessionsApi, SignInToken, SignInTokensApi, SignUp, SignUpsApi, SvixURL, TOTP, Template, TestingToken, TestingTokensApi, Ticket, ToggleTemplateDeliveryRequest, TotalCount, UpdateDomainRequest, UpdateEmailAddressRequest, UpdateInstanceAuthConfig200Response, UpdateInstanceAuthConfigRequest, UpdateInstanceOrganizationSettingsRequest, UpdateInstanceRequest, UpdateInstanceRestrictionsRequest, UpdateOAuthApplicationRequest, UpdateOrganizationDomainRequest, UpdateOrganizationMembershipMetadataRequest, UpdateOrganizationMembershipRequest, UpdateOrganizationRequest, UpdatePhoneNumberRequest, UpdateProductionInstanceDomainRequest, UpdateSAMLConnectionRequest, UpdateSAMLConnectionRequestAttributeMapping, UpdateSignUpRequest, UpdateUserMetadataRequest, UpdateUserRequest, UpsertTemplateRequest, User, UsersApi, VerifyClientRequest, VerifyDomainProxyRequest, VerifyPassword200Response, VerifyPasswordRequest, VerifySessionRequest, VerifyTOTP200Response, VerifyTOTPRequest, WaitlistEntriesApi, WaitlistEntry, WaitlistEntryInvitation, Web3Signature, Web3Wallet, WebhooksApi, WellKnownJWKS, WellKnownJWKSKeysInner

Constant Summary collapse

VERSION = 
'2.0.0'

Class Method Summary collapse

Class Method Details

.configure ⇒ Object

If no block given, return the default Configuration object.



187
188
189
190
191
192
193
 
# File 'lib/clerk-http-client.rb', line 187

def configure
  if block_given?
    yield(Configuration.default)
  else
    Configuration.default
  end
end