https://github.com/clerk/clerk-sdk-csharp

Last synced: 7 months ago
JSON representation
Host: GitHub
URL: https://github.com/clerk/clerk-sdk-csharp
Owner: clerk
License: mit
Created: 2024-11-08T18:47:24.000Z (over 1 year ago)
Default Branch: main
Last Pushed: 2025-03-18T00:07:21.000Z (over 1 year ago)
Last Synced: 2025-03-18T01:23:09.108Z (over 1 year ago)
Language: C#
Size: 1.13 MB
Stars: 17
Watchers: 2
Forks: 5
Open Issues: 6
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project

README

          


  

    

      

      

    

  

   The most comprehensive User Management Platform

   

  







## 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

  * [SDK Installation](#sdk-installation)

  * [SDK Example Usage](#sdk-example-usage)

  * [Authentication](#authentication)

  * [Request Authentication](#request-authentication)

  * [Available Resources and Operations](#available-resources-and-operations)

  * [Retries](#retries)

  * [Error Handling](#error-handling)

  * [Server Selection](#server-selection)

  * [Custom HTTP Client](#custom-http-client)

* [Development](#development)

  * [Maturity](#maturity)

  * [Contributions](#contributions)

## SDK Installation

### NuGet

To add the [NuGet](https://www.nuget.org/) package to a .NET project:

```bash

dotnet add package Clerk.BackendAPI

```

### Locally

To add a reference to a local instance of the SDK in a .NET project:

```bash

dotnet add reference src/Clerk/BackendAPI/Clerk.BackendAPI.csproj

```

## SDK Example Usage

### Example

```csharp

using Clerk.BackendAPI;

using Clerk.BackendAPI.Models.Components;

var sdk = new ClerkBackendApi(bearerAuth: "");

var res = await sdk.EmailAddresses.GetAsync(emailAddressId: "email_address_id_example");

// handle response

```

## 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 client instance. For example:

```csharp

using Clerk.BackendAPI;

using Clerk.BackendAPI.Models.Components;

using Clerk.BackendAPI.Models.Operations;

var sdk = new ClerkBackendApi(bearerAuth: "");

GetPublicInterstitialRequest req = new GetPublicInterstitialRequest() {

    FrontendApiQueryParameter = "frontend-api_1a2b3c4d",

    FrontendApiQueryParameter1 = "pub_1a2b3c4d",

};

var res = await sdk.Miscellaneous.GetPublicInterstitialAsync(req);

// handle response

```

## Request Authentication

Use the [AuthenticateRequestAsync](https://github.com/clerk/clerk-sdk-csharp/blob/main/src/Clerk/BackendAPI/Helpers/AuthenticateRequest.cs) 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:

```csharp

using Clerk.BackendAPI.Helpers.Jwks;

using System;

using System.Net.Http;

using System.Threading.Tasks;

public class UserAuthentication

{

    public static async Task IsSignedInAsync(HttpRequestMessage request)

    {

        var options = new AuthenticateRequestOptions(

            secretKey: Environment.GetEnvironmentVariable("CLERK_SECRET_KEY"),

            authorizedParties: new string[] { "https://example.com" }

        );

        var requestState = await AuthenticateRequest.AuthenticateRequestAsync(request, options);

        return requestState.isSignedIn();

    }

}

```

### Machine Authentication

For machine-to-machine authentication, you can use machine tokens as shown below.

```csharp

using Clerk.BackendAPI.Helpers.Jwks;

using System;

using System.Net.Http;

using System.Threading.Tasks;

public class MachineAuthentication

{

    // Accept only machine tokens

    public static async Task IsMachineAuthenticatedAsync(HttpRequestMessage request)

    {

        var options = new AuthenticateRequestOptions(

            secretKey: Environment.GetEnvironmentVariable("CLERK_SECRET_KEY"),

            acceptsToken: new[] { "oauth_token" }  // Only accept oauth tokens

        );

        var requestState = await AuthenticateRequest.AuthenticateRequestAsync(request, options);

        return requestState.isSignedIn();

    }

}

```

## 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

### [APIKeys](docs/sdks/apikeys/README.md)

* [CreateApiKey](docs/sdks/apikeys/README.md#createapikey) - Create an API Key

* [GetApiKeys](docs/sdks/apikeys/README.md#getapikeys) - Get API Keys

* [GetApiKey](docs/sdks/apikeys/README.md#getapikey) - Get an API Key by ID

* [UpdateApiKey](docs/sdks/apikeys/README.md#updateapikey) - Update an API Key

* [DeleteApiKey](docs/sdks/apikeys/README.md#deleteapikey) - Delete an API Key

* [GetApiKeySecret](docs/sdks/apikeys/README.md#getapikeysecret) - Get an API Key Secret

* [RevokeApiKey](docs/sdks/apikeys/README.md#revokeapikey) - Revoke an API Key

* [VerifyApiKey](docs/sdks/apikeys/README.md#verifyapikey) - Verify an API Key

### [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**

### [Billing](docs/sdks/billing/README.md)

* [ListPlans](docs/sdks/billing/README.md#listplans) - List all billing plans

* [ListSubscriptionItems](docs/sdks/billing/README.md#listsubscriptionitems) - List all subscription items

* [CancelSubscriptionItem](docs/sdks/billing/README.md#cancelsubscriptionitem) - Cancel a subscription item

* [ExtendSubscriptionItemFreeTrial](docs/sdks/billing/README.md#extendsubscriptionitemfreetrial) - Extend free trial for a subscription item

* [ListStatements](docs/sdks/billing/README.md#liststatements) - List all billing statements

* [GetStatement](docs/sdks/billing/README.md#getstatement) - Retrieve a billing statement

* [GetStatementPaymentAttempts](docs/sdks/billing/README.md#getstatementpaymentattempts) - List payment attempts for a billing statement

### [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

### [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**

### [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

* [RotateSecretKey](docs/sdks/machines/README.md#rotatesecretkey) - Rotate a machine's 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

### [OrganizationPermissions](docs/sdks/organizationpermissions/README.md)

* [List](docs/sdks/organizationpermissions/README.md#list) - Get a list of all organization permissions

* [Create](docs/sdks/organizationpermissions/README.md#create) - Create a new organization permission

* [Get](docs/sdks/organizationpermissions/README.md#get) - Get an organization permission

* [Update](docs/sdks/organizationpermissions/README.md#update) - Update an organization permission

* [Delete](docs/sdks/organizationpermissions/README.md#delete) - Delete an organization permission

### [OrganizationRoles](docs/sdks/organizationroles/README.md)

* [List](docs/sdks/organizationroles/README.md#list) - Get a list of organization roles

* [Create](docs/sdks/organizationroles/README.md#create) - Create an organization role

* [Get](docs/sdks/organizationroles/README.md#get) - Retrieve an organization role

* [Update](docs/sdks/organizationroles/README.md#update) - Update an organization role

* [Delete](docs/sdks/organizationroles/README.md#delete) - Delete an organization role

* [AssignPermission](docs/sdks/organizationroles/README.md#assignpermission) - Assign a permission to an organization role

* [RemovePermission](docs/sdks/organizationroles/README.md#removepermission) - Remove a permission from an organization role

### [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

* [Delete](docs/sdks/waitlistentries/README.md#delete) - Delete a pending 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 pass a `RetryConfig` to the call:

```csharp

using Clerk.BackendAPI;

using Clerk.BackendAPI.Models.Operations;

var sdk = new ClerkBackendApi();

GetPublicInterstitialRequest req = new GetPublicInterstitialRequest() {

    FrontendApiQueryParameter = "frontend-api_1a2b3c4d",

    FrontendApiQueryParameter1 = "pub_1a2b3c4d",

};

var res = await sdk.Miscellaneous.GetPublicInterstitialAsync(

    retryConfig: new RetryConfig(

        strategy: RetryConfig.RetryStrategy.BACKOFF,

        backoff: new BackoffStrategy(

            initialIntervalMs: 1L,

            maxIntervalMs: 50L,

            maxElapsedTimeMs: 100L,

            exponent: 1.1

        ),

        retryConnectionErrors: false

    ),

    request: req

);

// handle response

```

If you'd like to override the default retry strategy for all operations that support retries, you can use the `RetryConfig` optional parameter when intitializing the SDK:

```csharp

using Clerk.BackendAPI;

using Clerk.BackendAPI.Models.Operations;

var sdk = new ClerkBackendApi(retryConfig: new RetryConfig(

    strategy: RetryConfig.RetryStrategy.BACKOFF,

    backoff: new BackoffStrategy(

        initialIntervalMs: 1L,

        maxIntervalMs: 50L,

        maxElapsedTimeMs: 100L,

        exponent: 1.1

    ),

    retryConnectionErrors: false

));

GetPublicInterstitialRequest req = new GetPublicInterstitialRequest() {

    FrontendApiQueryParameter = "frontend-api_1a2b3c4d",

    FrontendApiQueryParameter1 = "pub_1a2b3c4d",

};

var res = await sdk.Miscellaneous.GetPublicInterstitialAsync(req);

// handle response

```

## Error Handling

[`SDKBaseError`](./src/Clerk/BackendAPI/Models/Errors/SDKBaseError.cs) is the base exception class for all HTTP error responses. It has the following properties:

| Property      | Type                  | Description           |

|---------------|-----------------------|-----------------------|

| `Message`     | *string*              | Error message         |

| `Request`     | *HttpRequestMessage*  | HTTP request object   |

| `Response`    | *HttpResponseMessage* | HTTP response object  |

Some exceptions in this SDK include an additional `Payload` field, which will contain deserialized custom error data when present. Possible exceptions are listed in the [Error Classes](#error-classes) section.

### Example

```csharp

using Clerk.BackendAPI;

using Clerk.BackendAPI.Models.Components;

using Clerk.BackendAPI.Models.Errors;

using Clerk.BackendAPI.Models.Operations;

using System.Collections.Generic;

var sdk = new ClerkBackendApi(bearerAuth: "");

try

{

    VerifyClientRequestBody req = new VerifyClientRequestBody() {

        Token = "jwt_token_example",

    };

    var res = await sdk.Clients.VerifyAsync(req);

    // handle response

}

catch (SDKBaseError ex)  // all SDK exceptions inherit from SDKBaseError

{

    // ex.ToString() provides a detailed error message

    System.Console.WriteLine(ex);

    // Base exception fields

    HttpRequestMessage request = ex.Request;

    HttpResponseMessage response = ex.Response;

    var statusCode = (int)response.StatusCode;

    var responseBody = ex.Body;

    if (ex is ClerkErrors) // different exceptions may be thrown depending on the method

    {

        // Check error data fields

        ClerkErrorsPayload payload = ex.Payload;

        List Errors = payload.Errors;

        Clerk.BackendAPI.Models.Errors.Meta Meta = payload.Meta;

    }

    // An underlying cause may be provided

    if (ex.InnerException != null)

    {

        Exception cause = ex.InnerException;

    }

}

catch (System.Net.Http.HttpRequestException ex)

{

    // Check ex.InnerException for Network connectivity errors

}

```

### Error Classes

**Primary exceptions:**

* [`SDKBaseError`](./src/Clerk/BackendAPI/Models/Errors/SDKBaseError.cs): The base class for HTTP error responses.

  * [`ClerkErrors`](./src/Clerk/BackendAPI/Models/Errors/ClerkErrors.cs): Request was not successful. *

Less common exceptions (29)

* [`System.Net.Http.HttpRequestException`](https://learn.microsoft.com/en-us/dotnet/api/system.net.http.httprequestexception): Network connectivity error. For more details about the underlying cause, inspect the `ex.InnerException`.

* Inheriting from [`SDKBaseError`](./src/Clerk/BackendAPI/Models/Errors/SDKBaseError.cs):

  * [`CreateApiKeyResponseBody`](./src/Clerk/BackendAPI/Models/Errors/CreateApiKeyResponseBody.cs): 400 Bad Request. Status code `400`. Applicable to 1 of 178 methods.*

  * [`GetApiKeysResponseBody`](./src/Clerk/BackendAPI/Models/Errors/GetApiKeysResponseBody.cs): 400 Bad Request. Status code `400`. Applicable to 1 of 178 methods.*

  * [`GetApiKeyResponseBody`](./src/Clerk/BackendAPI/Models/Errors/GetApiKeyResponseBody.cs): 400 Bad Request. Status code `400`. Applicable to 1 of 178 methods.*

  * [`UpdateApiKeyResponseBody`](./src/Clerk/BackendAPI/Models/Errors/UpdateApiKeyResponseBody.cs): 400 Bad Request. Status code `400`. Applicable to 1 of 178 methods.*

  * [`DeleteApiKeyResponseBody`](./src/Clerk/BackendAPI/Models/Errors/DeleteApiKeyResponseBody.cs): 400 Bad Request. Status code `400`. Applicable to 1 of 178 methods.*

  * [`GetApiKeySecretResponseBody`](./src/Clerk/BackendAPI/Models/Errors/GetApiKeySecretResponseBody.cs): 400 Bad Request. Status code `400`. Applicable to 1 of 178 methods.*

  * [`RevokeApiKeyResponseBody`](./src/Clerk/BackendAPI/Models/Errors/RevokeApiKeyResponseBody.cs): 400 Bad Request. Status code `400`. Applicable to 1 of 178 methods.*

  * [`VerifyApiKeyResponseBody`](./src/Clerk/BackendAPI/Models/Errors/VerifyApiKeyResponseBody.cs): 400 Bad Request. Status code `400`. Applicable to 1 of 178 methods.*

  * [`CreateM2MTokenResponseBody`](./src/Clerk/BackendAPI/Models/Errors/CreateM2MTokenResponseBody.cs): 400 Bad Request. Status code `400`. Applicable to 1 of 178 methods.*

  * [`GetM2MTokensResponseBody`](./src/Clerk/BackendAPI/Models/Errors/GetM2MTokensResponseBody.cs): 400 Bad Request. Status code `400`. Applicable to 1 of 178 methods.*

  * [`RevokeM2MTokenResponseBody`](./src/Clerk/BackendAPI/Models/Errors/RevokeM2MTokenResponseBody.cs): 400 Bad Request. Status code `400`. Applicable to 1 of 178 methods.*

  * [`VerifyM2MTokenResponseBody`](./src/Clerk/BackendAPI/Models/Errors/VerifyM2MTokenResponseBody.cs): 400 Bad Request. Status code `400`. Applicable to 1 of 178 methods.*

  * [`VerifyOAuthAccessTokenResponseBody`](./src/Clerk/BackendAPI/Models/Errors/VerifyOAuthAccessTokenResponseBody.cs): 400 Bad Request. Status code `400`. Applicable to 1 of 178 methods.*

  * [`GetM2MTokensM2mResponseBody`](./src/Clerk/BackendAPI/Models/Errors/GetM2MTokensM2mResponseBody.cs): 403 Forbidden. Status code `403`. Applicable to 1 of 178 methods.*

  * [`GetAPIKeysAPIKeysResponseBody`](./src/Clerk/BackendAPI/Models/Errors/GetAPIKeysAPIKeysResponseBody.cs): 404 Not Found. Status code `404`. Applicable to 1 of 178 methods.*

  * [`GetAPIKeyAPIKeysResponseBody`](./src/Clerk/BackendAPI/Models/Errors/GetAPIKeyAPIKeysResponseBody.cs): 404 Not Found. Status code `404`. Applicable to 1 of 178 methods.*

  * [`UpdateAPIKeyAPIKeysResponseBody`](./src/Clerk/BackendAPI/Models/Errors/UpdateAPIKeyAPIKeysResponseBody.cs): 404 Not Found. Status code `404`. Applicable to 1 of 178 methods.*

  * [`DeleteAPIKeyAPIKeysResponseBody`](./src/Clerk/BackendAPI/Models/Errors/DeleteAPIKeyAPIKeysResponseBody.cs): 404 Not Found. Status code `404`. Applicable to 1 of 178 methods.*

  * [`GetAPIKeySecretAPIKeysResponseBody`](./src/Clerk/BackendAPI/Models/Errors/GetAPIKeySecretAPIKeysResponseBody.cs): 404 Not Found. Status code `404`. Applicable to 1 of 178 methods.*

  * [`RevokeAPIKeyAPIKeysResponseBody`](./src/Clerk/BackendAPI/Models/Errors/RevokeAPIKeyAPIKeysResponseBody.cs): 404 Not Found. Status code `404`. Applicable to 1 of 178 methods.*

  * [`VerifyAPIKeyAPIKeysResponseBody`](./src/Clerk/BackendAPI/Models/Errors/VerifyAPIKeyAPIKeysResponseBody.cs): 404 Not Found. Status code `404`. Applicable to 1 of 178 methods.*

  * [`GetM2MTokensM2mResponseResponseBody`](./src/Clerk/BackendAPI/Models/Errors/GetM2MTokensM2mResponseResponseBody.cs): 404 Not Found. Status code `404`. Applicable to 1 of 178 methods.*

  * [`RevokeM2MTokenM2mResponseBody`](./src/Clerk/BackendAPI/Models/Errors/RevokeM2MTokenM2mResponseBody.cs): 404 Not Found. Status code `404`. Applicable to 1 of 178 methods.*

  * [`VerifyM2MTokenM2mResponseBody`](./src/Clerk/BackendAPI/Models/Errors/VerifyM2MTokenM2mResponseBody.cs): 404 Not Found. Status code `404`. Applicable to 1 of 178 methods.*

  * [`VerifyOAuthAccessTokenOauthAccessTokensResponseBody`](./src/Clerk/BackendAPI/Models/Errors/VerifyOAuthAccessTokenOauthAccessTokensResponseBody.cs): 404 Not Found. Status code `404`. Applicable to 1 of 178 methods.*

  * [`CreateAPIKeyAPIKeysResponseBody`](./src/Clerk/BackendAPI/Models/Errors/CreateAPIKeyAPIKeysResponseBody.cs): 409 Conflict. Status code `409`. Applicable to 1 of 178 methods.*

  * [`CreateM2MTokenM2mResponseBody`](./src/Clerk/BackendAPI/Models/Errors/CreateM2MTokenM2mResponseBody.cs): 409 Conflict. Status code `409`. Applicable to 1 of 178 methods.*

  * [`ResponseValidationError`](./src/Clerk/BackendAPI/Models/Errors/ResponseValidationError.cs): Thrown when the response data could not be deserialized into the expected type.

\* Refer to the [relevant documentation](#available-resources-and-operations) to determine whether an exception applies to a specific operation.

## Server Selection

### Override Server URL Per-Client

The default server can be overridden globally by passing a URL to the `serverUrl: string` optional parameter when initializing the SDK client instance. For example:

```csharp

using Clerk.BackendAPI;

using Clerk.BackendAPI.Models.Operations;

var sdk = new ClerkBackendApi(serverUrl: "https://api.clerk.com/v1");

GetPublicInterstitialRequest req = new GetPublicInterstitialRequest() {

    FrontendApiQueryParameter = "frontend-api_1a2b3c4d",

    FrontendApiQueryParameter1 = "pub_1a2b3c4d",

};

var res = await sdk.Miscellaneous.GetPublicInterstitialAsync(req);

// handle response

```

## Custom HTTP Client

The C# SDK makes API calls using an `ISpeakeasyHttpClient` that wraps the native

[HttpClient](https://docs.microsoft.com/en-us/dotnet/api/system.net.http.httpclient). This

client provides the ability to attach hooks around the request lifecycle that can be used to modify the request or handle

errors and response.

The `ISpeakeasyHttpClient` interface allows you to either use the default `SpeakeasyHttpClient` that comes with the SDK,

or provide your own custom implementation with customized configuration such as custom message handlers, timeouts,

connection pooling, and other HTTP client settings.

The following example shows how to create a custom HTTP client with request modification and error handling:

```csharp

using Clerk.BackendAPI;

using Clerk.BackendAPI.Utils;

using System.Net.Http;

using System.Threading;

using System.Threading.Tasks;

// Create a custom HTTP client

public class CustomHttpClient : ISpeakeasyHttpClient

{

    private readonly ISpeakeasyHttpClient _defaultClient;

    public CustomHttpClient()

    {

        _defaultClient = new SpeakeasyHttpClient();

    }

    public async Task SendAsync(HttpRequestMessage request, CancellationToken? cancellationToken = null)

    {

        // Add custom header and timeout

        request.Headers.Add("x-custom-header", "custom value");

        request.Headers.Add("x-request-timeout", "30");

        

        try

        {

            var response = await _defaultClient.SendAsync(request, cancellationToken);

            // Log successful response

            Console.WriteLine($"Request successful: {response.StatusCode}");

            return response;

        }

        catch (Exception error)

        {

            // Log error

            Console.WriteLine($"Request failed: {error.Message}");

            throw;

        }

    }

    public void Dispose()

    {

        _httpClient?.Dispose();

        _defaultClient?.Dispose();

    }

}

// Use the custom HTTP client with the SDK

var customHttpClient = new CustomHttpClient();

var sdk = new ClerkBackendApi(client: customHttpClient);

```

You can also provide a completely custom HTTP client with your own configuration:

```csharp

using Clerk.BackendAPI.Utils;

using System.Net.Http;

using System.Threading;

using System.Threading.Tasks;

// Custom HTTP client with custom configuration

public class AdvancedHttpClient : ISpeakeasyHttpClient

{

    private readonly HttpClient _httpClient;

    public AdvancedHttpClient()

    {

        var handler = new HttpClientHandler()

        {

            MaxConnectionsPerServer = 10,

            // ServerCertificateCustomValidationCallback = customCertValidation, // Custom SSL validation if needed

        };

        _httpClient = new HttpClient(handler)

        {

            Timeout = TimeSpan.FromSeconds(30)

        };

    }

    public async Task SendAsync(HttpRequestMessage request, CancellationToken? cancellationToken = null)

    {

        return await _httpClient.SendAsync(request, cancellationToken ?? CancellationToken.None);

    }

    public void Dispose()

    {

        _httpClient?.Dispose();

    }

}

var sdk = ClerkBackendApi.Builder()

    .WithClient(new AdvancedHttpClient())

    .Build();

```

For simple debugging, you can enable request/response logging by implementing a custom client:

```csharp

public class LoggingHttpClient : ISpeakeasyHttpClient

{

    private readonly ISpeakeasyHttpClient _innerClient;

    public LoggingHttpClient(ISpeakeasyHttpClient innerClient = null)

    {

        _innerClient = innerClient ?? new SpeakeasyHttpClient();

    }

    public async Task SendAsync(HttpRequestMessage request, CancellationToken? cancellationToken = null)

    {

        // Log request

        Console.WriteLine($"Sending {request.Method} request to {request.RequestUri}");

        

        var response = await _innerClient.SendAsync(request, cancellationToken);

        

        // Log response

        Console.WriteLine($"Received {response.StatusCode} response");

        

        return response;

    }

    public void Dispose() => _innerClient?.Dispose();

}

var sdk = new ClerkBackendApi(client: new LoggingHttpClient());

```

The SDK also provides built-in hook support through the `SDKConfiguration.Hooks` system, which automatically handles

`BeforeRequestAsync`, `AfterSuccessAsync`, and `AfterErrorAsync` hooks for advanced request lifecycle management.

# 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.

## Contributions

While we value open-source contributions to this SDK, this library is generated programmatically. Any manual changes added to internal files will be overwritten on the next generation. 

We look forward to hearing your feedback. Feel free to open a PR or an issue with a proof of concept and we'll do our best to include it in a future release. 

### SDK Created by [Speakeasy](https://www.speakeasy.com/?utm_source=openapi-clerk-backend-api-sdk-clerk-backend-api-sd-ksas&utm_campaign=csharp)
ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/clerk/clerk-sdk-csharp

Awesome Lists containing this project

README
