(miscellaneous)
Various endpoints that do not belong in any particular category.
- get_interstitial - Returns the markup for the interstitial page
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.
from clerk_backend_api import Clerk
s = Clerk()
s.miscellaneous.get_interstitial(frontend_api="frontend-api_1a2b3c4d", publishable_key="pub_1a2b3c4d")
# Use the SDK ...| 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. |
| Error Object | Status Code | Content Type |
|---|---|---|
| models.SDKError | 4xx-5xx | / |