Skip to content

Latest commit

 

History

History
221 lines (155 loc) · 7.28 KB

BetaFeaturesApi.md

File metadata and controls

221 lines (155 loc) · 7.28 KB
Raw

ClerkBackend::BetaFeaturesApi

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

Method HTTP request Description
change_production_instance_domain POST /instance/change_domain Update production instance domain
update_instance_auth_config PATCH /beta_features/instance_settings Update instance settings
update_production_instance_domain PUT /beta_features/domain Update production instance domain

change_production_instance_domain

change_production_instance_domain(opts)

Update production instance domain

Change the domain of a production instance. Changing the domain requires updating the DNS records accordingly, deploying new SSL certificates, updating your Social Connection's redirect URLs and setting the new keys in your code. WARNING: Changing your domain will invalidate all current user sessions (i.e. users will be logged out). Also, while your application is being deployed, a small downtime is expected to occur.

Examples

require 'time'
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'
end

api_instance = ClerkBackend::BetaFeaturesApi.new
opts = {
  change_production_instance_domain_request: ClerkBackend::ChangeProductionInstanceDomainRequest.new # ChangeProductionInstanceDomainRequest | 
}

begin
  # Update production instance domain
  api_instance.change_production_instance_domain(opts)
rescue ClerkBackend::ApiError => e
  puts "Error when calling BetaFeaturesApi->change_production_instance_domain: #{e}"
end

Using the change_production_instance_domain_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> change_production_instance_domain_with_http_info(opts)

begin
  # Update production instance domain
  data, status_code, headers = api_instance.change_production_instance_domain_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue ClerkBackend::ApiError => e
  puts "Error when calling BetaFeaturesApi->change_production_instance_domain_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
change_production_instance_domain_request ChangeProductionInstanceDomainRequest [optional]

Return type

nil (empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

update_instance_auth_config

update_instance_auth_config(opts)

Update instance settings

Updates the settings of an instance

Examples

require 'time'
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'
end

api_instance = ClerkBackend::BetaFeaturesApi.new
opts = {
  update_instance_auth_config_request: ClerkBackend::UpdateInstanceAuthConfigRequest.new # UpdateInstanceAuthConfigRequest | 
}

begin
  # Update instance settings
  result = api_instance.update_instance_auth_config(opts)
  p result
rescue ClerkBackend::ApiError => e
  puts "Error when calling BetaFeaturesApi->update_instance_auth_config: #{e}"
end

Using the update_instance_auth_config_with_http_info variant

This returns an Array which contains the response data, status code and headers.

<Array(, Integer, Hash)> update_instance_auth_config_with_http_info(opts)

begin
  # Update instance settings
  data, status_code, headers = api_instance.update_instance_auth_config_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <UpdateInstanceAuthConfig200Response>
rescue ClerkBackend::ApiError => e
  puts "Error when calling BetaFeaturesApi->update_instance_auth_config_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
update_instance_auth_config_request UpdateInstanceAuthConfigRequest [optional]

Return type

UpdateInstanceAuthConfig200Response

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

update_production_instance_domain

update_production_instance_domain(opts)

Update production instance domain

Change the domain of a production instance. Changing the domain requires updating the DNS records accordingly, deploying new SSL certificates, updating your Social Connection's redirect URLs and setting the new keys in your code. WARNING: Changing your domain will invalidate all current user sessions (i.e. users will be logged out). Also, while your application is being deployed, a small downtime is expected to occur.

Examples

require 'time'
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'
end

api_instance = ClerkBackend::BetaFeaturesApi.new
opts = {
  update_production_instance_domain_request: ClerkBackend::UpdateProductionInstanceDomainRequest.new # UpdateProductionInstanceDomainRequest | 
}

begin
  # Update production instance domain
  api_instance.update_production_instance_domain(opts)
rescue ClerkBackend::ApiError => e
  puts "Error when calling BetaFeaturesApi->update_production_instance_domain: #{e}"
end

Using the update_production_instance_domain_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.

<Array(nil, Integer, Hash)> update_production_instance_domain_with_http_info(opts)

begin
  # Update production instance domain
  data, status_code, headers = api_instance.update_production_instance_domain_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue ClerkBackend::ApiError => e
  puts "Error when calling BetaFeaturesApi->update_production_instance_domain_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
update_production_instance_domain_request UpdateProductionInstanceDomainRequest [optional]

Return type

nil (empty response body)

Authorization

bearerAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json