Skip to content

Latest commit

 

History

History
149 lines (104 loc) · 4.01 KB

SignInTokensApi.md

File metadata and controls

149 lines (104 loc) · 4.01 KB
Raw

ClerkBackend::SignInTokensApi

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

Method HTTP request Description
create_sign_in_token POST /sign_in_tokens Create sign-in token
revoke_sign_in_token POST /sign_in_tokens/{sign_in_token_id}/revoke Revoke the given sign-in token

create_sign_in_token

create_sign_in_token(opts)

Create sign-in token

Creates a new sign-in token and associates it with the given user. By default, sign-in tokens expire in 30 days. You can optionally supply a different duration in seconds using the expires_in_seconds property.

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::SignInTokensApi.new
opts = {
  create_sign_in_token_request: ClerkBackend::CreateSignInTokenRequest.new # CreateSignInTokenRequest | 
}

begin
  # Create sign-in token
  result = api_instance.create_sign_in_token(opts)
  p result
rescue ClerkBackend::ApiError => e
  puts "Error when calling SignInTokensApi->create_sign_in_token: #{e}"
end

Using the create_sign_in_token_with_http_info variant

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

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

begin
  # Create sign-in token
  data, status_code, headers = api_instance.create_sign_in_token_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <SignInToken>
rescue ClerkBackend::ApiError => e
  puts "Error when calling SignInTokensApi->create_sign_in_token_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
create_sign_in_token_request CreateSignInTokenRequest [optional]

Return type

SignInToken

Authorization

bearerAuth

HTTP request headers

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

revoke_sign_in_token

revoke_sign_in_token(sign_in_token_id)

Revoke the given sign-in token

Revokes a pending sign-in 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::SignInTokensApi.new
sign_in_token_id = 'sign_in_token_id_example' # String | The ID of the sign-in token to be revoked

begin
  # Revoke the given sign-in token
  result = api_instance.revoke_sign_in_token(sign_in_token_id)
  p result
rescue ClerkBackend::ApiError => e
  puts "Error when calling SignInTokensApi->revoke_sign_in_token: #{e}"
end

Using the revoke_sign_in_token_with_http_info variant

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

<Array(, Integer, Hash)> revoke_sign_in_token_with_http_info(sign_in_token_id)

begin
  # Revoke the given sign-in token
  data, status_code, headers = api_instance.revoke_sign_in_token_with_http_info(sign_in_token_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <SignInToken>
rescue ClerkBackend::ApiError => e
  puts "Error when calling SignInTokensApi->revoke_sign_in_token_with_http_info: #{e}"
end

Parameters

Name Type Description Notes
sign_in_token_id String The ID of the sign-in token to be revoked

Return type

SignInToken

Authorization

bearerAuth

HTTP request headers

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