IPWorks Cloud 2020 Python Edition

Questions / Feedback?

on_app_key_list Event

Fires once for each application key returned when listing application keys.

Syntax

class BackblazeB2AppKeyListEventParams(object):
  @property
  def key_id() -> str: ...
  @property
  def key_name() -> str: ...
  @property
  def capabilities() -> str: ...
  @property
  def allowed_bucket_id() -> str: ...
  @property
  def allowed_prefix() -> str: ...
  @property
  def expiration_time() -> int: ...

# In class BackblazeB2:
@property
def on_app_key_list() -> Callable[[BackblazeB2AppKeyListEventParams], None]: ...
@on_app_key_list.setter
def on_app_key_list(event_hook: Callable[[BackblazeB2AppKeyListEventParams], None]) -> None: ...

Remarks

This event fires once for each application key returned when list_app_keys is called.

KeyId reflects the unique Id of the application key.

KeyName reflects the name that was given to the application key when it was created.

Capabilities reflects the capabilities that the application key has. It is formatted as a comma-separated list of one or more of the following:

Capability String Related Methods
deleteBuckets delete_bucket
deleteFiles delete_file, delete_file_version
deleteKeys delete_app_key
listBuckets get_bucket_info, list_buckets
listFiles delete_file, list_files, list_file_versions, list_multipart_uploads
listKeys list_app_keys
readFiles copy_file, copy_part, download_file, download_file_by_id, get_file_info
shareFiles get_download_auth_token
writeBuckets create_bucket, update_bucket
writeFiles abort_multipart_upload, complete_multipart_upload, copy_file, copy_part, hide_file, list_parts, start_multipart_upload, upload_file, upload_part
writeKeys create_app_key

AllowedBucketId reflects the Id of the bucket that the application key is restricted to. It will be empty if the application key is not restricted to any specific bucket.

AllowedPrefix reflects the file name prefix that the application key is restricted to. It will be empty if the application key is not restricted to a specific file name prefix.

ExpirationTime reflects the expiration time of the application key, in milliseconds relative to the Unix epoch. It will be -1 if the application key does not expire.

Copyright (c) 2022 /n software inc. - All rights reserved.
IPWorks Cloud 2020 Python Edition - Version 20.0 [Build 8265]