Skip to content

Latest commit

 

History

History
149 lines (104 loc) · 3.93 KB

ActorTokensApi.md

File metadata and controls

149 lines (104 loc) · 3.93 KB
Raw

ClerkBackend::ActorTokensApi

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

Method HTTP request Description
create_actor_token POST /actor_tokens Create actor token
revoke_actor_token POST /actor_tokens/{actor_token_id}/revoke Revoke actor token

create_actor_token

create_actor_token(opts)

Create actor token

Create an actor token that can be used to impersonate the given user. The actor parameter needs to include at least a "sub" key whose value is the ID of the actor (impersonating) user.

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::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 "Error when calling ActorTokensApi->create_actor_token: #{e}"
end

Using the create_actor_token_with_http_info variant

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

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

begin
  # Create actor token
  data, status_code, headers = api_instance.create_actor_token_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ActorToken>
rescue ClerkBackend::ApiError => e
  puts "Error when calling ActorTokensApi->create_actor_token_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
create_actor_token_request CreateActorTokenRequest [optional]

Return type

ActorToken

Authorization

bearerAuth

HTTP request headers

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

revoke_actor_token

revoke_actor_token(actor_token_id)

Revoke actor token

Revokes a pending actor token.

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::ActorTokensApi.new
actor_token_id = 'actor_token_id_example' # String | The ID of the actor token to be revoked.

begin
  # Revoke actor token
  result = api_instance.revoke_actor_token(actor_token_id)
  p result
rescue ClerkBackend::ApiError => e
  puts "Error when calling ActorTokensApi->revoke_actor_token: #{e}"
end

Using the revoke_actor_token_with_http_info variant

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

<Array(, Integer, Hash)> revoke_actor_token_with_http_info(actor_token_id)

begin
  # Revoke actor token
  data, status_code, headers = api_instance.revoke_actor_token_with_http_info(actor_token_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ActorToken>
rescue ClerkBackend::ApiError => e
  puts "Error when calling ActorTokensApi->revoke_actor_token_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
actor_token_id String The ID of the actor token to be revoked.

Return type

ActorToken

Authorization

bearerAuth

HTTP request headers

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