Class KeysManager

Hierarchy

BaseAPI
- KeysManager

Index

Constructors

Properties

Methods

get getAll postEncryptionRekey request revoke rotate

Constructors

constructor

new KeysManager(configuration): KeysManager
Parameters
- configuration: Configuration
Returns KeysManager
Inherited from BaseAPI.constructor
- Defined in src/lib/runtime.ts:24

Properties

`Protected` configuration

configuration: Configuration

Methods

get

get(requestParameters, initOverrides?): Promise<ApiResponse<GetSigningKeys200ResponseInner>>
Get an Application Signing Key by its key id

Throws
Parameters
- requestParameters: GetSigningKeyRequest
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<GetSigningKeys200ResponseInner>>
- Defined in src/management/__generated/managers/keys-manager.ts:22

getAll

getAll(initOverrides?): Promise<ApiResponse<GetSigningKeys200ResponseInner[]>>
Get all Application Signing Keys

Throws
Parameters
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<GetSigningKeys200ResponseInner[]>>
- Defined in src/management/__generated/managers/keys-manager.ts:47

postEncryptionRekey

postEncryptionRekey(initOverrides?): Promise<ApiResponse<void>>
Perform rekeying operation on the key hierarchy. Rekey the key hierarchy

Throws
Parameters
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<void>>
- Defined in src/management/__generated/managers/keys-manager.ts:67

`Protected` request

request(context, initOverrides?): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit | InitOverrideFunction
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in src/lib/runtime.ts:40

revoke

revoke(requestParameters, initOverrides?): Promise<ApiResponse<PutSigningKeys200Response>>
Revoke an Application Signing Key by its key id

Throws
Parameters
- requestParameters: PutSigningKeysRequest
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<PutSigningKeys200Response>>
- Defined in src/management/__generated/managers/keys-manager.ts:101

rotate

rotate(initOverrides?): Promise<ApiResponse<PostSigningKeys201Response>>
Rotate the Application Signing Key

Throws
Parameters
- Optional initOverrides: InitOverride
Returns Promise<ApiResponse<PostSigningKeys201Response>>
- Defined in src/management/__generated/managers/keys-manager.ts:84