Skip to content

Latest commit

 

History

History
42 lines (26 loc) · 2.59 KB

README.md

File metadata and controls

42 lines (26 loc) · 2.59 KB
Raw

Miscellaneous

(miscellaneous)

Overview

Various endpoints that do not belong in any particular category.

Available Operations

get_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

from clerk_backend_api import Clerk

with Clerk() as clerk:

    clerk.miscellaneous.get_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable_key="pub_1a2b3c4d")

    # Use the SDK ...

Parameters

Parameter Type Required Description Example
frontend_api Optional[str] ➖ The Frontend API key of your instance frontend-api_1a2b3c4d
publishable_key Optional[str] ➖ The publishable key of your instance pub_1a2b3c4d
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Errors

Error Type Status Code Content Type
models.SDKError 4XX, 5XX */*