Management

(management)

Overview

Available Operations

upsert_user - Upsert a user
create_organization - Create an organization
create_application - Create an application (instance)

upsert_user

Upsert a user using the provided information. If a user with the same email_address exists, it will be updated. Otherwise, a new user will be created. This endpoint is internal and requires a specific management token for authorization.

Example Usage

import clerk_backend_api
from clerk_backend_api import Clerk


with Clerk() as clerk:

    res = clerk.management.upsert_user(security=clerk_backend_api.ManagementUpsertUserSecurity(
        management_token="<YOUR_BEARER_TOKEN_HERE>",
    ), email_address="Roger_OReilly-Dibbert10@hotmail.com", first_name="Diana", last_name="Schmidt-Kutch")

    assert res is not None

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
`security`	models.ManagementUpsertUserSecurity	✔️	N/A
`email_address`	str	✔️	The email address of the user.
`first_name`	str	✔️	The first name of the user.
`last_name`	str	✔️	The last name of the user.
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.User

Errors

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

create_organization

Create a new organization. This endpoint is internal and requires a specific management token for authorization.

Example Usage

import clerk_backend_api
from clerk_backend_api import Clerk
from clerk_backend_api.utils import parse_datetime


with Clerk() as clerk:

    res = clerk.management.create_organization(security=clerk_backend_api.ManagementCreateOrganizationSecurity(
        management_token="<YOUR_BEARER_TOKEN_HERE>",
    ), name="<value>", slug="<value>", created_by="<value>", max_allowed_memberships=337266, public_metadata={}, private_metadata={}, created_at=parse_datetime("2024-04-10T20:37:41.925Z"))

    assert res is not None

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
`security`	models.ManagementCreateOrganizationSecurity	✔️	N/A
`name`	str	✔️	The name of the organization.
`slug`	str	✔️	The slug of the organization.
`created_by`	Optional[str]	➖	The ID of the user who created the organization.
`max_allowed_memberships`	Optional[int]	➖	The maximum allowed memberships for the organization.
`public_metadata`	Optional[models.PublicMetadata]	➖	Public metadata for the organization.
`private_metadata`	Optional[models.PrivateMetadata]	➖	Private metadata for the organization.
`created_at`	date	➖	The creation timestamp in RFC3339 format.
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.Organization

Errors

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

create_application

Create a new application (instance). This endpoint is internal and requires a specific management token for authorization.

Example Usage

import clerk_backend_api
from clerk_backend_api import Clerk


with Clerk() as clerk:

    res = clerk.management.create_application(security=clerk_backend_api.ManagementCreateApplicationSecurity(
        management_token="<YOUR_BEARER_TOKEN_HERE>",
    ), name="<value>", owner_id="<id>", plan_id="<id>", addon_ids=[
        "<value 1>",
    ], paid_externally=False, test_mode=True, max_allowed_users=623638, max_allowed_organizations=122319, subscription_metadata={
        "key": "<value>",
    }, environment_types=[
        clerk_backend_api.EnvironmentTypes.DEVELOPMENT,
    ])

    assert res is not None

    # Handle response
    print(res)

Parameters

Parameter	Type	Required	Description
`security`	models.ManagementCreateApplicationSecurity	✔️	N/A
`name`	str	✔️	The name of the application.
`owner_id`	str	✔️	The owner ID (organization ID) of the application.
`plan_id`	str	✔️	The plan ID for the application (e.g., "free_2022_06", "pro_2023_11").
`addon_ids`	List[str]	➖	List of add-on IDs (e.g., ["enhanced_auth_2023_11", "enhanced_orgs_2023_11"]).
`paid_externally`	Optional[bool]	➖	Whether the application is paid externally.
`test_mode`	Optional[bool]	➖	Whether the application is in test mode.
`max_allowed_users`	Optional[int]	➖	Maximum allowed users for the application.
`max_allowed_organizations`	Optional[int]	➖	Maximum allowed organizations for the application.
`subscription_metadata`	Dict[str, str]	➖	Subscription metadata for the application.
`environment_types`	List[models.EnvironmentTypes]	➖	List of environment types to create instances for.
`retries`	Optional[utils.RetryConfig]	➖	Configuration to override the default retry behavior of the client.

Response

models.ManagementApplicationResponse

Errors

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!