ApiKey

class flow_api.api_key.ApiKey(select=None, cls=None, init=None, by='id', allow_normal=True, allow_deleted=False, commit=False, expires_at=<class 'flow_api.system.NotSet'>, is_enabled=<class 'flow_api.system.NotSet'>, key_hash=<class 'flow_api.system.NotSet'>, key_prefix=<class 'flow_api.system.NotSet'>, name=<class 'flow_api.system.NotSet'>, user_id=<class 'flow_api.system.NotSet'>, debug=False)

Base class: Row

An API key (Personal Access Token) bound to a user identity. It allows programmatic clients (such as LLM agents using the MCP server) to authenticate to the Cloudomation API. The key inherits all permissions of the user it is bound to, so access can be scoped via RBAC roles.

Parameters

Name	Type	Description
allow_deleted	bool
allow_normal	bool
by	str
cls	Optional
commit	bool
debug	bool	if set, the content of the data being written will be logged.
expires_at	Union	When the API key expires. If unset, the key never expires.
init	Optional
is_enabled	Union	If unset, the API key cannot be used to authenticate.
key_hash	Union	Hashed API key token. Internal only, never exposed.
key_prefix	Union	Public, non-secret prefix used to look up the API key.
name	Union	A human readable name for the API key.
select	Optional
user_id	Union	Reference to the user this API key belongs to.

Constants

RESOURCE = api_key

Methods

clone

details

delete

details

duplicate

details

exists

details

export

details

get

details

get_dict

details

restore

details

save

details

user

details