KEkeboola
Tokens and Permissions

Token detail

Returns all properties of a token, including the project it belongs to (owner). You can obtain the token ID, for example, using the Token verification call.

Requesting the token used for authorization is always allowed; requesting any other token requires the canManageTokens permission.

Available both with and without a development branch prefix; the returned token properties and permission rules are the same in either case.

get/v2/storage/branch/{branchId}/tokens/{id}

Request

Path parameters

idinteger required

Token ID.

branchIdstring required

Response

Token detail response.

idstring required

Unique identifier of the token.

createdstring nullable required

Token creation timestamp, ISO 8601 with a +hhmm offset.

refreshedstring nullable required

Token last refresh timestamp, ISO 8601 with a +hhmm offset.

descriptionstring required

User-provided description of the token.

uristring required

URI of the token detail.

isMasterTokenboolean required

Whether this is a master (admin) token.

canManageBucketsboolean required

Token permission to manage all buckets.

canManageTokensboolean required

Token permission to manage tokens.

canReadAllFileUploadsboolean required

Token permission to read all file uploads.

canPurgeTrashboolean required

Token permission to permanently remove deleted configurations.

canManageProtectedDefaultBranchboolean required

Token permission to manage the protected default branch.

canCreateJobsboolean required

Token permission to create jobs.

canReadAllProjectEventsboolean required

Token permission to read all project events.

canManageDevBranchesboolean required

Token permission to manage development branches.

expiresstring nullable required

Expiration timestamp of the token, ISO 8601 with a +hhmm offset; null when the token never expires.

isExpiredboolean required

Whether the token is expired.

isDisabledboolean required

Whether the token is disabled.

dailyCapacityinteger required

Daily capacity of the token.

tokenstring

Decrypted token value. Present only when the project has a dedicated project feature enabled, the default branch is not protected and the token cannot manage the protected default branch.

componentAccessstring[]

Component IDs the token may access. Present only when at least one component is granted.

bucketPermissionsobject required

Bucket permissions keyed by bucket ID (read, write or manage).

isBYODBboolean required

Whether the project uses a Bring Your Own Database backend. Kept for backward compatibility, same as owner.isBYODB.

Example response

{
  "id": "484",
  "created": "2017-02-13T12:01:05+0100",
  "refreshed": "2017-02-13T12:01:05+0100",
  "description": "my-new-token",
  "uri": "https://connection.keboola.com/v2/storage/tokens/484",
  "dailyCapacity": 5,
  "token": "75-12d4bfa4995694a1c956e7bb1eea0df5cc53acdb",
  "creatorToken": {
    "id": 1,
    "description": "dev@keboola.com"
  },
  "componentAccess": [
    "keboola.ex-db-mysql"
  ],
  "bucketPermissions": {
    "in.c-main": "read"
  },
  "owner": {
    "id": 58,
    "name": "Buckets 5",
    "type": "production",
    "region": "us-east-1",
    "created": "2017-02-13T12:01:05+0100",
    "dataSizeBytes": 112128,
    "rowsCount": 1036,
    "defaultBackend": "snowflake",
    "hasTryModeOn": "0",
    "dataRetentionTimeInDays": 7,
    "assignedBackends": [
      "snowflake"
    ],
    "usersCount": 2,
    "fileStorageProvider": "aws",
    "payAsYouGo": {
      "purchasedCredits": 123
    }
  },
  "organization": {
    "id": "123"
  },
  "admin": {
    "name": "John Doe",
    "id": 124,
    "role": "admin"
  },
  "adminOwner": {
    "id": 17,
    "name": "Username",
    "email": "username@keboola.com"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.