Class ApplicationApiKeysClient

sdk.applications.apiKeys — per-application API keys for app auth.

Index

Constructors

Methods

create delete list

Constructors

constructor

new ApplicationApiKeysClient(call: Caller): ApplicationApiKeysClient
Parameters
- call: Caller
Returns ApplicationApiKeysClient
- Defined in src/resources/applications.ts:647

Methods

create

create(
params: { applicationId: string; expiresAt?: string; name: string },
opts?: RequestOptions,
): Promise<CreateApplicationApiKeyResult>
The plaintext key on the result is only ever returned here.
Parameters
- params: { applicationId: string; expiresAt?: string; name: string }
- Optionalopts: RequestOptions
Returns Promise<CreateApplicationApiKeyResult>
- Defined in src/resources/applications.ts:659

delete

delete(
params: { applicationId: string; keyId: string },
opts?: RequestOptions,
): Promise<void>
Delete (revoke) an API key.
Parameters
- params: { applicationId: string; keyId: string }
- Optionalopts: RequestOptions
Returns Promise<void>
Throws
NotFoundError if the application or key does not exist.
- Defined in src/resources/applications.ts:680

list

list(
params: { applicationId: string },
opts?: RequestOptions,
): Promise<ApplicationApiKeySummary[]>
List an application's API keys (key hashes withheld).
Parameters
- params: { applicationId: string }
- Optionalopts: RequestOptions
Returns Promise<ApplicationApiKeySummary[]>
- Defined in src/resources/applications.ts:650