Skip to content

Files

Latest commit

 

History

History
206 lines (137 loc) · 11.9 KB

README.md

File metadata and controls

206 lines (137 loc) · 11.9 KB

JwtTemplates

(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

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

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

var res = await sdk.JwtTemplates.ListAsync(
    paginated: false,
    limit: 20,
    offset: 10
);

// handle response

Parameters

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

Response

ListJWTTemplatesResponse

Errors

Error Type Status Code Content Type
Clerk.BackendAPI.Models.Errors.SDKError 4XX, 5XX */*

Create

Create a new JWT template

Example Usage

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

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

CreateJWTTemplateRequestBody req = new CreateJWTTemplateRequestBody() {
    Name = "Example Template",
    Claims = new Models.Operations.Claims() {},
    Lifetime = 3600D,
    AllowedClockSkew = 5D,
    CustomSigningKey = false,
    SigningAlgorithm = "RS256",
    SigningKey = "PRIVATE_KEY_PLACEHOLDER",
};

var res = await sdk.JwtTemplates.CreateAsync(req);

// handle response

Parameters

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

Response

CreateJWTTemplateResponse

Errors

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

Get

Retrieve the details of a given JWT template

Example Usage

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

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

var res = await sdk.JwtTemplates.GetAsync(templateId: "template_123");

// handle response

Parameters

Parameter Type Required Description Example
TemplateId string ✔️ JWT Template ID template_123

Response

GetJWTTemplateResponse

Errors

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

Update

Updates an existing JWT template

Example Usage

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

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

var res = await sdk.JwtTemplates.UpdateAsync(
    templateId: "<id>",
    requestBody: new UpdateJWTTemplateRequestBody() {
        Name = "<value>",
        Claims = new UpdateJWTTemplateClaims() {},
    }
);

// handle response

Parameters

Parameter Type Required Description
TemplateId string ✔️ The ID of the JWT template to update
RequestBody UpdateJWTTemplateRequestBody ➖ N/A

Response

UpdateJWTTemplateResponse

Errors

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

Delete

Delete a Template

Example Usage

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

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

var res = await sdk.JwtTemplates.DeleteAsync(templateId: "<id>");

// handle response

Parameters

Parameter Type Required Description
TemplateId string ✔️ JWT Template ID

Response

DeleteJWTTemplateResponse

Errors

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