README.md

InstanceSettings

(instanceSettings)

Overview

Available Operations

• getInstance - Fetch the current instance
• update - Update instance settings
• updateOrganizationSettings - Update instance organization settings
• updateRestrictions - Update instance restrictions

getInstance

Fetches the current instance

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

use Clerk\Backend;

$sdk = Backend\ClerkBackend::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();



$response = $sdk->instanceSettings->getInstance(

);

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

Response

?Operations\GetInstanceResponse

Errors

Error Type	Status Code	Content Type
Errors\SDKException	4XX, 5XX	*/*

update

Updates the settings of an instance

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

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

$sdk = Backend\ClerkBackend::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();

$request = new Operations\UpdateInstanceRequestBody();

$response = $sdk->instanceSettings->update(
    request: $request
);

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

Parameters

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

Response

?Operations\UpdateInstanceResponse

Errors

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

updateOrganizationSettings

Updates the organization settings of the instance

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

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

$sdk = Backend\ClerkBackend::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();

$request = new Operations\UpdateInstanceOrganizationSettingsRequestBody();

$response = $sdk->instanceSettings->updateOrganizationSettings(
    request: $request
);

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

Parameters

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

Response

?Operations\UpdateInstanceOrganizationSettingsResponse

Errors

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

updateRestrictions

Updates the restriction settings of an instance

Example Usage

declare(strict_types=1);

require 'vendor/autoload.php';

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

$sdk = Backend\ClerkBackend::builder()
    ->setSecurity(
        '<YOUR_BEARER_TOKEN_HERE>'
    )
    ->build();

$request = new Operations\UpdateInstanceRestrictionsRequestBody();

$response = $sdk->instanceSettings->updateRestrictions(
    request: $request
);

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

Parameters

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

Response

?Operations\UpdateInstanceRestrictionsResponse

Errors

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