Skip to main content
Version: 1.21.x

Token

Defined in: messages/Token.ts:114

Information about an access token

Constructors​

Constructor​

> new Token(): Token

Returns​

Token

Properties​

createdAt​

> readonly createdAt: number = 0

Defined in: messages/Token.ts:123

Creation time of the token as unix timestamp in milliseconds

expiresAt?​

> readonly optional expiresAt: number

Defined in: messages/Token.ts:143

Expiration time as unix timestamp in milliseconds

ipAllowlist?​

> readonly optional ipAllowlist: string[]

Defined in: messages/Token.ts:148

List of IP addresses and CIDR ranges allowed to use the token

isExpired?​

> readonly optional isExpired: boolean

Defined in: messages/Token.ts:138

True if the token is expired

isProvisioned?​

> readonly optional isProvisioned: boolean = false

Defined in: messages/Token.ts:153

Is the token provisioned, and you can't remove it or change it

lastAccess?​

> readonly optional lastAccess: number

Defined in: messages/Token.ts:128

Last access time of the token as unix timestamp in milliseconds

name​

> readonly name: string = ""

Defined in: messages/Token.ts:118

Name of the token

permissions?​

> readonly optional permissions: TokenPermissions

Defined in: messages/Token.ts:158

Permissions of the token

ttl?​

> readonly optional ttl: number

Defined in: messages/Token.ts:133

Time to live in seconds

Methods​

parse()​

> static parse(data): Token

Defined in: messages/Token.ts:160

Parameters​

data​

OriginalTokenInfo

Returns​

Token