Skip to content

Latest commit

 

History

History
151 lines (108 loc) · 7.82 KB

README.md

File metadata and controls

151 lines (108 loc) · 7.82 KB
Raw

InstanceSettingsSDK

(instance_settings)

Overview

Available Operations

update

Updates the settings of an instance

Example Usage

from clerk_backend_api import Clerk

s = Clerk(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)

s.instance_settings.update(request={
    "test_mode": True,
    "hibp": False,
    "enhanced_email_deliverability": True,
    "support_email": "[email protected]",
    "clerk_js_version": "2.3.1",
    "development_origin": "http://localhost:3000",
    "allowed_origins": [
        "http://localhost:3000",
        "chrome-extension://extension_uiid",
        "capacitor://localhost",
    ],
    "url_based_session_syncing": True,
})

# Use the SDK ...

Parameters

Parameter Type Required Description
request models.UpdateInstanceRequestBody ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Errors

Error Type Status Code Content Type
models.ClerkErrors 422 application/json
models.SDKError 4XX, 5XX */*

update_restrictions

Updates the restriction settings of an instance

Example Usage

from clerk_backend_api import Clerk

s = Clerk(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)

res = s.instance_settings.update_restrictions(request={
    "allowlist": False,
    "blocklist": True,
    "block_email_subaddresses": True,
    "block_disposable_email_domains": True,
    "ignore_dots_for_gmail_addresses": False,
})

if res is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description
request models.UpdateInstanceRestrictionsRequestBody ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.InstanceRestrictions

Errors

Error Type Status Code Content Type
models.ClerkErrors 402, 422 application/json
models.SDKError 4XX, 5XX */*

update_organization_settings

Updates the organization settings of the instance

Example Usage

from clerk_backend_api import Clerk

s = Clerk(
    bearer_auth="<YOUR_BEARER_TOKEN_HERE>",
)

res = s.instance_settings.update_organization_settings(request={
    "enabled": True,
    "max_allowed_memberships": 10,
    "admin_delete_enabled": False,
    "domains_enabled": True,
    "domains_enrollment_modes": [
        "automatic_invitation",
        "automatic_suggestion",
    ],
    "creator_role_id": "creator_role",
    "domains_default_role_id": "member_role",
})

if res is not None:
    # handle response
    pass

Parameters

Parameter Type Required Description
request models.UpdateInstanceOrganizationSettingsRequestBody ✔️ The request object to use for the request.
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.OrganizationSettings

Errors

Error Type Status Code Content Type
models.ClerkErrors 402, 404, 422 application/json
models.SDKError 4XX, 5XX */*