Class ApiKeysResource

Operations for managing API keys within a project. Accessed via AdminClient.apiKeys.

Index

Constructors

Methods

create delete describe list update

Constructors

constructor

new ApiKeysResource(api: APIKeysApi): ApiKeysResource
Parameters
- api: APIKeysApi
Returns ApiKeysResource
- Defined in src/admin/resources/apiKeys.ts:31

Methods

create

create(
projectId: string,
options: CreateAPIKeyRequest,
): Promise<APIKeyWithSecret>
Create a new API key within a project. The returned APIKeyWithSecret contains the key's secret value, which is returned only once and cannot be retrieved later.
Parameters
- projectId: string
- options: CreateAPIKeyRequest
Returns Promise<APIKeyWithSecret>
- Defined in src/admin/resources/apiKeys.ts:39

delete

delete(apiKeyId: string): Promise<void>
Delete an API key by ID.
Parameters
- apiKeyId: string
Returns Promise<void>
- Defined in src/admin/resources/apiKeys.ts:104

describe

describe(apiKeyId: string): Promise<APIKey>
Get an API key's details by ID.
Parameters
- apiKeyId: string
Returns Promise<APIKey>
- Defined in src/admin/resources/apiKeys.ts:61

list

list(projectId: string): Promise<ListApiKeysResponse>
List all API keys within a project.
Parameters
- projectId: string
Returns Promise<ListApiKeysResponse>
- Defined in src/admin/resources/apiKeys.ts:74

update

update(apiKeyId: string, options: UpdateAPIKeyRequest): Promise<APIKey>
Update an existing API key by ID.
Parameters
- apiKeyId: string
- options: UpdateAPIKeyRequest
Returns Promise<APIKey>
- Defined in src/admin/resources/apiKeys.ts:87