Table of Contents

> Token object

The following objects are directly related to the token API.

Token

The token object has the following properties.

Property Type Description
tokenid string ID of the token.

Property behavior:
- read-only
- required for update operations
name string Name of the token.

Property behavior:
- required for create operations
description text Description of the token.
userid string A user the token has been assigned to.

Default: current user.

Property behavior:
- constant
lastaccess timestamp Most recent date and time the token was authenticated.

"0" if the token has never been authenticated.

Property behavior:
- read-only
status integer Token status.

Possible values:
0 - (default) enabled token;
1 - disabled token.
expires_at timestamp Token expiration date and time.

"0" for never-expiring tokens.
created_at timestamp Token creation date and time.

Property behavior:
- read-only
creator_userid string The creator user of the token.

Property behavior:
- read-only