RedirectURLsApi.md

ClerkHttpClient::RedirectURLsApi

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

Method	HTTP request	Description
create_redirect_url	POST /redirect_urls	Create a redirect URL
delete_redirect_url	DELETE /redirect_urls/{id}	Delete a redirect URL
get_redirect_url	GET /redirect_urls/{id}	Retrieve a redirect URL
list_redirect_urls	GET /redirect_urls	List all redirect URLs

create_redirect_url

create_redirect_url(create_redirect_url_request)

Create a redirect URL

Create a redirect URL

Examples

require 'time'
require 'clerk-http-client'
# setup authorization
ClerkHttpClient.configure do |config|
  # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = ClerkHttpClient::RedirectURLsApi.new
create_redirect_url_request = ClerkHttpClient::CreateRedirectURLRequest.new # CreateRedirectURLRequest | 

begin
  # Create a redirect URL
  result = api_instance.create_redirect_url(create_redirect_url_request)
  p result
rescue ClerkHttpClient::ApiError => e
  puts "Error when calling RedirectURLsApi->create_redirect_url: #{e}"
end

Using the create_redirect_url_with_http_info variant

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

<Array(, Integer, Hash)> create_redirect_url_with_http_info(create_redirect_url_request)

begin
  # Create a redirect URL
  data, status_code, headers = api_instance.create_redirect_url_with_http_info(create_redirect_url_request)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <RedirectURL>
rescue ClerkHttpClient::ApiError => e
  puts "Error when calling RedirectURLsApi->create_redirect_url_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
create_redirect_url_request	CreateRedirectURLRequest

Return type

RedirectURL

Authorization

bearerAuth

HTTP request headers

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

delete_redirect_url

delete_redirect_url(id)

Delete a redirect URL

Remove the selected redirect URL from the whitelist of the instance

Examples

require 'time'
require 'clerk-http-client'
# setup authorization
ClerkHttpClient.configure do |config|
  # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = ClerkHttpClient::RedirectURLsApi.new
id = 'id_example' # String | The ID of the redirect URL

begin
  # Delete a redirect URL
  result = api_instance.delete_redirect_url(id)
  p result
rescue ClerkHttpClient::ApiError => e
  puts "Error when calling RedirectURLsApi->delete_redirect_url: #{e}"
end

Using the delete_redirect_url_with_http_info variant

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

<Array(, Integer, Hash)> delete_redirect_url_with_http_info(id)

begin
  # Delete a redirect URL
  data, status_code, headers = api_instance.delete_redirect_url_with_http_info(id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <DeletedObject>
rescue ClerkHttpClient::ApiError => e
  puts "Error when calling RedirectURLsApi->delete_redirect_url_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String	The ID of the redirect URL

Return type

DeletedObject

Authorization

bearerAuth

HTTP request headers

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

get_redirect_url

get_redirect_url(id)

Retrieve a redirect URL

Retrieve the details of the redirect URL with the given ID

Examples

require 'time'
require 'clerk-http-client'
# setup authorization
ClerkHttpClient.configure do |config|
  # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = ClerkHttpClient::RedirectURLsApi.new
id = 'id_example' # String | The ID of the redirect URL

begin
  # Retrieve a redirect URL
  result = api_instance.get_redirect_url(id)
  p result
rescue ClerkHttpClient::ApiError => e
  puts "Error when calling RedirectURLsApi->get_redirect_url: #{e}"
end

Using the get_redirect_url_with_http_info variant

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

<Array(, Integer, Hash)> get_redirect_url_with_http_info(id)

begin
  # Retrieve a redirect URL
  data, status_code, headers = api_instance.get_redirect_url_with_http_info(id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <RedirectURL>
rescue ClerkHttpClient::ApiError => e
  puts "Error when calling RedirectURLsApi->get_redirect_url_with_http_info: #{e}"
end

Parameters

Name	Type	Description	Notes
id	String	The ID of the redirect URL

Return type

RedirectURL

Authorization

bearerAuth

HTTP request headers

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

list_redirect_urls

<Array> list_redirect_urls

List all redirect URLs

Lists all whitelisted redirect_urls for the instance

Examples

require 'time'
require 'clerk-http-client'
# setup authorization
ClerkHttpClient.configure do |config|
  # Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
  config.access_token = 'YOUR_BEARER_TOKEN'
end

api_instance = ClerkHttpClient::RedirectURLsApi.new

begin
  # List all redirect URLs
  result = api_instance.list_redirect_urls
  p result
rescue ClerkHttpClient::ApiError => e
  puts "Error when calling RedirectURLsApi->list_redirect_urls: #{e}"
end

Using the list_redirect_urls_with_http_info variant

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

<Array(<Array>, Integer, Hash)> list_redirect_urls_with_http_info

begin
  # List all redirect URLs
  data, status_code, headers = api_instance.list_redirect_urls_with_http_info
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Array<RedirectURL>>
rescue ClerkHttpClient::ApiError => e
  puts "Error when calling RedirectURLsApi->list_redirect_urls_with_http_info: #{e}"
end

Parameters

This endpoint does not need any parameter.

Return type

Array<RedirectURL>

Authorization

bearerAuth

HTTP request headers

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