Skip to content

README.md

Latest commit

 

History

History
48 lines (31 loc) · 2.48 KB

README.md

File metadata and controls

48 lines (31 loc) · 2.48 KB
Raw

Miscellaneous

Overview

Available Operations

get_public_interstitial

The Clerk interstitial endpoint serves an html page that loads clerk.js in order to check the user's authentication state. It is used by Clerk SDKs when the user's authentication state cannot be immediately determined.

Example Usage

require 'clerk_sdk_ruby'

Models = ::Clerk::Models
s = ::Clerk::OpenAPIClient.new

req = Models::Operations::GetPublicInterstitialRequest.new(
  frontend_api_query_parameter1: 'pub_1a2b3c4d'
)
res = s.miscellaneous.get_public_interstitial(request: req)

if res.status_code == 200
  # handle response
end

Parameters

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

Response

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

Errors

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