clerk-backend-sdk

The Clerk REST Backend API, meant to be accessed by backend servers.

Versions

When the API changes in a way that isn't compatible with older versions, a new version is released. Each version is identified by its release date, e.g. 2021-02-05. For more information, please see Clerk API Versions.

Please see https://clerk.com/docs for more information.

This Python package is automatically generated by the OpenAPI Generator project:

• API version: v1
• Package version: 1.0.0
• Generator version: 7.8.0
• Build package: org.openapitools.codegen.languages.PythonClientCodegen For more information, please visit https://clerk.com/support

Requirements.

Python 3.7+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import clerk_backend_sdk

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import clerk_backend_sdk

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import clerk_backend_sdk
from clerk_backend_sdk.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://api.clerk.com/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = clerk_backend_sdk.Configuration(
    host = "https://api.clerk.com/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure Bearer authorization (sk_<environment>_<secret value>): bearerAuth
configuration = clerk_backend_sdk.Configuration(
    access_token = os.environ["BEARER_TOKEN"]
)


# Enter a context with an instance of the API client
async with clerk_backend_sdk.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = clerk_backend_sdk.ActorTokensApi(api_client)
    create_actor_token_request = clerk_backend_sdk.CreateActorTokenRequest() # CreateActorTokenRequest |  (optional)

    try:
        # Create actor token
        api_response = await api_instance.create_actor_token(create_actor_token_request=create_actor_token_request)
        print("The response of ActorTokensApi->create_actor_token:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling ActorTokensApi->create_actor_token: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://api.clerk.com/v1

Documentation For Models

• ActorToken
• AddDomainRequest
• Admin
• AllowlistIdentifier
• BlocklistIdentifier
• BlocklistIdentifiers
• CNameTarget
• ChangeProductionInstanceDomainRequest
• ClerkError
• ClerkErrors
• Client
• CreateActorTokenRequest
• CreateAllowlistIdentifierRequest
• CreateBlocklistIdentifierRequest
• CreateEmailAddressRequest
• CreateInvitationRequest
• CreateJWTTemplateRequest
• CreateOAuthApplicationRequest
• CreateOrganizationInvitationBulkRequestInner
• CreateOrganizationInvitationRequest
• CreateOrganizationMembershipRequest
• CreateOrganizationRequest
• CreatePhoneNumberRequest
• CreateRedirectURLRequest
• CreateSAMLConnectionRequest
• CreateSAMLConnectionRequestAttributeMapping
• CreateSessionTokenFromTemplate200Response
• CreateSignInTokenRequest
• CreateUserRequest
• DeletedObject
• DisableMFA200Response
• Domain
• Domains
• EmailAddress
• EmailAddressVerification
• GetOAuthAccessToken200ResponseInner
• IdentificationLink
• InstanceRestrictions
• Invitation
• JWTTemplate
• MergeOrganizationMetadataRequest
• OAuthApplication
• OAuthApplicationWithSecret
• OAuthApplications
• OTP
• Oauth
• OauthError
• Organization
• OrganizationInvitation
• OrganizationInvitations
• OrganizationMembership
• OrganizationMembershipPublicUserData
• OrganizationMemberships
• OrganizationSettings
• OrganizationWithLogo
• Organizations
• Passkey
• PasswordHasher
• PhoneNumber
• PhoneNumberVerification
• PreviewTemplateRequest
• ProxyCheck
• RedirectURL
• RevokeInvitation200Response
• RevokeOrganizationInvitationRequest
• SAML
• SAMLAccount
• SAMLAccountVerification
• SAMLConnection
• SAMLConnectionAttributeMapping
• SAMLConnections
• SchemasPasskey
• SchemasPasskeyVerification
• Session
• SignInToken
• SignUp
• SvixURL
• Template
• TestingToken
• Ticket
• ToggleTemplateDeliveryRequest
• TotalCount
• UpdateDomainRequest
• UpdateEmailAddressRequest
• UpdateInstanceAuthConfig200Response
• UpdateInstanceAuthConfigRequest
• UpdateInstanceOrganizationSettingsRequest
• UpdateInstanceRequest
• UpdateInstanceRestrictionsRequest
• UpdateOAuthApplicationRequest
• UpdateOrganizationMembershipMetadataRequest
• UpdateOrganizationMembershipRequest
• UpdateOrganizationRequest
• UpdatePhoneNumberRequest
• UpdateProductionInstanceDomainRequest
• UpdateSAMLConnectionRequest
• UpdateSAMLConnectionRequestAttributeMapping
• UpdateSignUpRequest
• UpdateUserMetadataRequest
• UpdateUserRequest
• UpsertTemplateRequest
• User
• VerifyClientRequest
• VerifyDomainProxyRequest
• VerifyPassword200Response
• VerifyPasswordRequest
• VerifySessionRequest
• VerifyTOTP200Response
• VerifyTOTPRequest
• Web3Signature
• Web3Wallet
• Web3WalletVerification

Documentation For Authorization

Authentication schemes defined for the API:

bearerAuth

• Type: Bearer authentication (sk__)

Author

support@clerk.com