Skip to content

README.md

Latest commit

 

History

History
257 lines (167 loc) · 10.8 KB

README.md

File metadata and controls

257 lines (167 loc) · 10.8 KB

JwtTemplates

Overview

Available Operations

  • list - List all templates
  • create - Create a JWT template
  • get - Retrieve a template
  • update - Update a JWT template
  • delete - Delete a Template

list

List all templates

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->jwtTemplates->list(
    limit: 10,
    offset: 0

);

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

Parameters

Parameter Type Required Description
paginated ?bool ➖ Whether to paginate the results.
If true, the results will be paginated.
If false, the results will not be paginated.
limit ?int ➖ Applies a limit to the number of results returned.
Can be used for paginating the results together with offset.
offset ?int ➖ Skip the first offset results when paginating.
Needs to be an integer greater or equal to zero.
To be used in conjunction with limit.

Response

?Operations\ListJWTTemplatesResponse

Errors

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

create

Create a new JWT template

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->jwtTemplates->create(
    request: $request
);

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

Parameters

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

Response

?Operations\CreateJWTTemplateResponse

Errors

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

get

Retrieve the details of a given JWT template

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->jwtTemplates->get(
    templateId: '<id>'
);

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

Parameters

Parameter Type Required Description
templateId string ✔️ JWT Template ID

Response

?Operations\GetJWTTemplateResponse

Errors

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

update

Updates an existing JWT template

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->jwtTemplates->update(
    templateId: '<id>',
    requestBody: $requestBody

);

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

Parameters

Parameter Type Required Description
templateId string ✔️ The ID of the JWT template to update
requestBody ?Operations\UpdateJWTTemplateRequestBody ➖ N/A

Response

?Operations\UpdateJWTTemplateResponse

Errors

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

delete

Delete a Template

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->jwtTemplates->delete(
    templateId: '<id>'
);

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

Parameters

Parameter Type Required Description
templateId string ✔️ JWT Template ID

Response

?Operations\DeleteJWTTemplateResponse

Errors

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