Skip to content

README.md

Latest commit

 

History

History
101 lines (68 loc) · 8.28 KB

README.md

File metadata and controls

101 lines (68 loc) · 8.28 KB
Raw

AdminPortalLinkTokens

Overview

Available Operations

create_admin_portal_link_token

Create an Admin Portal Link Token

Example Usage

from clerk_backend_api import Clerk


with Clerk(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as clerk:

    res = clerk.admin_portal_link_tokens.create_admin_portal_link_token(organization_id="<id>", it_contact_id="<id>", scopes=[
        "<value 1>",
        "<value 2>",
    ], seconds_until_expiration=3600)

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
organization_id Optional[str] ➖ N/A
it_contact_id Optional[str] ➖ N/A
scopes List[str] ➖ N/A
seconds_until_expiration Optional[int] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.CreateAdminPortalLinkTokenResponseBody

Errors

Error Type Status Code Content Type
models.CreateAdminPortalLinkTokenAdminPortalLinkTokensResponseBody 400 application/json
models.CreateAdminPortalLinkTokenAdminPortalLinkTokensResponseResponseBody 401 application/json
models.CreateAdminPortalLinkTokenAdminPortalLinkTokensResponse403ResponseBody 403 application/json
models.CreateAdminPortalLinkTokenAdminPortalLinkTokensResponse409ResponseBody 409 application/json
models.SDKError 4XX, 5XX */*

revoke_admin_portal_link_token

Revoke an Admin Portal Link Token

Example Usage

from clerk_backend_api import Clerk


with Clerk(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
) as clerk:

    res = clerk.admin_portal_link_tokens.revoke_admin_portal_link_token(admin_portal_link_token_id="<id>", revocation_reason="<value>")

    # Handle response
    print(res)

Parameters

Parameter Type Required Description
admin_portal_link_token_id str ✔️ N/A
revocation_reason OptionalNullable[str] ➖ N/A
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.RevokeAdminPortalLinkTokenResponseBody

Errors

Error Type Status Code Content Type
models.RevokeAdminPortalLinkTokenAdminPortalLinkTokensResponseBody 400 application/json
models.RevokeAdminPortalLinkTokenAdminPortalLinkTokensResponseResponseBody 401 application/json
models.RevokeAdminPortalLinkTokenAdminPortalLinkTokensResponse403ResponseBody 403 application/json
models.RevokeAdminPortalLinkTokenAdminPortalLinkTokensResponse404ResponseBody 404 application/json
models.SDKError 4XX, 5XX */*