clerk-http-client 0.0.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/Gemfile.lock +87 -0
- data/README.md +360 -0
- data/Rakefile +10 -0
- data/bin/fmt +5 -0
- data/bin/generate +8 -0
- data/bin/setup +7 -0
- data/clerk-http-client.gemspec +41 -0
- data/docs/ActorToken.md +34 -0
- data/docs/ActorTokensApi.md +147 -0
- data/docs/AddDomainRequest.md +22 -0
- data/docs/Admin.md +24 -0
- data/docs/AllowListBlockListApi.md +421 -0
- data/docs/AllowlistIdentifier.md +32 -0
- data/docs/BetaFeaturesApi.md +217 -0
- data/docs/BlocklistIdentifier.md +30 -0
- data/docs/BlocklistIdentifiers.md +20 -0
- data/docs/CNameTarget.md +22 -0
- data/docs/ChangeProductionInstanceDomainRequest.md +20 -0
- data/docs/ClerkError.md +26 -0
- data/docs/ClerkErrors.md +20 -0
- data/docs/Client.md +34 -0
- data/docs/ClientsApi.md +221 -0
- data/docs/CreateActorTokenRequest.md +24 -0
- data/docs/CreateAllowlistIdentifierRequest.md +20 -0
- data/docs/CreateBlocklistIdentifierRequest.md +18 -0
- data/docs/CreateEmailAddressRequest.md +24 -0
- data/docs/CreateInvitationRequest.md +28 -0
- data/docs/CreateJWTTemplateRequest.md +30 -0
- data/docs/CreateOAuthApplicationRequest.md +24 -0
- data/docs/CreateOrganizationDomainRequest.md +22 -0
- data/docs/CreateOrganizationInvitationBulkRequestInner.md +28 -0
- data/docs/CreateOrganizationInvitationRequest.md +28 -0
- data/docs/CreateOrganizationMembershipRequest.md +20 -0
- data/docs/CreateOrganizationRequest.md +30 -0
- data/docs/CreatePhoneNumberRequest.md +26 -0
- data/docs/CreateRedirectURLRequest.md +18 -0
- data/docs/CreateSAMLConnectionRequest.md +34 -0
- data/docs/CreateSAMLConnectionRequestAttributeMapping.md +24 -0
- data/docs/CreateSessionTokenFromTemplate200Response.md +20 -0
- data/docs/CreateSignInTokenRequest.md +20 -0
- data/docs/CreateUserRequest.md +62 -0
- data/docs/DeletedObject.md +24 -0
- data/docs/DisableMFA200Response.md +18 -0
- data/docs/Domain.md +34 -0
- data/docs/Domains.md +20 -0
- data/docs/DomainsApi.md +286 -0
- data/docs/EmailAddress.md +32 -0
- data/docs/EmailAddressVerification.md +51 -0
- data/docs/EmailAddressesApi.md +289 -0
- data/docs/EmailSMSTemplatesApi.md +449 -0
- data/docs/GetOAuthAccessToken200ResponseInner.md +34 -0
- data/docs/IdentificationLink.md +20 -0
- data/docs/InstanceRestrictions.md +26 -0
- data/docs/InstanceSettingsApi.md +216 -0
- data/docs/Invitation.md +36 -0
- data/docs/InvitationsApi.md +223 -0
- data/docs/JWKSApi.md +74 -0
- data/docs/JWTTemplate.md +36 -0
- data/docs/JWTTemplatesApi.md +354 -0
- data/docs/MergeOrganizationMetadataRequest.md +20 -0
- data/docs/MiscellaneousApi.md +75 -0
- data/docs/OAuthApplication.md +42 -0
- data/docs/OAuthApplicationWithSecret.md +44 -0
- data/docs/OAuthApplications.md +20 -0
- data/docs/OAuthApplicationsApi.md +433 -0
- data/docs/OTP.md +24 -0
- data/docs/Oauth.md +28 -0
- data/docs/OauthError.md +47 -0
- data/docs/Organization.md +40 -0
- data/docs/OrganizationDomain.md +38 -0
- data/docs/OrganizationDomainApi.md +81 -0
- data/docs/OrganizationDomainVerification.md +24 -0
- data/docs/OrganizationDomains.md +20 -0
- data/docs/OrganizationDomainsApi.md +231 -0
- data/docs/OrganizationInvitation.md +38 -0
- data/docs/OrganizationInvitationWithPublicOrganizationData.md +40 -0
- data/docs/OrganizationInvitationWithPublicOrganizationDataPublicOrganizationData.md +26 -0
- data/docs/OrganizationInvitations.md +20 -0
- data/docs/OrganizationInvitationsApi.md +533 -0
- data/docs/OrganizationInvitationsWithPublicOrganizationData.md +20 -0
- data/docs/OrganizationMembership.md +38 -0
- data/docs/OrganizationMembershipPublicUserData.md +30 -0
- data/docs/OrganizationMemberships.md +20 -0
- data/docs/OrganizationMembershipsApi.md +453 -0
- data/docs/OrganizationSettings.md +36 -0
- data/docs/OrganizationWithLogo.md +46 -0
- data/docs/Organizations.md +20 -0
- data/docs/OrganizationsApi.md +591 -0
- data/docs/Passkey.md +26 -0
- data/docs/PhoneNumber.md +38 -0
- data/docs/PhoneNumberVerification.md +49 -0
- data/docs/PhoneNumbersApi.md +289 -0
- data/docs/PreviewTemplateRequest.md +24 -0
- data/docs/ProxyCheck.md +32 -0
- data/docs/ProxyChecksApi.md +77 -0
- data/docs/RedirectURL.md +26 -0
- data/docs/RedirectURLsApi.md +284 -0
- data/docs/RevokeInvitation200Response.md +36 -0
- data/docs/RevokeOrganizationInvitationRequest.md +18 -0
- data/docs/SAML.md +28 -0
- data/docs/SAMLAccount.md +38 -0
- data/docs/SAMLAccountSamlConnection.md +47 -0
- data/docs/SAMLAccountVerification.md +49 -0
- data/docs/SAMLConnection.md +38 -0
- data/docs/SAMLConnections.md +20 -0
- data/docs/SAMLConnectionsApi.md +363 -0
- data/docs/SchemasPasskey.md +26 -0
- data/docs/SchemasPasskeyVerification.md +47 -0
- data/docs/SchemasSAMLConnection.md +60 -0
- data/docs/SchemasSAMLConnectionAttributeMapping.md +24 -0
- data/docs/Session.md +42 -0
- data/docs/SessionLatestActivity.md +34 -0
- data/docs/SessionsApi.md +373 -0
- data/docs/SignInToken.md +32 -0
- data/docs/SignInTokensApi.md +147 -0
- data/docs/SignUp.md +62 -0
- data/docs/SignUpsApi.md +79 -0
- data/docs/SvixURL.md +18 -0
- data/docs/TOTP.md +28 -0
- data/docs/Template.md +60 -0
- data/docs/TestingToken.md +22 -0
- data/docs/TestingTokensApi.md +74 -0
- data/docs/Ticket.md +24 -0
- data/docs/ToggleTemplateDeliveryRequest.md +18 -0
- data/docs/TotalCount.md +20 -0
- data/docs/UpdateDomainRequest.md +22 -0
- data/docs/UpdateEmailAddressRequest.md +20 -0
- data/docs/UpdateInstanceAuthConfig200Response.md +28 -0
- data/docs/UpdateInstanceAuthConfigRequest.md +28 -0
- data/docs/UpdateInstanceOrganizationSettingsRequest.md +30 -0
- data/docs/UpdateInstanceRequest.md +34 -0
- data/docs/UpdateInstanceRestrictionsRequest.md +26 -0
- data/docs/UpdateOAuthApplicationRequest.md +22 -0
- data/docs/UpdateOrganizationDomainRequest.md +20 -0
- data/docs/UpdateOrganizationMembershipMetadataRequest.md +20 -0
- data/docs/UpdateOrganizationMembershipRequest.md +18 -0
- data/docs/UpdateOrganizationRequest.md +30 -0
- data/docs/UpdatePhoneNumberRequest.md +22 -0
- data/docs/UpdateProductionInstanceDomainRequest.md +18 -0
- data/docs/UpdateSAMLConnectionRequest.md +42 -0
- data/docs/UpdateSAMLConnectionRequestAttributeMapping.md +24 -0
- data/docs/UpdateSignUpRequest.md +18 -0
- data/docs/UpdateUserMetadataRequest.md +22 -0
- data/docs/UpdateUserRequest.md +66 -0
- data/docs/UpsertTemplateRequest.md +30 -0
- data/docs/User.md +94 -0
- data/docs/UsersApi.md +1829 -0
- data/docs/VerifyClientRequest.md +18 -0
- data/docs/VerifyDomainProxyRequest.md +20 -0
- data/docs/VerifyPassword200Response.md +18 -0
- data/docs/VerifyPasswordRequest.md +18 -0
- data/docs/VerifySessionRequest.md +18 -0
- data/docs/VerifyTOTP200Response.md +20 -0
- data/docs/VerifyTOTPRequest.md +18 -0
- data/docs/Web3Signature.md +28 -0
- data/docs/Web3Wallet.md +28 -0
- data/docs/Web3WalletVerification.md +49 -0
- data/docs/WebhooksApi.md +207 -0
- data/docs/WellKnownJWKS.md +18 -0
- data/docs/WellKnownJWKSKeysInner.md +28 -0
- data/git_push.sh +57 -0
- data/lib/clerk-http-client/api/actor_tokens_api.rb +157 -0
- data/lib/clerk-http-client/api/allow_list_block_list_api.rb +410 -0
- data/lib/clerk-http-client/api/beta_features_api.rb +228 -0
- data/lib/clerk-http-client/api/clients_api.rb +234 -0
- data/lib/clerk-http-client/api/domains_api.rb +292 -0
- data/lib/clerk-http-client/api/email_addresses_api.rb +298 -0
- data/lib/clerk-http-client/api/email_sms_templates_api.rb +488 -0
- data/lib/clerk-http-client/api/instance_settings_api.rb +232 -0
- data/lib/clerk-http-client/api/invitations_api.rb +241 -0
- data/lib/clerk-http-client/api/jwks_api.rb +81 -0
- data/lib/clerk-http-client/api/jwt_templates_api.rb +355 -0
- data/lib/clerk-http-client/api/miscellaneous_api.rb +85 -0
- data/lib/clerk-http-client/api/o_auth_applications_api.rb +440 -0
- data/lib/clerk-http-client/api/organization_domain_api.rb +104 -0
- data/lib/clerk-http-client/api/organization_domains_api.rb +258 -0
- data/lib/clerk-http-client/api/organization_invitations_api.rb +586 -0
- data/lib/clerk-http-client/api/organization_memberships_api.rb +499 -0
- data/lib/clerk-http-client/api/organizations_api.rb +606 -0
- data/lib/clerk-http-client/api/phone_numbers_api.rb +298 -0
- data/lib/clerk-http-client/api/proxy_checks_api.rb +92 -0
- data/lib/clerk-http-client/api/redirect_urls_api.rb +281 -0
- data/lib/clerk-http-client/api/saml_connections_api.rb +375 -0
- data/lib/clerk-http-client/api/sessions_api.rb +385 -0
- data/lib/clerk-http-client/api/sign_in_tokens_api.rb +157 -0
- data/lib/clerk-http-client/api/sign_ups_api.rb +98 -0
- data/lib/clerk-http-client/api/testing_tokens_api.rb +81 -0
- data/lib/clerk-http-client/api/users_api.rb +1828 -0
- data/lib/clerk-http-client/api/webhooks_api.rb +199 -0
- data/lib/clerk-http-client/api_client.rb +437 -0
- data/lib/clerk-http-client/api_error.rb +58 -0
- data/lib/clerk-http-client/configuration.rb +393 -0
- data/lib/clerk-http-client/models/actor_token.rb +385 -0
- data/lib/clerk-http-client/models/add_domain_request.rb +249 -0
- data/lib/clerk-http-client/models/admin.rb +303 -0
- data/lib/clerk-http-client/models/allowlist_identifier.rb +327 -0
- data/lib/clerk-http-client/models/blocklist_identifier.rb +318 -0
- data/lib/clerk-http-client/models/blocklist_identifiers.rb +240 -0
- data/lib/clerk-http-client/models/c_name_target.rb +254 -0
- data/lib/clerk-http-client/models/change_production_instance_domain_request.rb +225 -0
- data/lib/clerk-http-client/models/clerk_error.rb +271 -0
- data/lib/clerk-http-client/models/clerk_errors.rb +232 -0
- data/lib/clerk-http-client/models/client.rb +380 -0
- data/lib/clerk-http-client/models/create_actor_token_request.rb +263 -0
- data/lib/clerk-http-client/models/create_allowlist_identifier_request.rb +234 -0
- data/lib/clerk-http-client/models/create_blocklist_identifier_request.rb +222 -0
- data/lib/clerk-http-client/models/create_email_address_request.rb +247 -0
- data/lib/clerk-http-client/models/create_invitation_request.rb +303 -0
- data/lib/clerk-http-client/models/create_jwt_template_request.rb +327 -0
- data/lib/clerk-http-client/models/create_o_auth_application_request.rb +261 -0
- data/lib/clerk-http-client/models/create_organization_domain_request.rb +236 -0
- data/lib/clerk-http-client/models/create_organization_invitation_bulk_request_inner.rb +280 -0
- data/lib/clerk-http-client/models/create_organization_invitation_request.rb +280 -0
- data/lib/clerk-http-client/models/create_organization_membership_request.rb +239 -0
- data/lib/clerk-http-client/models/create_organization_request.rb +289 -0
- data/lib/clerk-http-client/models/create_phone_number_request.rb +258 -0
- data/lib/clerk-http-client/models/create_redirect_url_request.rb +215 -0
- data/lib/clerk-http-client/models/create_saml_connection_request.rb +355 -0
- data/lib/clerk-http-client/models/create_saml_connection_request_attribute_mapping.rb +242 -0
- data/lib/clerk-http-client/models/create_session_token_from_template200_response.rb +257 -0
- data/lib/clerk-http-client/models/create_sign_in_token_request.rb +227 -0
- data/lib/clerk-http-client/models/create_user_request.rb +453 -0
- data/lib/clerk-http-client/models/deleted_object.rb +255 -0
- data/lib/clerk-http-client/models/disable_mfa200_response.rb +214 -0
- data/lib/clerk-http-client/models/domain.rb +368 -0
- data/lib/clerk-http-client/models/domains.rb +240 -0
- data/lib/clerk-http-client/models/email_address.rb +361 -0
- data/lib/clerk-http-client/models/email_address_verification.rb +106 -0
- data/lib/clerk-http-client/models/get_o_auth_access_token200_response_inner.rb +295 -0
- data/lib/clerk-http-client/models/identification_link.rb +271 -0
- data/lib/clerk-http-client/models/instance_restrictions.rb +285 -0
- data/lib/clerk-http-client/models/invitation.rb +388 -0
- data/lib/clerk-http-client/models/jwt_template.rb +387 -0
- data/lib/clerk-http-client/models/merge_organization_metadata_request.rb +225 -0
- data/lib/clerk-http-client/models/o_auth_application.rb +449 -0
- data/lib/clerk-http-client/models/o_auth_application_with_secret.rb +466 -0
- data/lib/clerk-http-client/models/o_auth_applications.rb +240 -0
- data/lib/clerk-http-client/models/oauth.rb +328 -0
- data/lib/clerk-http-client/models/oauth_error.rb +104 -0
- data/lib/clerk-http-client/models/organization.rb +413 -0
- data/lib/clerk-http-client/models/organization_domain.rb +364 -0
- data/lib/clerk-http-client/models/organization_domain_verification.rb +281 -0
- data/lib/clerk-http-client/models/organization_domains.rb +240 -0
- data/lib/clerk-http-client/models/organization_invitation.rb +342 -0
- data/lib/clerk-http-client/models/organization_invitation_with_public_organization_data.rb +351 -0
- data/lib/clerk-http-client/models/organization_invitation_with_public_organization_data_public_organization_data.rb +250 -0
- data/lib/clerk-http-client/models/organization_invitations.rb +240 -0
- data/lib/clerk-http-client/models/organization_invitations_with_public_organization_data.rb +240 -0
- data/lib/clerk-http-client/models/organization_membership.rb +346 -0
- data/lib/clerk-http-client/models/organization_membership_public_user_data.rb +272 -0
- data/lib/clerk-http-client/models/organization_memberships.rb +240 -0
- data/lib/clerk-http-client/models/organization_settings.rb +391 -0
- data/lib/clerk-http-client/models/organization_with_logo.rb +454 -0
- data/lib/clerk-http-client/models/organizations.rb +240 -0
- data/lib/clerk-http-client/models/otp.rb +315 -0
- data/lib/clerk-http-client/models/passkey.rb +324 -0
- data/lib/clerk-http-client/models/phone_number.rb +391 -0
- data/lib/clerk-http-client/models/phone_number_verification.rb +105 -0
- data/lib/clerk-http-client/models/preview_template_request.rb +246 -0
- data/lib/clerk-http-client/models/proxy_check.rb +367 -0
- data/lib/clerk-http-client/models/redirect_url.rb +321 -0
- data/lib/clerk-http-client/models/revoke_invitation200_response.rb +395 -0
- data/lib/clerk-http-client/models/revoke_organization_invitation_request.rb +216 -0
- data/lib/clerk-http-client/models/saml.rb +331 -0
- data/lib/clerk-http-client/models/saml_account.rb +381 -0
- data/lib/clerk-http-client/models/saml_account_saml_connection.rb +104 -0
- data/lib/clerk-http-client/models/saml_account_verification.rb +105 -0
- data/lib/clerk-http-client/models/saml_connection.rb +362 -0
- data/lib/clerk-http-client/models/saml_connections.rb +240 -0
- data/lib/clerk-http-client/models/schemas_passkey.rb +310 -0
- data/lib/clerk-http-client/models/schemas_passkey_verification.rb +104 -0
- data/lib/clerk-http-client/models/schemas_saml_connection.rb +541 -0
- data/lib/clerk-http-client/models/schemas_saml_connection_attribute_mapping.rb +241 -0
- data/lib/clerk-http-client/models/session.rb +444 -0
- data/lib/clerk-http-client/models/session_latest_activity.rb +300 -0
- data/lib/clerk-http-client/models/sign_in_token.rb +368 -0
- data/lib/clerk-http-client/models/sign_up.rb +517 -0
- data/lib/clerk-http-client/models/svix_url.rb +221 -0
- data/lib/clerk-http-client/models/template.rb +460 -0
- data/lib/clerk-http-client/models/testing_token.rb +289 -0
- data/lib/clerk-http-client/models/ticket.rb +303 -0
- data/lib/clerk-http-client/models/toggle_template_delivery_request.rb +216 -0
- data/lib/clerk-http-client/models/total_count.rb +272 -0
- data/lib/clerk-http-client/models/totp.rb +289 -0
- data/lib/clerk-http-client/models/update_domain_request.rb +238 -0
- data/lib/clerk-http-client/models/update_email_address_request.rb +227 -0
- data/lib/clerk-http-client/models/update_instance_auth_config200_response.rb +294 -0
- data/lib/clerk-http-client/models/update_instance_auth_config_request.rb +273 -0
- data/lib/clerk-http-client/models/update_instance_organization_settings_request.rb +277 -0
- data/lib/clerk-http-client/models/update_instance_request.rb +300 -0
- data/lib/clerk-http-client/models/update_instance_restrictions_request.rb +255 -0
- data/lib/clerk-http-client/models/update_o_auth_application_request.rb +237 -0
- data/lib/clerk-http-client/models/update_organization_domain_request.rb +227 -0
- data/lib/clerk-http-client/models/update_organization_membership_metadata_request.rb +225 -0
- data/lib/clerk-http-client/models/update_organization_membership_request.rb +222 -0
- data/lib/clerk-http-client/models/update_organization_request.rb +279 -0
- data/lib/clerk-http-client/models/update_phone_number_request.rb +238 -0
- data/lib/clerk-http-client/models/update_production_instance_domain_request.rb +215 -0
- data/lib/clerk-http-client/models/update_saml_connection_request.rb +347 -0
- data/lib/clerk-http-client/models/update_saml_connection_request_attribute_mapping.rb +242 -0
- data/lib/clerk-http-client/models/update_sign_up_request.rb +216 -0
- data/lib/clerk-http-client/models/update_user_metadata_request.rb +241 -0
- data/lib/clerk-http-client/models/update_user_request.rb +472 -0
- data/lib/clerk-http-client/models/upsert_template_request.rb +278 -0
- data/lib/clerk-http-client/models/user.rb +633 -0
- data/lib/clerk-http-client/models/verify_client_request.rb +215 -0
- data/lib/clerk-http-client/models/verify_domain_proxy_request.rb +225 -0
- data/lib/clerk-http-client/models/verify_password200_response.rb +214 -0
- data/lib/clerk-http-client/models/verify_password_request.rb +222 -0
- data/lib/clerk-http-client/models/verify_session_request.rb +215 -0
- data/lib/clerk-http-client/models/verify_totp200_response.rb +257 -0
- data/lib/clerk-http-client/models/verify_totp_request.rb +222 -0
- data/lib/clerk-http-client/models/web3_signature.rb +323 -0
- data/lib/clerk-http-client/models/web3_wallet.rb +327 -0
- data/lib/clerk-http-client/models/web3_wallet_verification.rb +105 -0
- data/lib/clerk-http-client/models/well_known_jwks.rb +216 -0
- data/lib/clerk-http-client/models/well_known_jwks_keys_inner.rb +259 -0
- data/lib/clerk-http-client/version.rb +15 -0
- data/lib/clerk-http-client.rb +321 -0
- data/openapitools.json +7 -0
- data/pkg/clerk-http-client-1.0.0.gem +0 -0
- data/resources/.DS_Store +0 -0
- data/resources/oas/bapi-2024-10-01.yml +7238 -0
- data/resources/templates/Gemfile.mustache +9 -0
- data/resources/templates/README.mustache +163 -0
- data/resources/templates/Rakefile.mustache +10 -0
- data/resources/templates/api.mustache +257 -0
- data/resources/templates/api_client.mustache +246 -0
- data/resources/templates/api_client_faraday_partial.mustache +200 -0
- data/resources/templates/api_client_httpx_partial.mustache +134 -0
- data/resources/templates/api_client_typhoeus_partial.mustache +161 -0
- data/resources/templates/api_doc.mustache +132 -0
- data/resources/templates/api_error.mustache +50 -0
- data/resources/templates/api_info.mustache +12 -0
- data/resources/templates/api_test.mustache +47 -0
- data/resources/templates/base_object.mustache +114 -0
- data/resources/templates/configuration.mustache +491 -0
- data/resources/templates/configuration_faraday_partial.mustache +40 -0
- data/resources/templates/configuration_httpx_partial.mustache +11 -0
- data/resources/templates/configuration_typhoeus_partial.mustache +41 -0
- data/resources/templates/gem.mustache +89 -0
- data/resources/templates/gemspec.mustache +41 -0
- data/resources/templates/git_push.sh.mustache +57 -0
- data/resources/templates/gitignore.mustache +39 -0
- data/resources/templates/gitlab-ci.mustache +26 -0
- data/resources/templates/model.mustache +33 -0
- data/resources/templates/model_doc.mustache +12 -0
- data/resources/templates/model_test.mustache +82 -0
- data/resources/templates/partial_anyof_module.mustache +94 -0
- data/resources/templates/partial_model_enum_class.mustache +23 -0
- data/resources/templates/partial_model_generic.mustache +377 -0
- data/resources/templates/partial_model_generic_doc.mustache +28 -0
- data/resources/templates/partial_oneof_module.mustache +137 -0
- data/resources/templates/partial_oneof_module_doc.mustache +93 -0
- data/resources/templates/rspec.mustache +2 -0
- data/resources/templates/rubocop.mustache +148 -0
- data/resources/templates/spec_helper.mustache +103 -0
- data/resources/templates/travis.mustache +11 -0
- data/resources/templates/version.mustache +7 -0
- data/sdk-generator-config.json +20 -0
- data/spec/api/actor_tokens_api_spec.rb +59 -0
- data/spec/api/allow_list_block_list_api_spec.rb +105 -0
- data/spec/api/beta_features_api_spec.rb +71 -0
- data/spec/api/clients_api_spec.rb +72 -0
- data/spec/api/domains_api_spec.rb +83 -0
- data/spec/api/email_addresses_api_spec.rb +84 -0
- data/spec/api/email_sms_templates_api_spec.rb +115 -0
- data/spec/api/instance_settings_api_spec.rb +71 -0
- data/spec/api/invitations_api_spec.rb +73 -0
- data/spec/api/jwks_api_spec.rb +46 -0
- data/spec/api/jwt_templates_api_spec.rb +94 -0
- data/spec/api/miscellaneous_api_spec.rb +48 -0
- data/spec/api/o_auth_applications_api_spec.rb +109 -0
- data/spec/api/organization_domain_api_spec.rb +49 -0
- data/spec/api/organization_domains_api_spec.rb +77 -0
- data/spec/api/organization_invitations_api_spec.rb +133 -0
- data/spec/api/organization_memberships_api_spec.rb +118 -0
- data/spec/api/organizations_api_spec.rb +139 -0
- data/spec/api/phone_numbers_api_spec.rb +84 -0
- data/spec/api/proxy_checks_api_spec.rb +47 -0
- data/spec/api/redirect_urls_api_spec.rb +82 -0
- data/spec/api/saml_connections_api_spec.rb +97 -0
- data/spec/api/sessions_api_spec.rb +101 -0
- data/spec/api/sign_in_tokens_api_spec.rb +59 -0
- data/spec/api/sign_ups_api_spec.rb +48 -0
- data/spec/api/testing_tokens_api_spec.rb +46 -0
- data/spec/api/users_api_spec.rb +366 -0
- data/spec/api/webhooks_api_spec.rb +68 -0
- data/spec/models/actor_token_spec.rb +92 -0
- data/spec/models/add_domain_request_spec.rb +48 -0
- data/spec/models/admin_spec.rb +62 -0
- data/spec/models/allowlist_identifier_spec.rb +86 -0
- data/spec/models/blocklist_identifier_spec.rb +80 -0
- data/spec/models/blocklist_identifiers_spec.rb +42 -0
- data/spec/models/c_name_target_spec.rb +48 -0
- data/spec/models/change_production_instance_domain_request_spec.rb +42 -0
- data/spec/models/clerk_error_spec.rb +60 -0
- data/spec/models/clerk_errors_spec.rb +42 -0
- data/spec/models/client_spec.rb +88 -0
- data/spec/models/create_actor_token_request_spec.rb +54 -0
- data/spec/models/create_allowlist_identifier_request_spec.rb +42 -0
- data/spec/models/create_blocklist_identifier_request_spec.rb +36 -0
- data/spec/models/create_email_address_request_spec.rb +54 -0
- data/spec/models/create_invitation_request_spec.rb +66 -0
- data/spec/models/create_jwt_template_request_spec.rb +72 -0
- data/spec/models/create_o_auth_application_request_spec.rb +54 -0
- data/spec/models/create_organization_domain_request_spec.rb +48 -0
- data/spec/models/create_organization_invitation_bulk_request_inner_spec.rb +66 -0
- data/spec/models/create_organization_invitation_request_spec.rb +66 -0
- data/spec/models/create_organization_membership_request_spec.rb +42 -0
- data/spec/models/create_organization_request_spec.rb +72 -0
- data/spec/models/create_phone_number_request_spec.rb +60 -0
- data/spec/models/create_redirect_url_request_spec.rb +36 -0
- data/spec/models/create_saml_connection_request_attribute_mapping_spec.rb +54 -0
- data/spec/models/create_saml_connection_request_spec.rb +88 -0
- data/spec/models/create_session_token_from_template200_response_spec.rb +46 -0
- data/spec/models/create_sign_in_token_request_spec.rb +42 -0
- data/spec/models/create_user_request_spec.rb +168 -0
- data/spec/models/deleted_object_spec.rb +54 -0
- data/spec/models/disable_mfa200_response_spec.rb +36 -0
- data/spec/models/domain_spec.rb +88 -0
- data/spec/models/domains_spec.rb +42 -0
- data/spec/models/email_address_spec.rb +82 -0
- data/spec/models/email_address_verification_spec.rb +32 -0
- data/spec/models/get_o_auth_access_token200_response_inner_spec.rb +84 -0
- data/spec/models/identification_link_spec.rb +46 -0
- data/spec/models/instance_restrictions_spec.rb +64 -0
- data/spec/models/invitation_spec.rb +98 -0
- data/spec/models/jwt_template_spec.rb +94 -0
- data/spec/models/merge_organization_metadata_request_spec.rb +42 -0
- data/spec/models/o_auth_application_spec.rb +112 -0
- data/spec/models/o_auth_application_with_secret_spec.rb +118 -0
- data/spec/models/o_auth_applications_spec.rb +42 -0
- data/spec/models/oauth_error_spec.rb +32 -0
- data/spec/models/oauth_spec.rb +74 -0
- data/spec/models/organization_domain_spec.rb +104 -0
- data/spec/models/organization_domain_verification_spec.rb +58 -0
- data/spec/models/organization_domains_spec.rb +42 -0
- data/spec/models/organization_invitation_spec.rb +100 -0
- data/spec/models/organization_invitation_with_public_organization_data_public_organization_data_spec.rb +60 -0
- data/spec/models/organization_invitation_with_public_organization_data_spec.rb +106 -0
- data/spec/models/organization_invitations_spec.rb +42 -0
- data/spec/models/organization_invitations_with_public_organization_data_spec.rb +42 -0
- data/spec/models/organization_membership_public_user_data_spec.rb +72 -0
- data/spec/models/organization_membership_spec.rb +100 -0
- data/spec/models/organization_memberships_spec.rb +42 -0
- data/spec/models/organization_settings_spec.rb +98 -0
- data/spec/models/organization_spec.rb +106 -0
- data/spec/models/organization_with_logo_spec.rb +124 -0
- data/spec/models/organizations_spec.rb +42 -0
- data/spec/models/otp_spec.rb +62 -0
- data/spec/models/passkey_spec.rb +72 -0
- data/spec/models/phone_number_spec.rb +100 -0
- data/spec/models/phone_number_verification_spec.rb +32 -0
- data/spec/models/preview_template_request_spec.rb +54 -0
- data/spec/models/proxy_check_spec.rb +82 -0
- data/spec/models/redirect_url_spec.rb +64 -0
- data/spec/models/revoke_invitation200_response_spec.rb +98 -0
- data/spec/models/revoke_organization_invitation_request_spec.rb +36 -0
- data/spec/models/saml_account_saml_connection_spec.rb +32 -0
- data/spec/models/saml_account_spec.rb +100 -0
- data/spec/models/saml_account_verification_spec.rb +32 -0
- data/spec/models/saml_connection_spec.rb +96 -0
- data/spec/models/saml_connections_spec.rb +42 -0
- data/spec/models/saml_spec.rb +74 -0
- data/spec/models/schemas_passkey_spec.rb +64 -0
- data/spec/models/schemas_passkey_verification_spec.rb +32 -0
- data/spec/models/schemas_saml_connection_attribute_mapping_spec.rb +54 -0
- data/spec/models/schemas_saml_connection_spec.rb +166 -0
- data/spec/models/session_latest_activity_spec.rb +84 -0
- data/spec/models/session_spec.rb +116 -0
- data/spec/models/sign_in_token_spec.rb +86 -0
- data/spec/models/sign_up_spec.rb +176 -0
- data/spec/models/svix_url_spec.rb +36 -0
- data/spec/models/template_spec.rb +166 -0
- data/spec/models/testing_token_spec.rb +52 -0
- data/spec/models/ticket_spec.rb +62 -0
- data/spec/models/toggle_template_delivery_request_spec.rb +36 -0
- data/spec/models/total_count_spec.rb +46 -0
- data/spec/models/totp_spec.rb +66 -0
- data/spec/models/update_domain_request_spec.rb +48 -0
- data/spec/models/update_email_address_request_spec.rb +42 -0
- data/spec/models/update_instance_auth_config200_response_spec.rb +70 -0
- data/spec/models/update_instance_auth_config_request_spec.rb +66 -0
- data/spec/models/update_instance_organization_settings_request_spec.rb +72 -0
- data/spec/models/update_instance_request_spec.rb +84 -0
- data/spec/models/update_instance_restrictions_request_spec.rb +60 -0
- data/spec/models/update_o_auth_application_request_spec.rb +48 -0
- data/spec/models/update_organization_domain_request_spec.rb +42 -0
- data/spec/models/update_organization_membership_metadata_request_spec.rb +42 -0
- data/spec/models/update_organization_membership_request_spec.rb +36 -0
- data/spec/models/update_organization_request_spec.rb +72 -0
- data/spec/models/update_phone_number_request_spec.rb +48 -0
- data/spec/models/update_production_instance_domain_request_spec.rb +36 -0
- data/spec/models/update_saml_connection_request_attribute_mapping_spec.rb +54 -0
- data/spec/models/update_saml_connection_request_spec.rb +108 -0
- data/spec/models/update_sign_up_request_spec.rb +36 -0
- data/spec/models/update_user_metadata_request_spec.rb +48 -0
- data/spec/models/update_user_request_spec.rb +180 -0
- data/spec/models/upsert_template_request_spec.rb +72 -0
- data/spec/models/user_spec.rb +268 -0
- data/spec/models/verify_client_request_spec.rb +36 -0
- data/spec/models/verify_domain_proxy_request_spec.rb +42 -0
- data/spec/models/verify_password200_response_spec.rb +36 -0
- data/spec/models/verify_password_request_spec.rb +36 -0
- data/spec/models/verify_session_request_spec.rb +36 -0
- data/spec/models/verify_totp200_response_spec.rb +46 -0
- data/spec/models/verify_totp_request_spec.rb +36 -0
- data/spec/models/web3_signature_spec.rb +74 -0
- data/spec/models/web3_wallet_spec.rb +70 -0
- data/spec/models/web3_wallet_verification_spec.rb +32 -0
- data/spec/models/well_known_jwks_keys_inner_spec.rb +66 -0
- data/spec/models/well_known_jwks_spec.rb +36 -0
- data/spec/spec_helper.rb +111 -0
- data/test.rb +2 -0
- metadata +782 -0
data/docs/SessionsApi.md
ADDED
@@ -0,0 +1,373 @@
|
|
1
|
+
# ClerkHttpClient::SessionsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.clerk.com/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**create_session_token_from_template**](SessionsApi.md#create_session_token_from_template) | **POST** /sessions/{session_id}/tokens/{template_name} | Create a session token from a jwt template |
|
8
|
+
| [**get_session**](SessionsApi.md#get_session) | **GET** /sessions/{session_id} | Retrieve a session |
|
9
|
+
| [**get_session_list**](SessionsApi.md#get_session_list) | **GET** /sessions | List all sessions |
|
10
|
+
| [**revoke_session**](SessionsApi.md#revoke_session) | **POST** /sessions/{session_id}/revoke | Revoke a session |
|
11
|
+
| [**verify_session**](SessionsApi.md#verify_session) | **POST** /sessions/{session_id}/verify | Verify a session |
|
12
|
+
|
13
|
+
|
14
|
+
## create_session_token_from_template
|
15
|
+
|
16
|
+
> <CreateSessionTokenFromTemplate200Response> create_session_token_from_template(session_id, template_name)
|
17
|
+
|
18
|
+
Create a session token from a jwt template
|
19
|
+
|
20
|
+
Creates a JSON Web Token(JWT) based on a session and a JWT Template name defined for your instance
|
21
|
+
|
22
|
+
### Examples
|
23
|
+
|
24
|
+
```ruby
|
25
|
+
require 'time'
|
26
|
+
require 'clerk-http-client'
|
27
|
+
# setup authorization
|
28
|
+
ClerkHttpClient.configure do |config|
|
29
|
+
# Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
|
30
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
31
|
+
end
|
32
|
+
|
33
|
+
api_instance = ClerkHttpClient::SessionsApi.new
|
34
|
+
session_id = 'session_id_example' # String | The ID of the session
|
35
|
+
template_name = 'template_name_example' # String | The name of the JWT Template defined in your instance (e.g. `custom_hasura`).
|
36
|
+
|
37
|
+
begin
|
38
|
+
# Create a session token from a jwt template
|
39
|
+
result = api_instance.create_session_token_from_template(session_id, template_name)
|
40
|
+
p result
|
41
|
+
rescue ClerkHttpClient::ApiError => e
|
42
|
+
puts "Error when calling SessionsApi->create_session_token_from_template: #{e}"
|
43
|
+
end
|
44
|
+
```
|
45
|
+
|
46
|
+
#### Using the create_session_token_from_template_with_http_info variant
|
47
|
+
|
48
|
+
This returns an Array which contains the response data, status code and headers.
|
49
|
+
|
50
|
+
> <Array(<CreateSessionTokenFromTemplate200Response>, Integer, Hash)> create_session_token_from_template_with_http_info(session_id, template_name)
|
51
|
+
|
52
|
+
```ruby
|
53
|
+
begin
|
54
|
+
# Create a session token from a jwt template
|
55
|
+
data, status_code, headers = api_instance.create_session_token_from_template_with_http_info(session_id, template_name)
|
56
|
+
p status_code # => 2xx
|
57
|
+
p headers # => { ... }
|
58
|
+
p data # => <CreateSessionTokenFromTemplate200Response>
|
59
|
+
rescue ClerkHttpClient::ApiError => e
|
60
|
+
puts "Error when calling SessionsApi->create_session_token_from_template_with_http_info: #{e}"
|
61
|
+
end
|
62
|
+
```
|
63
|
+
|
64
|
+
### Parameters
|
65
|
+
|
66
|
+
| Name | Type | Description | Notes |
|
67
|
+
| ---- | ---- | ----------- | ----- |
|
68
|
+
| **session_id** | **String** | The ID of the session | |
|
69
|
+
| **template_name** | **String** | The name of the JWT Template defined in your instance (e.g. `custom_hasura`). | |
|
70
|
+
|
71
|
+
### Return type
|
72
|
+
|
73
|
+
[**CreateSessionTokenFromTemplate200Response**](CreateSessionTokenFromTemplate200Response.md)
|
74
|
+
|
75
|
+
### Authorization
|
76
|
+
|
77
|
+
[bearerAuth](../README.md#bearerAuth)
|
78
|
+
|
79
|
+
### HTTP request headers
|
80
|
+
|
81
|
+
- **Content-Type**: Not defined
|
82
|
+
- **Accept**: application/json
|
83
|
+
|
84
|
+
|
85
|
+
## get_session
|
86
|
+
|
87
|
+
> <Session> get_session(session_id)
|
88
|
+
|
89
|
+
Retrieve a session
|
90
|
+
|
91
|
+
Retrieve the details of a session
|
92
|
+
|
93
|
+
### Examples
|
94
|
+
|
95
|
+
```ruby
|
96
|
+
require 'time'
|
97
|
+
require 'clerk-http-client'
|
98
|
+
# setup authorization
|
99
|
+
ClerkHttpClient.configure do |config|
|
100
|
+
# Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
|
101
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
102
|
+
end
|
103
|
+
|
104
|
+
api_instance = ClerkHttpClient::SessionsApi.new
|
105
|
+
session_id = 'session_id_example' # String | The ID of the session
|
106
|
+
|
107
|
+
begin
|
108
|
+
# Retrieve a session
|
109
|
+
result = api_instance.get_session(session_id)
|
110
|
+
p result
|
111
|
+
rescue ClerkHttpClient::ApiError => e
|
112
|
+
puts "Error when calling SessionsApi->get_session: #{e}"
|
113
|
+
end
|
114
|
+
```
|
115
|
+
|
116
|
+
#### Using the get_session_with_http_info variant
|
117
|
+
|
118
|
+
This returns an Array which contains the response data, status code and headers.
|
119
|
+
|
120
|
+
> <Array(<Session>, Integer, Hash)> get_session_with_http_info(session_id)
|
121
|
+
|
122
|
+
```ruby
|
123
|
+
begin
|
124
|
+
# Retrieve a session
|
125
|
+
data, status_code, headers = api_instance.get_session_with_http_info(session_id)
|
126
|
+
p status_code # => 2xx
|
127
|
+
p headers # => { ... }
|
128
|
+
p data # => <Session>
|
129
|
+
rescue ClerkHttpClient::ApiError => e
|
130
|
+
puts "Error when calling SessionsApi->get_session_with_http_info: #{e}"
|
131
|
+
end
|
132
|
+
```
|
133
|
+
|
134
|
+
### Parameters
|
135
|
+
|
136
|
+
| Name | Type | Description | Notes |
|
137
|
+
| ---- | ---- | ----------- | ----- |
|
138
|
+
| **session_id** | **String** | The ID of the session | |
|
139
|
+
|
140
|
+
### Return type
|
141
|
+
|
142
|
+
[**Session**](Session.md)
|
143
|
+
|
144
|
+
### Authorization
|
145
|
+
|
146
|
+
[bearerAuth](../README.md#bearerAuth)
|
147
|
+
|
148
|
+
### HTTP request headers
|
149
|
+
|
150
|
+
- **Content-Type**: Not defined
|
151
|
+
- **Accept**: application/json
|
152
|
+
|
153
|
+
|
154
|
+
## get_session_list
|
155
|
+
|
156
|
+
> <Array<Session>> get_session_list(opts)
|
157
|
+
|
158
|
+
List all sessions
|
159
|
+
|
160
|
+
Returns a list of all sessions. The sessions are returned sorted by creation date, with the newest sessions appearing first. **Deprecation Notice (2024-01-01):** All parameters were initially considered optional, however moving forward at least one of `client_id` or `user_id` parameters should be provided.
|
161
|
+
|
162
|
+
### Examples
|
163
|
+
|
164
|
+
```ruby
|
165
|
+
require 'time'
|
166
|
+
require 'clerk-http-client'
|
167
|
+
# setup authorization
|
168
|
+
ClerkHttpClient.configure do |config|
|
169
|
+
# Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
|
170
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
171
|
+
end
|
172
|
+
|
173
|
+
api_instance = ClerkHttpClient::SessionsApi.new
|
174
|
+
opts = {
|
175
|
+
client_id: 'client_id_example', # String | List sessions for the given client
|
176
|
+
user_id: 'user_id_example', # String | List sessions for the given user
|
177
|
+
status: 'abandoned', # String | Filter sessions by the provided status
|
178
|
+
limit: 8.14, # Float | Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`.
|
179
|
+
offset: 8.14 # Float | Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`.
|
180
|
+
}
|
181
|
+
|
182
|
+
begin
|
183
|
+
# List all sessions
|
184
|
+
result = api_instance.get_session_list(opts)
|
185
|
+
p result
|
186
|
+
rescue ClerkHttpClient::ApiError => e
|
187
|
+
puts "Error when calling SessionsApi->get_session_list: #{e}"
|
188
|
+
end
|
189
|
+
```
|
190
|
+
|
191
|
+
#### Using the get_session_list_with_http_info variant
|
192
|
+
|
193
|
+
This returns an Array which contains the response data, status code and headers.
|
194
|
+
|
195
|
+
> <Array(<Array<Session>>, Integer, Hash)> get_session_list_with_http_info(opts)
|
196
|
+
|
197
|
+
```ruby
|
198
|
+
begin
|
199
|
+
# List all sessions
|
200
|
+
data, status_code, headers = api_instance.get_session_list_with_http_info(opts)
|
201
|
+
p status_code # => 2xx
|
202
|
+
p headers # => { ... }
|
203
|
+
p data # => <Array<Session>>
|
204
|
+
rescue ClerkHttpClient::ApiError => e
|
205
|
+
puts "Error when calling SessionsApi->get_session_list_with_http_info: #{e}"
|
206
|
+
end
|
207
|
+
```
|
208
|
+
|
209
|
+
### Parameters
|
210
|
+
|
211
|
+
| Name | Type | Description | Notes |
|
212
|
+
| ---- | ---- | ----------- | ----- |
|
213
|
+
| **client_id** | **String** | List sessions for the given client | [optional] |
|
214
|
+
| **user_id** | **String** | List sessions for the given user | [optional] |
|
215
|
+
| **status** | **String** | Filter sessions by the provided status | [optional] |
|
216
|
+
| **limit** | **Float** | Applies a limit to the number of results returned. Can be used for paginating the results together with `offset`. | [optional][default to 10] |
|
217
|
+
| **offset** | **Float** | Skip the first `offset` results when paginating. Needs to be an integer greater or equal to zero. To be used in conjunction with `limit`. | [optional][default to 0] |
|
218
|
+
|
219
|
+
### Return type
|
220
|
+
|
221
|
+
[**Array<Session>**](Session.md)
|
222
|
+
|
223
|
+
### Authorization
|
224
|
+
|
225
|
+
[bearerAuth](../README.md#bearerAuth)
|
226
|
+
|
227
|
+
### HTTP request headers
|
228
|
+
|
229
|
+
- **Content-Type**: Not defined
|
230
|
+
- **Accept**: application/json
|
231
|
+
|
232
|
+
|
233
|
+
## revoke_session
|
234
|
+
|
235
|
+
> <Session> revoke_session(session_id)
|
236
|
+
|
237
|
+
Revoke a session
|
238
|
+
|
239
|
+
Sets the status of a session as \"revoked\", which is an unauthenticated state. In multi-session mode, a revoked session will still be returned along with its client object, however the user will need to sign in again.
|
240
|
+
|
241
|
+
### Examples
|
242
|
+
|
243
|
+
```ruby
|
244
|
+
require 'time'
|
245
|
+
require 'clerk-http-client'
|
246
|
+
# setup authorization
|
247
|
+
ClerkHttpClient.configure do |config|
|
248
|
+
# Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
|
249
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
250
|
+
end
|
251
|
+
|
252
|
+
api_instance = ClerkHttpClient::SessionsApi.new
|
253
|
+
session_id = 'session_id_example' # String | The ID of the session
|
254
|
+
|
255
|
+
begin
|
256
|
+
# Revoke a session
|
257
|
+
result = api_instance.revoke_session(session_id)
|
258
|
+
p result
|
259
|
+
rescue ClerkHttpClient::ApiError => e
|
260
|
+
puts "Error when calling SessionsApi->revoke_session: #{e}"
|
261
|
+
end
|
262
|
+
```
|
263
|
+
|
264
|
+
#### Using the revoke_session_with_http_info variant
|
265
|
+
|
266
|
+
This returns an Array which contains the response data, status code and headers.
|
267
|
+
|
268
|
+
> <Array(<Session>, Integer, Hash)> revoke_session_with_http_info(session_id)
|
269
|
+
|
270
|
+
```ruby
|
271
|
+
begin
|
272
|
+
# Revoke a session
|
273
|
+
data, status_code, headers = api_instance.revoke_session_with_http_info(session_id)
|
274
|
+
p status_code # => 2xx
|
275
|
+
p headers # => { ... }
|
276
|
+
p data # => <Session>
|
277
|
+
rescue ClerkHttpClient::ApiError => e
|
278
|
+
puts "Error when calling SessionsApi->revoke_session_with_http_info: #{e}"
|
279
|
+
end
|
280
|
+
```
|
281
|
+
|
282
|
+
### Parameters
|
283
|
+
|
284
|
+
| Name | Type | Description | Notes |
|
285
|
+
| ---- | ---- | ----------- | ----- |
|
286
|
+
| **session_id** | **String** | The ID of the session | |
|
287
|
+
|
288
|
+
### Return type
|
289
|
+
|
290
|
+
[**Session**](Session.md)
|
291
|
+
|
292
|
+
### Authorization
|
293
|
+
|
294
|
+
[bearerAuth](../README.md#bearerAuth)
|
295
|
+
|
296
|
+
### HTTP request headers
|
297
|
+
|
298
|
+
- **Content-Type**: Not defined
|
299
|
+
- **Accept**: application/json
|
300
|
+
|
301
|
+
|
302
|
+
## verify_session
|
303
|
+
|
304
|
+
> <Session> verify_session(session_id, opts)
|
305
|
+
|
306
|
+
Verify a session
|
307
|
+
|
308
|
+
Returns the session if it is authenticated, otherwise returns an error. WARNING: This endpoint is deprecated and will be removed in future versions. We strongly recommend switching to networkless verification using short-lived session tokens, which is implemented transparently in all recent SDK versions (e.g. [NodeJS SDK](https://clerk.com/docs/backend-requests/handling/nodejs#clerk-express-require-auth)). For more details on how networkless verification works, refer to our [Session Tokens documentation](https://clerk.com/docs/backend-requests/resources/session-tokens).
|
309
|
+
|
310
|
+
### Examples
|
311
|
+
|
312
|
+
```ruby
|
313
|
+
require 'time'
|
314
|
+
require 'clerk-http-client'
|
315
|
+
# setup authorization
|
316
|
+
ClerkHttpClient.configure do |config|
|
317
|
+
# Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
|
318
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
319
|
+
end
|
320
|
+
|
321
|
+
api_instance = ClerkHttpClient::SessionsApi.new
|
322
|
+
session_id = 'session_id_example' # String | The ID of the session
|
323
|
+
opts = {
|
324
|
+
verify_session_request: ClerkHttpClient::VerifySessionRequest.new # VerifySessionRequest | Parameters.
|
325
|
+
}
|
326
|
+
|
327
|
+
begin
|
328
|
+
# Verify a session
|
329
|
+
result = api_instance.verify_session(session_id, opts)
|
330
|
+
p result
|
331
|
+
rescue ClerkHttpClient::ApiError => e
|
332
|
+
puts "Error when calling SessionsApi->verify_session: #{e}"
|
333
|
+
end
|
334
|
+
```
|
335
|
+
|
336
|
+
#### Using the verify_session_with_http_info variant
|
337
|
+
|
338
|
+
This returns an Array which contains the response data, status code and headers.
|
339
|
+
|
340
|
+
> <Array(<Session>, Integer, Hash)> verify_session_with_http_info(session_id, opts)
|
341
|
+
|
342
|
+
```ruby
|
343
|
+
begin
|
344
|
+
# Verify a session
|
345
|
+
data, status_code, headers = api_instance.verify_session_with_http_info(session_id, opts)
|
346
|
+
p status_code # => 2xx
|
347
|
+
p headers # => { ... }
|
348
|
+
p data # => <Session>
|
349
|
+
rescue ClerkHttpClient::ApiError => e
|
350
|
+
puts "Error when calling SessionsApi->verify_session_with_http_info: #{e}"
|
351
|
+
end
|
352
|
+
```
|
353
|
+
|
354
|
+
### Parameters
|
355
|
+
|
356
|
+
| Name | Type | Description | Notes |
|
357
|
+
| ---- | ---- | ----------- | ----- |
|
358
|
+
| **session_id** | **String** | The ID of the session | |
|
359
|
+
| **verify_session_request** | [**VerifySessionRequest**](VerifySessionRequest.md) | Parameters. | [optional] |
|
360
|
+
|
361
|
+
### Return type
|
362
|
+
|
363
|
+
[**Session**](Session.md)
|
364
|
+
|
365
|
+
### Authorization
|
366
|
+
|
367
|
+
[bearerAuth](../README.md#bearerAuth)
|
368
|
+
|
369
|
+
### HTTP request headers
|
370
|
+
|
371
|
+
- **Content-Type**: application/json
|
372
|
+
- **Accept**: application/json
|
373
|
+
|
data/docs/SignInToken.md
ADDED
@@ -0,0 +1,32 @@
|
|
1
|
+
# ClerkHttpClient::SignInToken
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **object** | **String** | | |
|
8
|
+
| **id** | **String** | | |
|
9
|
+
| **status** | **String** | | |
|
10
|
+
| **user_id** | **String** | | |
|
11
|
+
| **token** | **String** | | [optional] |
|
12
|
+
| **url** | **String** | | [optional] |
|
13
|
+
| **created_at** | **Integer** | Unix timestamp of creation. | |
|
14
|
+
| **updated_at** | **Integer** | Unix timestamp of last update. | |
|
15
|
+
|
16
|
+
## Example
|
17
|
+
|
18
|
+
```ruby
|
19
|
+
require 'clerk-http-client'
|
20
|
+
|
21
|
+
instance = ClerkHttpClient::SignInToken.new(
|
22
|
+
object: null,
|
23
|
+
id: null,
|
24
|
+
status: null,
|
25
|
+
user_id: null,
|
26
|
+
token: null,
|
27
|
+
url: null,
|
28
|
+
created_at: null,
|
29
|
+
updated_at: null
|
30
|
+
)
|
31
|
+
```
|
32
|
+
|
@@ -0,0 +1,147 @@
|
|
1
|
+
# ClerkHttpClient::SignInTokensApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.clerk.com/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**create_sign_in_token**](SignInTokensApi.md#create_sign_in_token) | **POST** /sign_in_tokens | Create sign-in token |
|
8
|
+
| [**revoke_sign_in_token**](SignInTokensApi.md#revoke_sign_in_token) | **POST** /sign_in_tokens/{sign_in_token_id}/revoke | Revoke the given sign-in token |
|
9
|
+
|
10
|
+
|
11
|
+
## create_sign_in_token
|
12
|
+
|
13
|
+
> <SignInToken> create_sign_in_token(create_sign_in_token_request)
|
14
|
+
|
15
|
+
Create sign-in token
|
16
|
+
|
17
|
+
Creates a new sign-in token and associates it with the given user. By default, sign-in tokens expire in 30 days. You can optionally supply a different duration in seconds using the `expires_in_seconds` property.
|
18
|
+
|
19
|
+
### Examples
|
20
|
+
|
21
|
+
```ruby
|
22
|
+
require 'time'
|
23
|
+
require 'clerk-http-client'
|
24
|
+
# setup authorization
|
25
|
+
ClerkHttpClient.configure do |config|
|
26
|
+
# Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
|
27
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
28
|
+
end
|
29
|
+
|
30
|
+
api_instance = ClerkHttpClient::SignInTokensApi.new
|
31
|
+
create_sign_in_token_request = ClerkHttpClient::CreateSignInTokenRequest.new # CreateSignInTokenRequest |
|
32
|
+
|
33
|
+
begin
|
34
|
+
# Create sign-in token
|
35
|
+
result = api_instance.create_sign_in_token(create_sign_in_token_request)
|
36
|
+
p result
|
37
|
+
rescue ClerkHttpClient::ApiError => e
|
38
|
+
puts "Error when calling SignInTokensApi->create_sign_in_token: #{e}"
|
39
|
+
end
|
40
|
+
```
|
41
|
+
|
42
|
+
#### Using the create_sign_in_token_with_http_info variant
|
43
|
+
|
44
|
+
This returns an Array which contains the response data, status code and headers.
|
45
|
+
|
46
|
+
> <Array(<SignInToken>, Integer, Hash)> create_sign_in_token_with_http_info(create_sign_in_token_request)
|
47
|
+
|
48
|
+
```ruby
|
49
|
+
begin
|
50
|
+
# Create sign-in token
|
51
|
+
data, status_code, headers = api_instance.create_sign_in_token_with_http_info(create_sign_in_token_request)
|
52
|
+
p status_code # => 2xx
|
53
|
+
p headers # => { ... }
|
54
|
+
p data # => <SignInToken>
|
55
|
+
rescue ClerkHttpClient::ApiError => e
|
56
|
+
puts "Error when calling SignInTokensApi->create_sign_in_token_with_http_info: #{e}"
|
57
|
+
end
|
58
|
+
```
|
59
|
+
|
60
|
+
### Parameters
|
61
|
+
|
62
|
+
| Name | Type | Description | Notes |
|
63
|
+
| ---- | ---- | ----------- | ----- |
|
64
|
+
| **create_sign_in_token_request** | [**CreateSignInTokenRequest**](CreateSignInTokenRequest.md) | | |
|
65
|
+
|
66
|
+
### Return type
|
67
|
+
|
68
|
+
[**SignInToken**](SignInToken.md)
|
69
|
+
|
70
|
+
### Authorization
|
71
|
+
|
72
|
+
[bearerAuth](../README.md#bearerAuth)
|
73
|
+
|
74
|
+
### HTTP request headers
|
75
|
+
|
76
|
+
- **Content-Type**: application/json
|
77
|
+
- **Accept**: application/json
|
78
|
+
|
79
|
+
|
80
|
+
## revoke_sign_in_token
|
81
|
+
|
82
|
+
> <SignInToken> revoke_sign_in_token(sign_in_token_id)
|
83
|
+
|
84
|
+
Revoke the given sign-in token
|
85
|
+
|
86
|
+
Revokes a pending sign-in token
|
87
|
+
|
88
|
+
### Examples
|
89
|
+
|
90
|
+
```ruby
|
91
|
+
require 'time'
|
92
|
+
require 'clerk-http-client'
|
93
|
+
# setup authorization
|
94
|
+
ClerkHttpClient.configure do |config|
|
95
|
+
# Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
|
96
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
97
|
+
end
|
98
|
+
|
99
|
+
api_instance = ClerkHttpClient::SignInTokensApi.new
|
100
|
+
sign_in_token_id = 'sign_in_token_id_example' # String | The ID of the sign-in token to be revoked
|
101
|
+
|
102
|
+
begin
|
103
|
+
# Revoke the given sign-in token
|
104
|
+
result = api_instance.revoke_sign_in_token(sign_in_token_id)
|
105
|
+
p result
|
106
|
+
rescue ClerkHttpClient::ApiError => e
|
107
|
+
puts "Error when calling SignInTokensApi->revoke_sign_in_token: #{e}"
|
108
|
+
end
|
109
|
+
```
|
110
|
+
|
111
|
+
#### Using the revoke_sign_in_token_with_http_info variant
|
112
|
+
|
113
|
+
This returns an Array which contains the response data, status code and headers.
|
114
|
+
|
115
|
+
> <Array(<SignInToken>, Integer, Hash)> revoke_sign_in_token_with_http_info(sign_in_token_id)
|
116
|
+
|
117
|
+
```ruby
|
118
|
+
begin
|
119
|
+
# Revoke the given sign-in token
|
120
|
+
data, status_code, headers = api_instance.revoke_sign_in_token_with_http_info(sign_in_token_id)
|
121
|
+
p status_code # => 2xx
|
122
|
+
p headers # => { ... }
|
123
|
+
p data # => <SignInToken>
|
124
|
+
rescue ClerkHttpClient::ApiError => e
|
125
|
+
puts "Error when calling SignInTokensApi->revoke_sign_in_token_with_http_info: #{e}"
|
126
|
+
end
|
127
|
+
```
|
128
|
+
|
129
|
+
### Parameters
|
130
|
+
|
131
|
+
| Name | Type | Description | Notes |
|
132
|
+
| ---- | ---- | ----------- | ----- |
|
133
|
+
| **sign_in_token_id** | **String** | The ID of the sign-in token to be revoked | |
|
134
|
+
|
135
|
+
### Return type
|
136
|
+
|
137
|
+
[**SignInToken**](SignInToken.md)
|
138
|
+
|
139
|
+
### Authorization
|
140
|
+
|
141
|
+
[bearerAuth](../README.md#bearerAuth)
|
142
|
+
|
143
|
+
### HTTP request headers
|
144
|
+
|
145
|
+
- **Content-Type**: Not defined
|
146
|
+
- **Accept**: application/json
|
147
|
+
|
data/docs/SignUp.md
ADDED
@@ -0,0 +1,62 @@
|
|
1
|
+
# ClerkHttpClient::SignUp
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **object** | **String** | | |
|
8
|
+
| **id** | **String** | | |
|
9
|
+
| **status** | **String** | | |
|
10
|
+
| **required_fields** | **Array<String>** | | [optional] |
|
11
|
+
| **optional_fields** | **Array<String>** | | [optional] |
|
12
|
+
| **missing_fields** | **Array<String>** | | [optional] |
|
13
|
+
| **unverified_fields** | **Array<String>** | | [optional] |
|
14
|
+
| **verifications** | **Object** | | [optional] |
|
15
|
+
| **username** | **String** | | [optional] |
|
16
|
+
| **email_address** | **String** | | [optional] |
|
17
|
+
| **phone_number** | **String** | | [optional] |
|
18
|
+
| **web3_wallet** | **String** | | [optional] |
|
19
|
+
| **password_enabled** | **Boolean** | | |
|
20
|
+
| **first_name** | **String** | | [optional] |
|
21
|
+
| **last_name** | **String** | | [optional] |
|
22
|
+
| **unsafe_metadata** | **Object** | | [optional] |
|
23
|
+
| **public_metadata** | **Object** | | [optional] |
|
24
|
+
| **custom_action** | **Boolean** | | |
|
25
|
+
| **external_id** | **String** | | [optional] |
|
26
|
+
| **created_session_id** | **String** | | [optional] |
|
27
|
+
| **created_user_id** | **String** | | [optional] |
|
28
|
+
| **abandon_at** | **Integer** | | |
|
29
|
+
| **external_account** | **Object** | | [optional] |
|
30
|
+
|
31
|
+
## Example
|
32
|
+
|
33
|
+
```ruby
|
34
|
+
require 'clerk-http-client'
|
35
|
+
|
36
|
+
instance = ClerkHttpClient::SignUp.new(
|
37
|
+
object: null,
|
38
|
+
id: null,
|
39
|
+
status: null,
|
40
|
+
required_fields: null,
|
41
|
+
optional_fields: null,
|
42
|
+
missing_fields: null,
|
43
|
+
unverified_fields: null,
|
44
|
+
verifications: null,
|
45
|
+
username: null,
|
46
|
+
email_address: null,
|
47
|
+
phone_number: null,
|
48
|
+
web3_wallet: null,
|
49
|
+
password_enabled: null,
|
50
|
+
first_name: null,
|
51
|
+
last_name: null,
|
52
|
+
unsafe_metadata: null,
|
53
|
+
public_metadata: null,
|
54
|
+
custom_action: null,
|
55
|
+
external_id: null,
|
56
|
+
created_session_id: null,
|
57
|
+
created_user_id: null,
|
58
|
+
abandon_at: null,
|
59
|
+
external_account: null
|
60
|
+
)
|
61
|
+
```
|
62
|
+
|
data/docs/SignUpsApi.md
ADDED
@@ -0,0 +1,79 @@
|
|
1
|
+
# ClerkHttpClient::SignUpsApi
|
2
|
+
|
3
|
+
All URIs are relative to *https://api.clerk.com/v1*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**update_sign_up**](SignUpsApi.md#update_sign_up) | **PATCH** /sign_ups/{id} | Update a sign-up |
|
8
|
+
|
9
|
+
|
10
|
+
## update_sign_up
|
11
|
+
|
12
|
+
> <SignUp> update_sign_up(id, update_sign_up_request)
|
13
|
+
|
14
|
+
Update a sign-up
|
15
|
+
|
16
|
+
Update the sign-up with the given ID
|
17
|
+
|
18
|
+
### Examples
|
19
|
+
|
20
|
+
```ruby
|
21
|
+
require 'time'
|
22
|
+
require 'clerk-http-client'
|
23
|
+
# setup authorization
|
24
|
+
ClerkHttpClient.configure do |config|
|
25
|
+
# Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
|
26
|
+
config.access_token = 'YOUR_BEARER_TOKEN'
|
27
|
+
end
|
28
|
+
|
29
|
+
api_instance = ClerkHttpClient::SignUpsApi.new
|
30
|
+
id = 'id_example' # String | The ID of the sign-up to update
|
31
|
+
update_sign_up_request = ClerkHttpClient::UpdateSignUpRequest.new # UpdateSignUpRequest |
|
32
|
+
|
33
|
+
begin
|
34
|
+
# Update a sign-up
|
35
|
+
result = api_instance.update_sign_up(id, update_sign_up_request)
|
36
|
+
p result
|
37
|
+
rescue ClerkHttpClient::ApiError => e
|
38
|
+
puts "Error when calling SignUpsApi->update_sign_up: #{e}"
|
39
|
+
end
|
40
|
+
```
|
41
|
+
|
42
|
+
#### Using the update_sign_up_with_http_info variant
|
43
|
+
|
44
|
+
This returns an Array which contains the response data, status code and headers.
|
45
|
+
|
46
|
+
> <Array(<SignUp>, Integer, Hash)> update_sign_up_with_http_info(id, update_sign_up_request)
|
47
|
+
|
48
|
+
```ruby
|
49
|
+
begin
|
50
|
+
# Update a sign-up
|
51
|
+
data, status_code, headers = api_instance.update_sign_up_with_http_info(id, update_sign_up_request)
|
52
|
+
p status_code # => 2xx
|
53
|
+
p headers # => { ... }
|
54
|
+
p data # => <SignUp>
|
55
|
+
rescue ClerkHttpClient::ApiError => e
|
56
|
+
puts "Error when calling SignUpsApi->update_sign_up_with_http_info: #{e}"
|
57
|
+
end
|
58
|
+
```
|
59
|
+
|
60
|
+
### Parameters
|
61
|
+
|
62
|
+
| Name | Type | Description | Notes |
|
63
|
+
| ---- | ---- | ----------- | ----- |
|
64
|
+
| **id** | **String** | The ID of the sign-up to update | |
|
65
|
+
| **update_sign_up_request** | [**UpdateSignUpRequest**](UpdateSignUpRequest.md) | | |
|
66
|
+
|
67
|
+
### Return type
|
68
|
+
|
69
|
+
[**SignUp**](SignUp.md)
|
70
|
+
|
71
|
+
### Authorization
|
72
|
+
|
73
|
+
[bearerAuth](../README.md#bearerAuth)
|
74
|
+
|
75
|
+
### HTTP request headers
|
76
|
+
|
77
|
+
- **Content-Type**: application/json
|
78
|
+
- **Accept**: application/json
|
79
|
+
|
data/docs/SvixURL.md
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
# ClerkHttpClient::SvixURL
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **svix_url** | **String** | | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'clerk-http-client'
|
13
|
+
|
14
|
+
instance = ClerkHttpClient::SvixURL.new(
|
15
|
+
svix_url: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|