Class ApiKeyService

API key service

Hierarchy (View Summary)

BaseService
- ApiKeyService

Index

Constructors

Properties

apiClient axiosInstance

Methods

create delete get list update

Constructors

constructor

new ApiKeyService(apiClient: Client): ApiKeyService
Constructor
Parameters
- apiClient: Client
  API client
Returns ApiKeyService
Inherited from BaseService.constructor
- Defined in services/BaseService.ts:42

Properties

`Protected` `Readonly`apiClient

apiClient: Client

`Protected` `Readonly`axiosInstance

axiosInstance: AxiosInstance

Methods

create

create(key: ApiKeyConfig): Promise<ApiKeyCreated>
Creates new API key
Parameters
- key: ApiKeyConfig
  API key configuration to create
Returns Promise<ApiKeyCreated>
Created API key
- Defined in services/Security/ApiKeyService.ts:47

delete

delete(id: number): Promise<void>
Deletes the API key
Parameters
- id: number
  API key ID
Returns Promise<void>
- Defined in services/Security/ApiKeyService.ts:77

get

get(id: number): Promise<ApiKeyInfo>
Retrieves information about the API key
Parameters
- id: number
  API key ID
Returns Promise<ApiKeyInfo>
API key information
- Defined in services/Security/ApiKeyService.ts:58

list

list(): Promise<ApiKeyInfo[]>
Retrieves list of API keys

Returns Promise<ApiKeyInfo[]>
List of API keys
- Defined in services/Security/ApiKeyService.ts:36

update

update(id: number, config: ApiKeyConfig): Promise<void>
Updates the API key
Parameters
- id: number
  API key ID
- config: ApiKeyConfig
  API key configuration to edit
Returns Promise<void>
- Defined in services/Security/ApiKeyService.ts:69