ESPRMAdminKey
Defined in: src/ESPRMAdminKey.ts:11
Shell class for admin key management operations. Methods are added via prototype augmentation in methods/ESPRMAdminKey/*.
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ESPRMAdminKey():
ESPRMAdminKey
Returns
Section titled “Returns”ESPRMAdminKey
Methods
Section titled “Methods”createKey()
Section titled “createKey()”createKey(
params):Promise<CreateKeyResponse>
Defined in: src/methods/ESPRMAdminKey/CreateKey.ts:27
Creates a new admin key with the specified name and configuration.
Parameters
Section titled “Parameters”params
Section titled “params”The key name and optional configuration for the new key.
Returns
Section titled “Returns”Promise<CreateKeyResponse>
The created key details including the key ID.
getKeys()
Section titled “getKeys()”getKeys(
params?):Promise<GetKeysResponse>
Defined in: src/methods/ESPRMAdminKey/GetKeys.ts:21
Retrieves the list of admin keys with optional filtering and pagination.
Parameters
Section titled “Parameters”params?
Section titled “params?”Optional query parameters to filter keys.
Returns
Section titled “Returns”Promise<GetKeysResponse>
Paginated key list and next cursor when applicable.