Download the PHP package clerkinc/backend-php without Composer

# clerkinc/backend-php --- ## Overview [Clerk](https://clerk.com?utm_source=github&utm_medium=clerk-backend-php) is the easiest way to add authentication and user management to your application. To gain a better understanding of the Clerk Backend API, refer to the Backend API documentation. ## Summary Clerk Backend API: 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. `2025-04-10`. For more information, please see [Clerk API Versions](https://clerk.com/docs/versioning/available-versions). Please see https://clerk.com/docs for more information. More information about the API can be found at https://clerk.com/docs ## Table of Contents * [clerkinc/backend-php](#clerkincbackend-php) * [Overview](#overview) * [SDK Installation](#sdk-installation) * [Usage](#usage) * [SDK Example Usage](#sdk-example-usage) * [Request Authentication](#request-authentication) * [Authentication](#authentication) * [Available Resources and Operations](#available-resources-and-operations) * [Retries](#retries) * [Error Handling](#error-handling) * [Server Selection](#server-selection) * [Development](#development) * [Maturity](#maturity) * [Support](#support) * [Contributing](#contributing) * [Security](#security) * [License](#license) ## SDK Installation The SDK relies on [Composer](https://getcomposer.org/) to manage its dependencies. To install the SDK and add it as a dependency to an existing `composer.json` file: ## Usage Retrieve your Backend API key from the [API Keys](https://dashboard.clerk.com/last-active?path=api-keys) screen in your Clerk dashboard and set it as an environment variable in a `.env` file: ## SDK Example Usage ### Example ## Request Authentication Use the [authenticateRequest](https://github.com/clerk/clerk-sdk-php/tree/main/src/Helpers/Jwks/AuthenticateRequest.php) method to authenticate a request from your app's frontend (when using a Clerk frontend SDK) to Clerk's Backend API. For example the following utility function checks if the user is effectively signed in: If the request is correctly authenticated, the token's payload is made available in `$requestState->payload`. Otherwise the reason for the token verification failure is given by `requestState->errorReason`. ## Authentication ### Per-Client Security Schemes This SDK supports the following security scheme globally: | Name | Type | Scheme | | ------------ | ---- | ----------- | | `bearerAuth` | http | HTTP Bearer | To authenticate with the API the `bearerAuth` parameter must be set when initializing the SDK. For example: ## Available Resources and Operations

Available methods

### [actorTokens](docs/sdks/actortokens/README.md) * [create](docs/sdks/actortokens/README.md#create) - Create actor token * [revoke](docs/sdks/actortokens/README.md#revoke) - Revoke actor token ### [allowlistIdentifiers](docs/sdks/allowlistidentifiers/README.md) * [list](docs/sdks/allowlistidentifiers/README.md#list) - List all identifiers on the allow-list * [create](docs/sdks/allowlistidentifiers/README.md#create) - Add identifier to the allow-list * [delete](docs/sdks/allowlistidentifiers/README.md#delete) - Delete identifier from allow-list ### [awsCredentials](docs/sdks/awscredentials/README.md) * [delete](docs/sdks/awscredentials/README.md#delete) - Delete an AWS Credential * [update](docs/sdks/awscredentials/README.md#update) - Update an AWS Credential ### [betaFeatures](docs/sdks/betafeatures/README.md) * [updateInstanceSettings](docs/sdks/betafeatures/README.md#updateinstancesettings) - Update instance settings * [~~updateProductionInstanceDomain~~](docs/sdks/betafeatures/README.md#updateproductioninstancedomain) - Update production instance domain :warning: **Deprecated** ### [blocklistIdentifiers](docs/sdks/blocklistidentifiers/README.md) * [list](docs/sdks/blocklistidentifiers/README.md#list) - List all identifiers on the block-list * [create](docs/sdks/blocklistidentifiers/README.md#create) - Add identifier to the block-list * [delete](docs/sdks/blocklistidentifiers/README.md#delete) - Delete identifier from block-list ### [clients](docs/sdks/clients/README.md) * [~~list~~](docs/sdks/clients/README.md#list) - List all clients :warning: **Deprecated** * [verify](docs/sdks/clients/README.md#verify) - Verify a client * [get](docs/sdks/clients/README.md#get) - Get a client ### [commerce](docs/sdks/commerce/README.md) * [listPlans](docs/sdks/commerce/README.md#listplans) - List all commerce plans * [listSubscriptionItems](docs/sdks/commerce/README.md#listsubscriptionitems) - List all subscription items * [cancelSubscriptionItem](docs/sdks/commerce/README.md#cancelsubscriptionitem) - Cancel a subscription item ### [domains](docs/sdks/domains/README.md) * [list](docs/sdks/domains/README.md#list) - List all instance domains * [add](docs/sdks/domains/README.md#add) - Add a domain * [delete](docs/sdks/domains/README.md#delete) - Delete a satellite domain * [update](docs/sdks/domains/README.md#update) - Update a domain ### [emailAddresses](docs/sdks/emailaddresses/README.md) * [create](docs/sdks/emailaddresses/README.md#create) - Create an email address * [get](docs/sdks/emailaddresses/README.md#get) - Retrieve an email address * [delete](docs/sdks/emailaddresses/README.md#delete) - Delete an email address * [update](docs/sdks/emailaddresses/README.md#update) - Update an email address ### [~~emailAndSmsTemplates~~](docs/sdks/emailandsmstemplates/README.md) * [~~upsert~~](docs/sdks/emailandsmstemplates/README.md#upsert) - Update a template for a given type and slug :warning: **Deprecated** ### [~~emailSMSTemplates~~](docs/sdks/emailsmstemplates/README.md) * [~~list~~](docs/sdks/emailsmstemplates/README.md#list) - List all templates :warning: **Deprecated** * [~~get~~](docs/sdks/emailsmstemplates/README.md#get) - Retrieve a template :warning: **Deprecated** * [~~revert~~](docs/sdks/emailsmstemplates/README.md#revert) - Revert a template :warning: **Deprecated** * [~~toggleTemplateDelivery~~](docs/sdks/emailsmstemplates/README.md#toggletemplatedelivery) - Toggle the delivery by Clerk for a template of a given type and slug :warning: **Deprecated** ### [experimentalAccountlessApplications](docs/sdks/experimentalaccountlessapplications/README.md) * [create](docs/sdks/experimentalaccountlessapplications/README.md#create) - Create an accountless application [EXPERIMENTAL] * [complete](docs/sdks/experimentalaccountlessapplications/README.md#complete) - Complete an accountless application [EXPERIMENTAL] ### [instanceSettings](docs/sdks/instancesettings/README.md) * [get](docs/sdks/instancesettings/README.md#get) - Fetch the current instance * [update](docs/sdks/instancesettings/README.md#update) - Update instance settings * [updateRestrictions](docs/sdks/instancesettings/README.md#updaterestrictions) - Update instance restrictions * [changeDomain](docs/sdks/instancesettings/README.md#changedomain) - Update production instance domain * [updateOrganizationSettings](docs/sdks/instancesettings/README.md#updateorganizationsettings) - Update instance organization settings ### [invitations](docs/sdks/invitations/README.md) * [create](docs/sdks/invitations/README.md#create) - Create an invitation * [list](docs/sdks/invitations/README.md#list) - List all invitations * [bulkCreate](docs/sdks/invitations/README.md#bulkcreate) - Create multiple invitations * [revoke](docs/sdks/invitations/README.md#revoke) - Revokes an invitation ### [jwks](docs/sdks/jwks/README.md) * [getJWKS](docs/sdks/jwks/README.md#getjwks) - Retrieve the JSON Web Key Set of the instance ### [jwtTemplates](docs/sdks/jwttemplates/README.md) * [list](docs/sdks/jwttemplates/README.md#list) - List all templates * [create](docs/sdks/jwttemplates/README.md#create) - Create a JWT template * [get](docs/sdks/jwttemplates/README.md#get) - Retrieve a template * [update](docs/sdks/jwttemplates/README.md#update) - Update a JWT template * [delete](docs/sdks/jwttemplates/README.md#delete) - Delete a Template ### [m2m](docs/sdks/m2m/README.md) * [createToken](docs/sdks/m2m/README.md#createtoken) - Create a M2M Token * [listTokens](docs/sdks/m2m/README.md#listtokens) - Get M2M Tokens * [revokeToken](docs/sdks/m2m/README.md#revoketoken) - Revoke a M2M Token * [verifyToken](docs/sdks/m2m/README.md#verifytoken) - Verify a M2M Token ### [machines](docs/sdks/machines/README.md) * [list](docs/sdks/machines/README.md#list) - Get a list of machines for an instance * [create](docs/sdks/machines/README.md#create) - Create a machine * [get](docs/sdks/machines/README.md#get) - Retrieve a machine * [update](docs/sdks/machines/README.md#update) - Update a machine * [delete](docs/sdks/machines/README.md#delete) - Delete a machine * [getSecretKey](docs/sdks/machines/README.md#getsecretkey) - Retrieve a machine secret key * [createScope](docs/sdks/machines/README.md#createscope) - Create a machine scope * [deleteScope](docs/sdks/machines/README.md#deletescope) - Delete a machine scope ### [miscellaneous](docs/sdks/miscellaneous/README.md) * [getPublicInterstitial](docs/sdks/miscellaneous/README.md#getpublicinterstitial) - Returns the markup for the interstitial page ### [oauthAccessTokens](docs/sdks/oauthaccesstokens/README.md) * [verify](docs/sdks/oauthaccesstokens/README.md#verify) - Verify an OAuth Access Token ### [oauthApplications](docs/sdks/oauthapplications/README.md) * [list](docs/sdks/oauthapplications/README.md#list) - Get a list of OAuth applications for an instance * [create](docs/sdks/oauthapplications/README.md#create) - Create an OAuth application * [get](docs/sdks/oauthapplications/README.md#get) - Retrieve an OAuth application by ID * [update](docs/sdks/oauthapplications/README.md#update) - Update an OAuth application * [delete](docs/sdks/oauthapplications/README.md#delete) - Delete an OAuth application * [rotateSecret](docs/sdks/oauthapplications/README.md#rotatesecret) - Rotate the client secret of the given OAuth application ### [organizationDomains](docs/sdks/organizationdomains/README.md) * [create](docs/sdks/organizationdomains/README.md#create) - Create a new organization domain. * [list](docs/sdks/organizationdomains/README.md#list) - Get a list of all domains of an organization. * [update](docs/sdks/organizationdomains/README.md#update) - Update an organization domain. * [delete](docs/sdks/organizationdomains/README.md#delete) - Remove a domain from an organization. * [listAll](docs/sdks/organizationdomains/README.md#listall) - List all organization domains ### [organizationInvitations](docs/sdks/organizationinvitations/README.md) * [getAll](docs/sdks/organizationinvitations/README.md#getall) - Get a list of organization invitations for the current instance * [create](docs/sdks/organizationinvitations/README.md#create) - Create and send an organization invitation * [list](docs/sdks/organizationinvitations/README.md#list) - Get a list of organization invitations * [bulkCreate](docs/sdks/organizationinvitations/README.md#bulkcreate) - Bulk create and send organization invitations * [~~listPending~~](docs/sdks/organizationinvitations/README.md#listpending) - Get a list of pending organization invitations :warning: **Deprecated** * [get](docs/sdks/organizationinvitations/README.md#get) - Retrieve an organization invitation by ID * [revoke](docs/sdks/organizationinvitations/README.md#revoke) - Revoke a pending organization invitation ### [organizationMemberships](docs/sdks/organizationmemberships/README.md) * [create](docs/sdks/organizationmemberships/README.md#create) - Create a new organization membership * [list](docs/sdks/organizationmemberships/README.md#list) - Get a list of all members of an organization * [update](docs/sdks/organizationmemberships/README.md#update) - Update an organization membership * [delete](docs/sdks/organizationmemberships/README.md#delete) - Remove a member from an organization * [updateMetadata](docs/sdks/organizationmemberships/README.md#updatemetadata) - Merge and update organization membership metadata ### [organizations](docs/sdks/organizations/README.md) * [list](docs/sdks/organizations/README.md#list) - Get a list of organizations for an instance * [create](docs/sdks/organizations/README.md#create) - Create an organization * [get](docs/sdks/organizations/README.md#get) - Retrieve an organization by ID or slug * [update](docs/sdks/organizations/README.md#update) - Update an organization * [delete](docs/sdks/organizations/README.md#delete) - Delete an organization * [mergeMetadata](docs/sdks/organizations/README.md#mergemetadata) - Merge and update metadata for an organization * [uploadLogo](docs/sdks/organizations/README.md#uploadlogo) - Upload a logo for the organization * [deleteLogo](docs/sdks/organizations/README.md#deletelogo) - Delete the organization's logo. * [getBillingSubscription](docs/sdks/organizations/README.md#getbillingsubscription) - Retrieve an organization's billing subscription ### [phoneNumbers](docs/sdks/phonenumbers/README.md) * [create](docs/sdks/phonenumbers/README.md#create) - Create a phone number * [get](docs/sdks/phonenumbers/README.md#get) - Retrieve a phone number * [delete](docs/sdks/phonenumbers/README.md#delete) - Delete a phone number * [update](docs/sdks/phonenumbers/README.md#update) - Update a phone number ### [proxyChecks](docs/sdks/proxychecks/README.md) * [verify](docs/sdks/proxychecks/README.md#verify) - Verify the proxy configuration for your domain ### [redirectUrls](docs/sdks/redirecturls/README.md) * [list](docs/sdks/redirecturls/README.md#list) - List all redirect URLs * [create](docs/sdks/redirecturls/README.md#create) - Create a redirect URL * [get](docs/sdks/redirecturls/README.md#get) - Retrieve a redirect URL * [delete](docs/sdks/redirecturls/README.md#delete) - Delete a redirect URL ### [samlConnections](docs/sdks/samlconnections/README.md) * [list](docs/sdks/samlconnections/README.md#list) - Get a list of SAML Connections for an instance * [create](docs/sdks/samlconnections/README.md#create) - Create a SAML Connection * [get](docs/sdks/samlconnections/README.md#get) - Retrieve a SAML Connection by ID * [update](docs/sdks/samlconnections/README.md#update) - Update a SAML Connection * [delete](docs/sdks/samlconnections/README.md#delete) - Delete a SAML Connection ### [sessions](docs/sdks/sessions/README.md) * [list](docs/sdks/sessions/README.md#list) - List all sessions * [create](docs/sdks/sessions/README.md#create) - Create a new active session * [get](docs/sdks/sessions/README.md#get) - Retrieve a session * [refresh](docs/sdks/sessions/README.md#refresh) - Refresh a session * [revoke](docs/sdks/sessions/README.md#revoke) - Revoke a session * [createToken](docs/sdks/sessions/README.md#createtoken) - Create a session token * [createTokenFromTemplate](docs/sdks/sessions/README.md#createtokenfromtemplate) - Create a session token from a jwt template ### [signInTokens](docs/sdks/signintokens/README.md) * [create](docs/sdks/signintokens/README.md#create) - Create sign-in token * [revoke](docs/sdks/signintokens/README.md#revoke) - Revoke the given sign-in token ### [signUps](docs/sdks/signups/README.md) * [get](docs/sdks/signups/README.md#get) - Retrieve a sign-up by ID * [update](docs/sdks/signups/README.md#update) - Update a sign-up ### [~~templates~~](docs/sdks/templates/README.md) * [~~preview~~](docs/sdks/templates/README.md#preview) - Preview changes to a template :warning: **Deprecated** ### [testingTokens](docs/sdks/testingtokens/README.md) * [create](docs/sdks/testingtokens/README.md#create) - Retrieve a new testing token ### [users](docs/sdks/users/README.md) * [list](docs/sdks/users/README.md#list) - List all users * [create](docs/sdks/users/README.md#create) - Create a new user * [count](docs/sdks/users/README.md#count) - Count users * [get](docs/sdks/users/README.md#get) - Retrieve a user * [update](docs/sdks/users/README.md#update) - Update a user * [delete](docs/sdks/users/README.md#delete) - Delete a user * [ban](docs/sdks/users/README.md#ban) - Ban a user * [unban](docs/sdks/users/README.md#unban) - Unban a user * [bulkBan](docs/sdks/users/README.md#bulkban) - Ban multiple users * [bulkUnban](docs/sdks/users/README.md#bulkunban) - Unban multiple users * [lock](docs/sdks/users/README.md#lock) - Lock a user * [unlock](docs/sdks/users/README.md#unlock) - Unlock a user * [setProfileImage](docs/sdks/users/README.md#setprofileimage) - Set user profile image * [deleteProfileImage](docs/sdks/users/README.md#deleteprofileimage) - Delete user profile image * [updateMetadata](docs/sdks/users/README.md#updatemetadata) - Merge and update a user's metadata * [getBillingSubscription](docs/sdks/users/README.md#getbillingsubscription) - Retrieve a user's billing subscription * [getOAuthAccessToken](docs/sdks/users/README.md#getoauthaccesstoken) - Retrieve the OAuth access token of a user * [getOrganizationMemberships](docs/sdks/users/README.md#getorganizationmemberships) - Retrieve all memberships for a user * [getOrganizationInvitations](docs/sdks/users/README.md#getorganizationinvitations) - Retrieve all invitations for a user * [verifyPassword](docs/sdks/users/README.md#verifypassword) - Verify the password of a user * [verifyTotp](docs/sdks/users/README.md#verifytotp) - Verify a TOTP or backup code for a user * [disableMfa](docs/sdks/users/README.md#disablemfa) - Disable a user's MFA methods * [deleteBackupCodes](docs/sdks/users/README.md#deletebackupcodes) - Disable all user's Backup codes * [deletePasskey](docs/sdks/users/README.md#deletepasskey) - Delete a user passkey * [deleteWeb3Wallet](docs/sdks/users/README.md#deleteweb3wallet) - Delete a user web3 wallet * [deleteTOTP](docs/sdks/users/README.md#deletetotp) - Delete all the user's TOTPs * [deleteExternalAccount](docs/sdks/users/README.md#deleteexternalaccount) - Delete External Account * [getInstanceOrganizationMemberships](docs/sdks/users/README.md#getinstanceorganizationmemberships) - Get a list of all organization memberships within an instance. ### [waitlistEntries](docs/sdks/waitlistentries/README.md) * [list](docs/sdks/waitlistentries/README.md#list) - List all waitlist entries * [create](docs/sdks/waitlistentries/README.md#create) - Create a waitlist entry * [invite](docs/sdks/waitlistentries/README.md#invite) - Invite a waitlist entry * [reject](docs/sdks/waitlistentries/README.md#reject) - Reject a waitlist entry ### [webhooks](docs/sdks/webhooks/README.md) * [createSvixApp](docs/sdks/webhooks/README.md#createsvixapp) - Create a Svix app * [deleteSvixApp](docs/sdks/webhooks/README.md#deletesvixapp) - Delete a Svix app * [generateSvixAuthURL](docs/sdks/webhooks/README.md#generatesvixauthurl) - Create a Svix Dashboard URL

## Retries Some of the endpoints in this SDK support retries. If you use the SDK without any configuration, it will fall back to the default retry strategy provided by the API. However, the default retry strategy can be overridden on a per-operation basis, or across the entire SDK. To change the default retry strategy for a single API call, simply provide an `Options` object built with a `RetryConfig` object to the call: If you'd like to override the default retry strategy for all operations that support retries, you can pass a `RetryConfig` object to the `SDKBuilder->setRetryConfig` function when initializing the SDK: ## Error Handling Handling errors in this SDK should largely match your expectations. All operations return a response object or throw an exception. By default an API error will raise a `Errors\SDKException` exception, which has the following properties: | Property | Type | Description | |----------------|-----------------------------------------|-----------------------| | `$message` | *string* | The error message | | `$statusCode` | *int* | The HTTP status code | | `$rawResponse` | *?\Psr\Http\Message\ResponseInterface* | The raw HTTP response | | `$body` | *string* | The response content | When custom error responses are specified for an operation, the SDK may also throw their associated exception. You can refer to respective *Errors* tables in SDK docs for more details on possible exception types for each operation. For example, the `delete` method throws the following exceptions: | Error Type | Status Code | Content Type | | ------------------- | ------------------ | ---------------- | | Errors\ClerkErrors | 400, 401, 403, 404 | application/json | | Errors\SDKException | 4XX, 5XX | \*/\* | ### Example ## Server Selection ### Override Server URL Per-Client The default server can be overridden globally using the `setServerUrl(string $serverUrl)` builder method when initializing the SDK client instance. For example: # Development ## Maturity This SDK is in beta, and there may be breaking changes between versions without a major version update. Therefore, we recommend pinning usage to a specific package version. This way, you can install the same version each time without breaking changes unless you are intentionally looking for the latest version. ## Support You can get in touch with us in any of the following ways: - Join the official community [Clerk Discord server](https://clerk.com/discord) - Create a [GitHub Discussion](https://github.com/clerk/backend-php/discussions) - Contact options listed on [Clerk Support page](https://clerk.com/support?utm_source=github&utm_medium=clerk-backend-php) ## Contributing We're open to all community contributions! ## Security `clerkinc/backend-php` follows good practices of security, but 100% security cannot be assured. `clerkinc/backend-php` is provided **"as is"** without any **warranty**. Use at your own risk. _For more information and to report security issues, please refer to the [security documentation](https://github.com/clerk/backend-php/blob/main/docs/SECURITY.md)._ ## License This project is licensed under the **MIT license**. See [LICENSE](https://github.com/clerk/backend-php/blob/main/LICENSE) for more information.