Skip to content

Latest commit

 

History

History
81 lines (57 loc) · 2.75 KB

OrganizationDomainApi.md

File metadata and controls

81 lines (57 loc) · 2.75 KB
Raw

ClerkBackend::OrganizationDomainApi

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

Method HTTP request Description
update_organization_domain PATCH /organizations/{organization_id}/domains/{domain_id} Update an organization domain.

update_organization_domain

update_organization_domain(organization_id, domain_id, update_organization_domain_request)

Update an organization domain.

Updates the properties of an existing organization domain.

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::OrganizationDomainApi.new
organization_id = 'organization_id_example' # String | The ID of the organization the domain belongs to
domain_id = 'domain_id_example' # String | The ID of the domain
update_organization_domain_request = ClerkBackend::UpdateOrganizationDomainRequest.new # UpdateOrganizationDomainRequest | 

begin
  # Update an organization domain.
  result = api_instance.update_organization_domain(organization_id, domain_id, update_organization_domain_request)
  p result
rescue ClerkBackend::ApiError => e
  puts "Error when calling OrganizationDomainApi->update_organization_domain: #{e}"
end

Using the update_organization_domain_with_http_info variant

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

<Array(, Integer, Hash)> update_organization_domain_with_http_info(organization_id, domain_id, update_organization_domain_request)

begin
  # Update an organization domain.
  data, status_code, headers = api_instance.update_organization_domain_with_http_info(organization_id, domain_id, update_organization_domain_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <OrganizationDomain>
rescue ClerkBackend::ApiError => e
  puts "Error when calling OrganizationDomainApi->update_organization_domain_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
organization_id String The ID of the organization the domain belongs to
domain_id String The ID of the domain
update_organization_domain_request UpdateOrganizationDomainRequest

Return type

OrganizationDomain

Authorization

bearerAuth

HTTP request headers

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