Class ApiKeysSecretClient

ApiKeysSecretClient manages API key secrets, providing methods for retrieval, creation, and deletion of API keys.

Index

Methods

delete get getAll upsert

Methods

delete

delete(key: string): Promise<void>
Deletes a specified API key.
Parameters
- key: string
  The key of the API key to delete.
Returns Promise<void>
A promise resolving once deletion is complete.

get

get(key: string): Promise<undefined | SecretEntry<SecretValue>>
Retrieves a stored API key by its key.
Parameters
- key: string
  The API key to retrieve.
Returns Promise<undefined | SecretEntry<SecretValue>>
A promise resolving to the secret entry or undefined if not found.

getAll

getAll(): Promise<Record<string, SecretEntry<SecretValue>>>
Retrieves all secrets.

Returns Promise<Record<string, SecretEntry<SecretValue>>>
A promise resolving to a record of all stored secret entries.

upsert

upsert(key: string): Promise<SecretEntry<SecretValue>>
Inserts a new API key or updates an existing one with a new autogenerated value. Returns the created secret.
Parameters
- key: string
Returns Promise<SecretEntry<SecretValue>>