Table of Contents

> Token object

The following objects are directly related to the token API.


The token object has the following properties.

Property Type Description
tokenid string (readonly) ID of the token.
string Name of the token.
description text Description of the token.
userid string (readonly for update) A user the token has been assigned to.

Default: current user.
lastaccess timestamp (readonly) Most recent date and time the token was authenticated.

Zero if the token has never been authenticated.
status integer Token status.

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

Zero for never-expiring tokens.
created_at timestamp (readonly) Token creation date and time.
creator_userid string (readonly) The creator user of the token.

Note that for some methods (update, delete) the required/optional parameter combination is different.