Skip to content

clerk/clerk-sdk-ruby-backend

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

17 Commits
.github/workflows
.github/workflows
 
 
.openapi-generator
.openapi-generator
 
 
.vscode
.vscode
 
 
bin
bin
 
 
docs
docs
 
 
lib
lib
 
 
resources
resources
 
 
spec
spec
 
 
.gitignore
.gitignore
 
 
.gitlab-ci.yml
.gitlab-ci.yml
 
 
.openapi-generator-ignore
.openapi-generator-ignore
 
 
.rspec
.rspec
 
 
.rubocop.yml
.rubocop.yml
 
 
.ruby-version
.ruby-version
 
 
.standard.yml
.standard.yml
 
 
.travis.yml
.travis.yml
 
 
Gemfile
Gemfile
 
 
Gemfile.lock
Gemfile.lock
 
 
README.md
README.md
 
 
Rakefile
Rakefile
 
 
clerk-sdk-ruby-backend.gemspec
clerk-sdk-ruby-backend.gemspec
 
 
git_push.sh
git_push.sh
 
 
openapitools.json
openapitools.json
 
 
sdk-generator-config.json
sdk-generator-config.json
 
 

Repository files navigation

clerk-sdk-ruby-backend

ClerkBackend - 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:

  • API version: v1
  • Package version: 1.0.0
  • Generator version: 7.11.0-SNAPSHOT
  • Build package: org.openapitools.codegen.languages.RubyClientCodegen For more information, please visit https://clerk.com/support

Installation

Build a gem

To build the Ruby code into a gem:

gem build clerk-sdk-ruby-backend.gemspec

Then either install the gem locally:

gem install ./clerk-sdk-ruby-backend-1.0.0.gem

(for development, run gem install --dev ./clerk-sdk-ruby-backend-1.0.0.gem to install the development dependencies)

or publish the gem to a gem hosting service, e.g. RubyGems.

Finally add this to the Gemfile:

gem 'clerk-sdk-ruby-backend', '~> 1.0.0'

Install from Git

If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:

gem 'clerk-sdk-ruby-backend', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'

Include the Ruby code directly

Include the Ruby code directly using -I as follows:

ruby -Ilib script.rb

Getting Started

Please follow the installation procedure and then run the following code:

# Load the gem
require 'clerk-sdk-ruby-backend'

# Setup authorization
ClerkBackend.configure do |config|
  # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
  # Configure a proc to get access tokens in lieu of the static access_token configuration
  config.access_token_getter = -> { 'YOUR TOKEN GETTER PROC' } 
  # Configure faraday connection
  config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
end

api_instance = ClerkBackend::ActorTokensApi.new
opts = {
  create_actor_token_request: ClerkBackend::CreateActorTokenRequest.new({user_id: 'user_id_example', actor: {"sub":"user_2OEpKhcCN1Lat9NQ0G6puh7q5Rb"}}) # CreateActorTokenRequest | 
}

begin
  #Create actor token
  result = api_instance.create_actor_token(opts)
  p result
rescue ClerkBackend::ApiError => e
  puts "Exception when calling ActorTokensApi->create_actor_token: #{e}"
end

Documentation for API Endpoints

All URIs are relative to https://api.clerk.com/v1

Class Method HTTP request Description
ClerkBackend::ActorTokensApi create_actor_token POST /actor_tokens Create actor token
ClerkBackend::ActorTokensApi revoke_actor_token POST /actor_tokens/{actor_token_id}/revoke Revoke actor token
ClerkBackend::AllowListBlockListApi create_allowlist_identifier POST /allowlist_identifiers Add identifier to the allow-list
ClerkBackend::AllowListBlockListApi create_blocklist_identifier POST /blocklist_identifiers Add identifier to the block-list
ClerkBackend::AllowListBlockListApi delete_allowlist_identifier DELETE /allowlist_identifiers/{identifier_id} Delete identifier from allow-list
ClerkBackend::AllowListBlockListApi delete_blocklist_identifier DELETE /blocklist_identifiers/{identifier_id} Delete identifier from block-list
ClerkBackend::AllowListBlockListApi list_allowlist_identifiers GET /allowlist_identifiers List all identifiers on the allow-list
ClerkBackend::AllowListBlockListApi list_blocklist_identifiers GET /blocklist_identifiers List all identifiers on the block-list
ClerkBackend::BetaFeaturesApi change_production_instance_domain POST /instance/change_domain Update production instance domain
ClerkBackend::BetaFeaturesApi update_instance_auth_config PATCH /beta_features/instance_settings Update instance settings
ClerkBackend::BetaFeaturesApi update_production_instance_domain PUT /beta_features/domain Update production instance domain
ClerkBackend::ClientsApi get_client GET /clients/{client_id} Get a client
ClerkBackend::ClientsApi get_client_list GET /clients List all clients
ClerkBackend::ClientsApi verify_client POST /clients/verify Verify a client
ClerkBackend::DomainsApi add_domain POST /domains Add a domain
ClerkBackend::DomainsApi delete_domain DELETE /domains/{domain_id} Delete a satellite domain
ClerkBackend::DomainsApi list_domains GET /domains List all instance domains
ClerkBackend::DomainsApi update_domain PATCH /domains/{domain_id} Update a domain
ClerkBackend::EmailAddressesApi create_email_address POST /email_addresses Create an email address
ClerkBackend::EmailAddressesApi delete_email_address DELETE /email_addresses/{email_address_id} Delete an email address
ClerkBackend::EmailAddressesApi get_email_address GET /email_addresses/{email_address_id} Retrieve an email address
ClerkBackend::EmailAddressesApi update_email_address PATCH /email_addresses/{email_address_id} Update an email address
ClerkBackend::EmailSMSTemplatesApi get_template GET /templates/{template_type}/{slug} Retrieve a template
ClerkBackend::EmailSMSTemplatesApi get_template_list GET /templates/{template_type} List all templates
ClerkBackend::EmailSMSTemplatesApi preview_template POST /templates/{template_type}/{slug}/preview Preview changes to a template
ClerkBackend::EmailSMSTemplatesApi revert_template POST /templates/{template_type}/{slug}/revert Revert a template
ClerkBackend::EmailSMSTemplatesApi toggle_template_delivery POST /templates/{template_type}/{slug}/toggle_delivery Toggle the delivery by Clerk for a template of a given type and slug
ClerkBackend::EmailSMSTemplatesApi upsert_template PUT /templates/{template_type}/{slug} Update a template for a given type and slug
ClerkBackend::InstanceSettingsApi update_instance PATCH /instance Update instance settings
ClerkBackend::InstanceSettingsApi update_instance_organization_settings PATCH /instance/organization_settings Update instance organization settings
ClerkBackend::InstanceSettingsApi update_instance_restrictions PATCH /instance/restrictions Update instance restrictions
ClerkBackend::InvitationsApi create_invitation POST /invitations Create an invitation
ClerkBackend::InvitationsApi list_invitations GET /invitations List all invitations
ClerkBackend::InvitationsApi revoke_invitation POST /invitations/{invitation_id}/revoke Revokes an invitation
ClerkBackend::JWKSApi get_jwks GET /jwks Retrieve the JSON Web Key Set of the instance
ClerkBackend::JWTTemplatesApi create_jwt_template POST /jwt_templates Create a JWT template
ClerkBackend::JWTTemplatesApi delete_jwt_template DELETE /jwt_templates/{template_id} Delete a Template
ClerkBackend::JWTTemplatesApi get_jwt_template GET /jwt_templates/{template_id} Retrieve a template
ClerkBackend::JWTTemplatesApi list_jwt_templates GET /jwt_templates List all templates
ClerkBackend::JWTTemplatesApi update_jwt_template PATCH /jwt_templates/{template_id} Update a JWT template
ClerkBackend::MiscellaneousApi get_public_interstitial GET /public/interstitial Returns the markup for the interstitial page
ClerkBackend::OAuthApplicationsApi create_o_auth_application POST /oauth_applications Create an OAuth application
ClerkBackend::OAuthApplicationsApi delete_o_auth_application DELETE /oauth_applications/{oauth_application_id} Delete an OAuth application
ClerkBackend::OAuthApplicationsApi get_o_auth_application GET /oauth_applications/{oauth_application_id} Retrieve an OAuth application by ID
ClerkBackend::OAuthApplicationsApi list_o_auth_applications GET /oauth_applications Get a list of OAuth applications for an instance
ClerkBackend::OAuthApplicationsApi rotate_o_auth_application_secret POST /oauth_applications/{oauth_application_id}/rotate_secret Rotate the client secret of the given OAuth application
ClerkBackend::OAuthApplicationsApi update_o_auth_application PATCH /oauth_applications/{oauth_application_id} Update an OAuth application
ClerkBackend::OrganizationDomainApi update_organization_domain PATCH /organizations/{organization_id}/domains/{domain_id} Update an organization domain.
ClerkBackend::OrganizationDomainsApi create_organization_domain POST /organizations/{organization_id}/domains Create a new organization domain.
ClerkBackend::OrganizationDomainsApi delete_organization_domain DELETE /organizations/{organization_id}/domains/{domain_id} Remove a domain from an organization.
ClerkBackend::OrganizationDomainsApi list_organization_domains GET /organizations/{organization_id}/domains Get a list of all domains of an organization.
ClerkBackend::OrganizationInvitationsApi create_organization_invitation POST /organizations/{organization_id}/invitations Create and send an organization invitation
ClerkBackend::OrganizationInvitationsApi create_organization_invitation_bulk POST /organizations/{organization_id}/invitations/bulk Bulk create and send organization invitations
ClerkBackend::OrganizationInvitationsApi get_organization_invitation GET /organizations/{organization_id}/invitations/{invitation_id} Retrieve an organization invitation by ID
ClerkBackend::OrganizationInvitationsApi list_organization_invitations GET /organizations/{organization_id}/invitations Get a list of organization invitations
ClerkBackend::OrganizationInvitationsApi list_pending_organization_invitations GET /organizations/{organization_id}/invitations/pending Get a list of pending organization invitations
ClerkBackend::OrganizationInvitationsApi revoke_organization_invitation POST /organizations/{organization_id}/invitations/{invitation_id}/revoke Revoke a pending organization invitation
ClerkBackend::OrganizationMembershipsApi create_organization_membership POST /organizations/{organization_id}/memberships Create a new organization membership
ClerkBackend::OrganizationMembershipsApi delete_organization_membership DELETE /organizations/{organization_id}/memberships/{user_id} Remove a member from an organization
ClerkBackend::OrganizationMembershipsApi instance_get_organization_memberships GET /organization_memberships Get a list of all organization memberships within an instance.
ClerkBackend::OrganizationMembershipsApi list_organization_memberships GET /organizations/{organization_id}/memberships Get a list of all members of an organization
ClerkBackend::OrganizationMembershipsApi update_organization_membership PATCH /organizations/{organization_id}/memberships/{user_id} Update an organization membership
ClerkBackend::OrganizationMembershipsApi update_organization_membership_metadata PATCH /organizations/{organization_id}/memberships/{user_id}/metadata Merge and update organization membership metadata
ClerkBackend::OrganizationsApi create_organization POST /organizations Create an organization
ClerkBackend::OrganizationsApi delete_organization DELETE /organizations/{organization_id} Delete an organization
ClerkBackend::OrganizationsApi delete_organization_logo DELETE /organizations/{organization_id}/logo
ClerkBackend::OrganizationsApi get_organization GET /organizations/{organization_id} Retrieve an organization by ID or slug
ClerkBackend::OrganizationsApi list_organizations GET /organizations Get a list of organizations for an instance
ClerkBackend::OrganizationsApi merge_organization_metadata PATCH /organizations/{organization_id}/metadata Merge and update metadata for an organization
ClerkBackend::OrganizationsApi update_organization PATCH /organizations/{organization_id} Update an organization
ClerkBackend::OrganizationsApi upload_organization_logo PUT /organizations/{organization_id}/logo Upload a logo for the organization
ClerkBackend::PhoneNumbersApi create_phone_number POST /phone_numbers Create a phone number
ClerkBackend::PhoneNumbersApi delete_phone_number DELETE /phone_numbers/{phone_number_id} Delete a phone number
ClerkBackend::PhoneNumbersApi get_phone_number GET /phone_numbers/{phone_number_id} Retrieve a phone number
ClerkBackend::PhoneNumbersApi update_phone_number PATCH /phone_numbers/{phone_number_id} Update a phone number
ClerkBackend::ProxyChecksApi verify_domain_proxy POST /proxy_checks Verify the proxy configuration for your domain
ClerkBackend::RedirectURLsApi create_redirect_url POST /redirect_urls Create a redirect URL
ClerkBackend::RedirectURLsApi delete_redirect_url DELETE /redirect_urls/{id} Delete a redirect URL
ClerkBackend::RedirectURLsApi get_redirect_url GET /redirect_urls/{id} Retrieve a redirect URL
ClerkBackend::RedirectURLsApi list_redirect_urls GET /redirect_urls List all redirect URLs
ClerkBackend::SAMLConnectionsApi create_saml_connection POST /saml_connections Create a SAML Connection
ClerkBackend::SAMLConnectionsApi delete_saml_connection DELETE /saml_connections/{saml_connection_id} Delete a SAML Connection
ClerkBackend::SAMLConnectionsApi get_saml_connection GET /saml_connections/{saml_connection_id} Retrieve a SAML Connection by ID
ClerkBackend::SAMLConnectionsApi list_saml_connections GET /saml_connections Get a list of SAML Connections for an instance
ClerkBackend::SAMLConnectionsApi update_saml_connection PATCH /saml_connections/{saml_connection_id} Update a SAML Connection
ClerkBackend::SessionsApi create_session_token_from_template POST /sessions/{session_id}/tokens/{template_name} Create a session token from a jwt template
ClerkBackend::SessionsApi get_session GET /sessions/{session_id} Retrieve a session
ClerkBackend::SessionsApi get_session_list GET /sessions List all sessions
ClerkBackend::SessionsApi revoke_session POST /sessions/{session_id}/revoke Revoke a session
ClerkBackend::SessionsApi verify_session POST /sessions/{session_id}/verify Verify a session
ClerkBackend::SignInTokensApi create_sign_in_token POST /sign_in_tokens Create sign-in token
ClerkBackend::SignInTokensApi revoke_sign_in_token POST /sign_in_tokens/{sign_in_token_id}/revoke Revoke the given sign-in token
ClerkBackend::SignUpsApi update_sign_up PATCH /sign_ups/{id} Update a sign-up
ClerkBackend::TestingTokensApi create_testing_token POST /testing_tokens Retrieve a new testing token
ClerkBackend::UsersApi ban_user POST /users/{user_id}/ban Ban a user
ClerkBackend::UsersApi create_user POST /users Create a new user
ClerkBackend::UsersApi create_user_totp POST /users/{user_id}/totp Create a TOTP for a user
ClerkBackend::UsersApi delete_backup_code DELETE /users/{user_id}/backup_code Disable all user's Backup codes
ClerkBackend::UsersApi delete_totp DELETE /users/{user_id}/totp Delete all the user's TOTPs
ClerkBackend::UsersApi delete_user DELETE /users/{user_id} Delete a user
ClerkBackend::UsersApi delete_user_profile_image DELETE /users/{user_id}/profile_image Delete user profile image
ClerkBackend::UsersApi disable_mfa DELETE /users/{user_id}/mfa Disable a user's MFA methods
ClerkBackend::UsersApi get_o_auth_access_token GET /users/{user_id}/oauth_access_tokens/{provider} Retrieve the OAuth access token of a user
ClerkBackend::UsersApi get_user GET /users/{user_id} Retrieve a user
ClerkBackend::UsersApi get_user_list GET /users List all users
ClerkBackend::UsersApi get_users_count GET /users/count Count users
ClerkBackend::UsersApi lock_user POST /users/{user_id}/lock Lock a user
ClerkBackend::UsersApi set_user_profile_image POST /users/{user_id}/profile_image Set user profile image
ClerkBackend::UsersApi unban_user POST /users/{user_id}/unban Unban a user
ClerkBackend::UsersApi unlock_user POST /users/{user_id}/unlock Unlock a user
ClerkBackend::UsersApi update_user PATCH /users/{user_id} Update a user
ClerkBackend::UsersApi update_user_metadata PATCH /users/{user_id}/metadata Merge and update a user's metadata
ClerkBackend::UsersApi user_passkey_delete DELETE /users/{user_id}/passkeys/{passkey_identification_id} Delete a user passkey
ClerkBackend::UsersApi user_web3_wallet_delete DELETE /users/{user_id}/web3_wallets/{web3_wallet_identification_id} Delete a user web3 wallet
ClerkBackend::UsersApi users_get_organization_memberships GET /users/{user_id}/organization_memberships Retrieve all memberships for a user
ClerkBackend::UsersApi verify_password POST /users/{user_id}/verify_password Verify the password of a user
ClerkBackend::UsersApi verify_totp POST /users/{user_id}/verify_totp Verify a TOTP or backup code for a user
ClerkBackend::WebhooksApi create_svix_app POST /webhooks/svix Create a Svix app
ClerkBackend::WebhooksApi delete_svix_app DELETE /webhooks/svix Delete a Svix app
ClerkBackend::WebhooksApi generate_svix_auth_url POST /webhooks/svix_url Create a Svix Dashboard URL

Documentation for Models

Documentation for Authorization

Authentication schemes defined for the API:

bearerAuth

  • Type: Bearer authentication (sk__)

About

No description, website, or topics provided.

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

2 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •  

Languages