B2 Application key

class b2sdk.v3.ApplicationKey(key_name, application_key_id, capabilities, account_id, expiration_timestamp_millis=None, bucket_ids=None, name_prefix=None, options=None)

Dataclass for storing info about an application key returned by delete-key or list-keys.

Parameters:

• key_name (str) –

• application_key_id (str) –

• capabilities (list[str]) –

• account_id (str) –

• expiration_timestamp_millis (Optional[int]) –

• bucket_ids (Optional[list[str]]) –

• name_prefix (Optional[str]) –

• options (Optional[list[str]]) –

classmethod from_api_response(response)

Create an ApplicationKey object from a delete-key or list-key response (a parsed json object).

Parameters:

response (dict) –

Return type:

ApplicationKey

__init__(key_name, application_key_id, capabilities, account_id, expiration_timestamp_millis=None, bucket_ids=None, name_prefix=None, options=None)

Parameters:

• key_name (str) – name of the key, assigned by user

• application_key_id (str) – key id, used to authenticate

• capabilities (list[str]) – list of capabilities assigned to this key

• account_id (str) – account’s id

• expiration_timestamp_millis (Optional[int]) – expiration time of the key

• bucket_id – if restricted to a bucket, this is the bucket’s id

• name_prefix (Optional[str]) – if restricted to some files, this is their prefix

• options (Optional[list[str]]) – reserved for future use

• bucket_ids (Optional[list[str]]) –

as_dict()

Represent the key as a dict, like the one returned by B2 cloud

has_capabilities(capabilities)

checks whether the key has ALL of the given capabilities

Return type:

bool

classmethod parse_response_dict(response)

Parameters:

response (dict) –

class b2sdk.v3.FullApplicationKey(key_name, application_key_id, application_key, capabilities, account_id, expiration_timestamp_millis=None, bucket_ids=None, name_prefix=None, options=None)

Dataclass for storing info about an application key, including the actual key, as returned by create-key.

Parameters:

• key_name (str) –

• application_key_id (str) –

• application_key (str) –

• capabilities (list[str]) –

• account_id (str) –

• expiration_timestamp_millis (Optional[int]) –

• bucket_ids (Optional[list[str]]) –

• name_prefix (Optional[str]) –

• options (Optional[list[str]]) –

__init__(key_name, application_key_id, application_key, capabilities, account_id, expiration_timestamp_millis=None, bucket_ids=None, name_prefix=None, options=None)

Parameters:

• key_name (str) – name of the key, assigned by user

• application_key_id (str) – key id, used to authenticate

• application_key (str) – the actual secret key

• capabilities (list[str]) – list of capabilities assigned to this key

• account_id (str) – account’s id

• expiration_timestamp_millis (Optional[int]) – expiration time of the key

• bucket_id – if restricted to a bucket, this is the bucket’s id

• name_prefix (Optional[str]) – if restricted to some files, this is their prefix

• options (Optional[list[str]]) – reserved for future use

• bucket_ids (Optional[list[str]]) –

classmethod from_create_response(response)

Create a FullApplicationKey object from a create-key response (a parsed json object).

Parameters:

response (dict) –

Return type:

FullApplicationKey

classmethod parse_response_dict(response)

Parameters:

response (dict) –

as_dict()

Represent the key as a dict, like the one returned by B2 cloud

has_capabilities(capabilities)

checks whether the key has ALL of the given capabilities

Return type:

bool