Class ApiKey

Implements

ApiKeyAttributes

Index

Constructors

Properties

allowed_ips created_at description identifier last_used_at secret?

Methods

Constructors

constructor

new ApiKey(userClient: UserClient, apiKeyProps: RawApiKey): ApiKey
Parameters
- userClient: UserClient
- apiKeyProps: RawApiKey
Returns ApiKey
- Defined in src/UserClient/ApiKey.ts:13

Properties

`Readonly`allowed_ips

allowed_ips: string[]

`Readonly`created_at

created_at: Date

`Readonly`description

description: string

`Readonly`identifier

identifier: string

`Readonly`last_used_at

last_used_at: Date

`Optional` `Readonly`secret

secret?: string

Methods

delete

delete(): Promise<void>
Delete this api key from this account

Returns Promise<void>
Throws
Unknown api key error
- Defined in src/UserClient/ApiKey.ts:27