Token Structure

A Token structure is returned from Shared Token methods createSharedToken(), getSharedToken(), getSharedTokens(), or API Token methods createAPIToken(), getAPIToken(), getAPITokens().

creationTime
Timestamp when the token was created. See Timestamps.
description
A description of the token.
expiryTime
Timestamp when this token becomes invalid. See Timestamps. May be None if the token doesn’t expire.
owner
The owner of this token.
ownerToken
The owner of this token, if this destination was created by a token.
ownerTokenSession
The token session of the token that created this token.
passwordRequired
Whether a password is required to use this token.
permissions
Permissions granted to this token. See PERMISSIONS
token
A token ID.
userData
Key-value map of user attached metadata. Use updateObjectUserData() and deleteObjectUserData() to manipulate object user data.
downloadCount

Number of times this shared token has been used to create a transfer.

Note

Shared Tokens only

downloadLimit

Total number of transfers that can be created with this shared token, before becoming invalid. May be None if there is not limit.

Note

Shared Tokens only

manifestId

A manifest ID. Manifest IDs are returned from createManifest(), and used in other methods to refer to a specific manifest.

Note

Shared Tokens only

path

Path that this API token is sandboxed into.

Note

API Tokens only

Changed in version 2.4.0: Added ownerToken, ownerTokenSession, permissions, path keys.