Skip to content

Latest commit

 

History

History
158 lines (99 loc) · 8.68 KB

README.md

File metadata and controls

158 lines (99 loc) · 8.68 KB
Raw

BetaFeatures

(betaFeatures)

Overview

Available Operations

updateInstanceSettings

Updates the settings of an instance

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Clerk\Backend;
use Clerk\Backend\Models\Operations;

$security = '<YOUR_BEARER_TOKEN_HERE>';

$sdk = Backend\ClerkBackend::builder()->setSecurity($security)->build();

$request = new Operations\UpdateInstanceAuthConfigRequestBody();

$response = $sdk->betaFeatures->updateInstanceSettings(
    request: $request
);

if ($response->instanceSettings !== null) {
    // handle response
}

Parameters

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

Response

?Operations\UpdateInstanceAuthConfigResponse

Errors

Error Type Status Code Content Type
Errors\ClerkErrors51 402, 422 application/json
Errors\SDKException 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

declare(strict_types=1);

require 'vendor/autoload.php';

use Clerk\Backend;
use Clerk\Backend\Models\Operations;

$security = '<YOUR_BEARER_TOKEN_HERE>';

$sdk = Backend\ClerkBackend::builder()->setSecurity($security)->build();

$request = new Operations\UpdateProductionInstanceDomainRequestBody();

$response = $sdk->betaFeatures->updateDomain(
    request: $request
);

if ($response->statusCode === 200) {
    // handle response
}

Parameters

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

Response

?Operations\UpdateProductionInstanceDomainResponse

Errors

Error Type Status Code Content Type
Errors\ClerkErrors52 400, 422 application/json
Errors\SDKException 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

declare(strict_types=1);

require 'vendor/autoload.php';

use Clerk\Backend;
use Clerk\Backend\Models\Operations;

$security = '<YOUR_BEARER_TOKEN_HERE>';

$sdk = Backend\ClerkBackend::builder()->setSecurity($security)->build();

$request = new Operations\ChangeProductionInstanceDomainRequestBody();

$response = $sdk->betaFeatures->changeProductionInstanceDomain(
    request: $request
);

if ($response->statusCode === 200) {
    // handle response
}

Parameters

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

Response

?Operations\ChangeProductionInstanceDomainResponse

Errors

Error Type Status Code Content Type
Errors\ClerkErrors60 400, 422 application/json
Errors\SDKException 4XX, 5XX */*