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 or to start a browser download from a web share. A browser session counts once, also when it retries.

Note

Shared Tokens only

downloadLimit

Total number of transfers and browser downloads that can be made with this shared token before it becomes invalid. None if there is no 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

webLinkId

The ID of the web link for this share, or None if nobody made one. A browser opens the link at /l/<webLinkId> on the web share address. Make or replace the link with send.mintWebLink, and remove it with send.clearWebLink.

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.