Interface APIKey

interface APIKey {
    accessKey: string;
    applicationId?: string;
    createdAt?: Date;
    creationIp: string;
    defaultProjectId: string;
    deletable: boolean;
    description: string;
    editable: boolean;
    expiresAt?: Date;
    managed: boolean;
    secretKey?: string;
    updatedAt?: Date;
    userId?: string;
}

Properties

accessKey applicationId? createdAt? creationIp defaultProjectId deletable description editable expiresAt? managed secretKey? updatedAt? userId?

Properties

accessKey

accessKey: string

Access key of the API key.

OptionalapplicationId

applicationId?: string

ID of application that bears the API key.

One-of ('bearer'): at most one of 'applicationId', 'userId' could be set.

OptionalcreatedAt

createdAt?: Date

Date and time of API key creation.

creationIp

creationIp: string

IP address of the device that created the API key.

defaultProjectId

defaultProjectId: string

Default Project ID specified for this API key.

deletable

deletable: boolean

Defines whether or not the API key is deletable.

description

description: string

Description of API key.

editable

editable: boolean

Defines whether or not the API key is editable.

OptionalexpiresAt

expiresAt?: Date

Date and time of API key expiration.

managed

managed: boolean

Defines whether or not the API key is managed.

OptionalsecretKey

secretKey?: string

Secret key of the API Key.

OptionalupdatedAt

updatedAt?: Date

Date and time of last API key update.

OptionaluserId

userId?: string

ID of user that bears the API key.

One-of ('bearer'): at most one of 'applicationId', 'userId' could be set.

Settings

On This Page

Properties