• management
• SDK
• CustomSigningClient

Class CustomSigningClient

Index

Constructors

constructor

Methods

getsetdelete

Properties

_options

Constructors

constructor

new CustomSigningClient(options: BaseClientOptions): CustomSigningClient

Parameters

• options: BaseClientOptions

Returns CustomSigningClient

Methods

get

get(
requestOptions?: CustomSigningClient.RequestOptions,
): HttpResponsePromise<GetCustomSigningKeysResponseContent>

Get entire jwks representation of custom signing keys.

Parameters

• OptionalrequestOptions: CustomSigningClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<GetCustomSigningKeysResponseContent>

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.keys.customSigning.get()Copy

set

set(
request: SetCustomSigningKeysRequestContent,
requestOptions?: CustomSigningClient.RequestOptions,
): HttpResponsePromise<SetCustomSigningKeysResponseContent>

Create or replace entire jwks representation of custom signing keys.

Parameters

• request: SetCustomSigningKeysRequestContent
• OptionalrequestOptions: CustomSigningClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<SetCustomSigningKeysResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.keys.customSigning.set({ keys: [{ kty: "EC" }] })Copy

delete

delete(
requestOptions?: CustomSigningClient.RequestOptions,
): HttpResponsePromise<void>

Delete entire jwks representation of custom signing keys.

Parameters

• OptionalrequestOptions: CustomSigningClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<void>

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.keys.customSigning.delete()Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods getsetdelete Properties _options