README.md

BetaFeatures

(BetaFeatures)

Overview

Available Operations

• UpdateInstanceSettings - Update instance settings
• UpdateDomain - Update production instance domain ⚠️ Deprecated
• ChangeProductionInstanceDomain - Update production instance domain

UpdateInstanceSettings

Updates the settings of an instance

Example Usage

using Clerk.BackendAPI;
using Clerk.BackendAPI.Models.Components;
using Clerk.BackendAPI.Models.Operations;

var sdk = new ClerkBackendApi(bearerAuth: "<YOUR_BEARER_TOKEN_HERE>");

UpdateInstanceAuthConfigRequestBody req = new UpdateInstanceAuthConfigRequestBody() {
    RestrictedToAllowlist = false,
    FromEmailAddress = "noreply",
    ProgressiveSignUp = true,
    SessionTokenTemplate = "defaultSessionToken",
    EnhancedEmailDeliverability = true,
    TestMode = true,
};

var res = await sdk.BetaFeatures.UpdateInstanceSettingsAsync(req);

// handle response

Parameters

Parameter	Type	Required	Description
request	UpdateInstanceAuthConfigRequestBody	✔️	The request object to use for the request.

Response

UpdateInstanceAuthConfigResponse

Errors

Error Type	Status Code	Content Type
Clerk.BackendAPI.Models.Errors.ClerkErrors	402, 422	application/json
Clerk.BackendAPI.Models.Errors.SDKError	4XX, 5XX	*/*

UpdateDomain

Change the domain of a production instance.

Changing the domain requires updating the DNS records accordingly, deploying new SSL certificates, updating your Social Connection's redirect URLs and setting the new keys in your code.

WARNING: Changing your domain will invalidate all current user sessions (i.e. users will be logged out). Also, while your application is being deployed, a small downtime is expected to occur.

⚠️ DEPRECATED: This will be removed in a future release, please migrate away from it as soon as possible.

Example Usage

using Clerk.BackendAPI;
using Clerk.BackendAPI.Models.Components;
using Clerk.BackendAPI.Models.Operations;

var sdk = new ClerkBackendApi(bearerAuth: "<YOUR_BEARER_TOKEN_HERE>");

UpdateProductionInstanceDomainRequestBody req = new UpdateProductionInstanceDomainRequestBody() {
    HomeUrl = "https://www.example.com",
};

var res = await sdk.BetaFeatures.UpdateDomainAsync(req);

// handle response

Parameters

Parameter	Type	Required	Description
request	UpdateProductionInstanceDomainRequestBody	✔️	The request object to use for the request.

Response

UpdateProductionInstanceDomainResponse

Errors

Error Type	Status Code	Content Type
Clerk.BackendAPI.Models.Errors.ClerkErrors	400, 422	application/json
Clerk.BackendAPI.Models.Errors.SDKError	4XX, 5XX	*/*

ChangeProductionInstanceDomain

Change the domain of a production instance.

Changing the domain requires updating the DNS records accordingly, deploying new SSL certificates, updating your Social Connection's redirect URLs and setting the new keys in your code.

WARNING: Changing your domain will invalidate all current user sessions (i.e. users will be logged out). Also, while your application is being deployed, a small downtime is expected to occur.

Example Usage

using Clerk.BackendAPI;
using Clerk.BackendAPI.Models.Components;
using Clerk.BackendAPI.Models.Operations;

var sdk = new ClerkBackendApi(bearerAuth: "<YOUR_BEARER_TOKEN_HERE>");

ChangeProductionInstanceDomainRequestBody req = new ChangeProductionInstanceDomainRequestBody() {
    HomeUrl = "https://www.newdomain.com",
};

var res = await sdk.BetaFeatures.ChangeProductionInstanceDomainAsync(req);

// handle response

Parameters

Parameter	Type	Required	Description
request	ChangeProductionInstanceDomainRequestBody	✔️	The request object to use for the request.

Response

ChangeProductionInstanceDomainResponse

Errors

Error Type	Status Code	Content Type
Clerk.BackendAPI.Models.Errors.ClerkErrors	400, 422	application/json
Clerk.BackendAPI.Models.Errors.SDKError	4XX, 5XX	*/*