Skip to main content
Version: Next

Token Module

Message types for the Token API

Permissions​

class Permissions(BaseModel)

Token permission

full_access​

full access to manage buckets and tokens

read​

list of buckets with read access

write​

list of buckets with write access

Token​

class Token(BaseModel)

Token for authentication

name​

name of token

created_at​

creation time of token

is_provisioned​

token is provisioned and can't be deleted or changed

expires_at​

absolute expiration time

ttl​

inactivity timeout in seconds

last_access​

latest token usage timestamp

is_expired​

token is currently expired and unusable

ip_allowlist​

list of allowed client IPs or CIDRs

FullTokenInfo​

class FullTokenInfo(Token)

Full information about token with permissions

permissions​

permissions of token

TokenList​

class TokenList(BaseModel)

List of tokens

tokens​

list of tokens

TokenCreateRequest​

class TokenCreateRequest(BaseModel)

Request payload for creating a token

permissions​

permissions of token

expires_at​

absolute expiration time

ttl​

inactivity timeout in seconds

ip_allowlist​

list of allowed client IPs or CIDRs

TokenCreateResponse​

class TokenCreateResponse(BaseModel)

Response from creating a token

value​

token for authentication

created_at​

timestamp when a token value was created or rotated