• management
• SDK
• SigningClient

Class SigningClient

Index

Constructors

constructor

Methods

listrotategetrevoke

Properties

_options

Constructors

constructor

new SigningClient(options: BaseClientOptions): SigningClient

Parameters

• options: BaseClientOptions

Returns SigningClient

Methods

list

list(
requestOptions?: SigningClient.RequestOptions,
): HttpResponsePromise<SigningKeys[]>

Retrieve details of all the application signing keys associated with your tenant.

Parameters

• OptionalrequestOptions: SigningClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<SigningKeys[]>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.keys.signing.list()Copy

rotate

rotate(
requestOptions?: SigningClient.RequestOptions,
): HttpResponsePromise<RotateSigningKeysResponseContent>

Rotate the application signing key of your tenant.

Parameters

• OptionalrequestOptions: SigningClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<RotateSigningKeysResponseContent>

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.keys.signing.rotate()Copy

get

get(
kid: string,
requestOptions?: SigningClient.RequestOptions,
): HttpResponsePromise<GetSigningKeysResponseContent>

Retrieve details of the application signing key with the given ID.

Parameters

• kid: string

Key id of the key to retrieve

• OptionalrequestOptions: SigningClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<GetSigningKeysResponseContent>

Throws

Management.BadRequestError

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.TooManyRequestsError

Example

await client.keys.signing.get("kid")Copy

revoke

revoke(
kid: string,
requestOptions?: SigningClient.RequestOptions,
): HttpResponsePromise<RevokedSigningKeysResponseContent>

Revoke the application signing key with the given ID.

Parameters

• kid: string

Key id of the key to revoke

• OptionalrequestOptions: SigningClient.RequestOptions

Request-specific configuration.

Returns HttpResponsePromise<RevokedSigningKeysResponseContent>

Throws

Management.UnauthorizedError

Throws

Management.ForbiddenError

Throws

Management.NotFoundError

Throws

Management.TooManyRequestsError

Example

await client.keys.signing.revoke("kid")Copy

Properties

Protected Readonly_options

_options: NormalizedClientOptionsWithAuth<BaseClientOptions>

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Constructors constructor Methods listrotategetrevoke Properties _options