Skip to content

README.md

Latest commit

 

History

History
393 lines (270 loc) · 19.4 KB

README.md

File metadata and controls

393 lines (270 loc) · 19.4 KB

InstanceSettings

Overview

Modify the settings of your instance.

Available Operations

get

Fetches the current instance

Example Usage

require 'clerk_sdk_ruby'

Models = ::Clerk::Models
s = ::Clerk::OpenAPIClient.new(
  bearer_auth: '<YOUR_BEARER_TOKEN_HERE>'
)
res = s.instance_settings.get

unless res.instance.nil?
  # handle response
end

Response

Crystalline::Nilable.new(Models::Operations::GetInstanceResponse)

Errors

Error Type Status Code Content Type
Errors::APIError 4XX, 5XX */*

update

Updates the settings of an instance

Example Usage

require 'clerk_sdk_ruby'

Models = ::Clerk::Models
s = ::Clerk::OpenAPIClient.new(
  bearer_auth: '<YOUR_BEARER_TOKEN_HERE>'
)

req = Models::Operations::UpdateInstanceRequest.new(
  test_mode: true,
  hibp: false,
  support_email: 'support@example.com',
  clerk_js_version: '2.3.1',
  development_origin: 'http://localhost:3000',
  allowed_origins: [
    'http://localhost:3000',
    'chrome-extension://extension_uiid',
    'capacitor://localhost',
  ],
  url_based_session_syncing: true
)
res = s.instance_settings.update(request: req)

if res.status_code == 200
  # handle response
end

Parameters

Parameter Type Required Description
request Models::Operations::UpdateInstanceRequest ✔️ The request object to use for the request.

Response

Crystalline::Nilable.new(Models::Operations::UpdateInstanceResponse)

Errors

Error Type Status Code Content Type
Models::Errors::ClerkErrors 422 application/json
Errors::APIError 4XX, 5XX */*

update_restrictions

Updates the restriction settings of an instance

Example Usage

require 'clerk_sdk_ruby'

Models = ::Clerk::Models
s = ::Clerk::OpenAPIClient.new(
  bearer_auth: '<YOUR_BEARER_TOKEN_HERE>'
)

req = Models::Operations::UpdateInstanceRestrictionsRequest.new(
  allowlist: false,
  blocklist: true,
  block_email_subaddresses: true,
  block_disposable_email_domains: true
)
res = s.instance_settings.update_restrictions(request: req)

unless res.instance_restrictions.nil?
  # handle response
end

Parameters

Parameter Type Required Description
request Models::Operations::UpdateInstanceRestrictionsRequest ✔️ The request object to use for the request.

Response

Crystalline::Nilable.new(Models::Operations::UpdateInstanceRestrictionsResponse)

Errors

Error Type Status Code Content Type
Models::Errors::ClerkErrors 402, 422 application/json
Errors::APIError 4XX, 5XX */*

get_o_auth_application_settings

Retrieves the settings for OAuth applications for the instance (dynamic client registration, JWT access tokens, etc.).

Example Usage

require 'clerk_sdk_ruby'

Models = ::Clerk::Models
s = ::Clerk::OpenAPIClient.new(
  bearer_auth: '<YOUR_BEARER_TOKEN_HERE>'
)
res = s.instance_settings.get_o_auth_application_settings

unless res.o_auth_application_settings.nil?
  # handle response
end

Response

Crystalline::Nilable.new(Models::Operations::GetInstanceOAuthApplicationSettingsResponse)

Errors

Error Type Status Code Content Type
Errors::APIError 4XX, 5XX */*

update_o_auth_application_settings

Updates the OAuth application settings for the instance.

Example Usage

require 'clerk_sdk_ruby'

Models = ::Clerk::Models
s = ::Clerk::OpenAPIClient.new(
  bearer_auth: '<YOUR_BEARER_TOKEN_HERE>'
)

req = nil
res = s.instance_settings.update_o_auth_application_settings(request: req)

unless res.o_auth_application_settings.nil?
  # handle response
end

Parameters

Parameter Type Required Description
request Models::Operations::UpdateInstanceOAuthApplicationSettingsRequest ✔️ The request object to use for the request.

Response

Crystalline::Nilable.new(Models::Operations::UpdateInstanceOAuthApplicationSettingsResponse)

Errors

Error Type Status Code Content Type
Models::Errors::ClerkErrors 422 application/json
Errors::APIError 4XX, 5XX */*

change_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.

Example Usage

require 'clerk_sdk_ruby'

Models = ::Clerk::Models
s = ::Clerk::OpenAPIClient.new(
  bearer_auth: '<YOUR_BEARER_TOKEN_HERE>'
)

req = Models::Operations::ChangeProductionInstanceDomainRequest.new(
  home_url: 'https://www.newdomain.com'
)
res = s.instance_settings.change_domain(request: req)

if res.status_code == 200
  # handle response
end

Parameters

Parameter Type Required Description
request Models::Operations::ChangeProductionInstanceDomainRequest ✔️ The request object to use for the request.

Response

Crystalline::Nilable.new(Models::Operations::ChangeProductionInstanceDomainResponse)

Errors

Error Type Status Code Content Type
Models::Errors::ClerkErrors 400, 422 application/json
Errors::APIError 4XX, 5XX */*

update_organization_settings

Updates the organization settings of the instance

Example Usage

require 'clerk_sdk_ruby'

Models = ::Clerk::Models
s = ::Clerk::OpenAPIClient.new(
  bearer_auth: '<YOUR_BEARER_TOKEN_HERE>'
)

req = Models::Operations::UpdateInstanceOrganizationSettingsRequest.new(
  enabled: true,
  max_allowed_memberships: 10,
  admin_delete_enabled: false,
  domains_enabled: true,
  domains_enrollment_modes: [
    'automatic_invitation',
    'automatic_suggestion',
  ],
  creator_role_id: 'creator_role',
  domains_default_role_id: 'member_role'
)
res = s.instance_settings.update_organization_settings(request: req)

unless res.organization_settings.nil?
  # handle response
end

Parameters

Parameter Type Required Description
request Models::Operations::UpdateInstanceOrganizationSettingsRequest ✔️ The request object to use for the request.

Response

Crystalline::Nilable.new(Models::Operations::UpdateInstanceOrganizationSettingsResponse)

Errors

Error Type Status Code Content Type
Models::Errors::ClerkErrors 400, 402, 404, 422 application/json
Errors::APIError 4XX, 5XX */*

get_instance_protect

Get instance protect settings

Example Usage

require 'clerk_sdk_ruby'

Models = ::Clerk::Models
s = ::Clerk::OpenAPIClient.new(
  bearer_auth: '<YOUR_BEARER_TOKEN_HERE>'
)
res = s.instance_settings.get_instance_protect

unless res.instance_protect.nil?
  # handle response
end

Response

Crystalline::Nilable.new(Models::Operations::GetInstanceProtectResponse)

Errors

Error Type Status Code Content Type
Errors::APIError 4XX, 5XX */*

update_instance_protect

Update instance protect settings

Example Usage

require 'clerk_sdk_ruby'

Models = ::Clerk::Models
s = ::Clerk::OpenAPIClient.new(
  bearer_auth: '<YOUR_BEARER_TOKEN_HERE>'
)

req = nil
res = s.instance_settings.update_instance_protect(request: req)

unless res.instance_protect.nil?
  # handle response
end

Parameters

Parameter Type Required Description
request Models::Operations::UpdateInstanceProtectRequest ✔️ The request object to use for the request.

Response

Crystalline::Nilable.new(Models::Operations::UpdateInstanceProtectResponse)

Errors

Error Type Status Code Content Type
Models::Errors::ClerkErrors 422 application/json
Errors::APIError 4XX, 5XX */*