Tokens and Permissions

Refresh token

Generates a new token value; the old token value becomes immediately invalid. Any token can refresh itself, except a read-only personal access token; refreshing another token requires the canManageTokens permission.

The decrypted token value is returned when refreshing a non-master token, the token used for authorization, or when the project has a dedicated project feature enabled.

post/v2/storage/tokens/{id}/refresh

Request

Path parameters

idinteger required

A valid token ID. You can get it from the Token verification call.

Response

Refreshed token.

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 for non-master tokens, for the token used for authorization, or when the project has a dedicated project feature enabled.

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).

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"
  }
}

Changes

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