Skip to main content

BucketAccess

Access permissions for a bucket. The role assigned to the access key defines the permissions (read, write, admin) for the associated bucket.

bucket_namestringrequired

Name of the bucket

rolestringrequired

The role defines the permissions for the associated bucket:

  • ReadOnly: Read-only access to the bucket. Permits read operations like GetObject, HeadObject, ListObjects.

  • Editor: Read and write access to the bucket. Includes everything in ReadOnly, plus PutObject, DeleteObject, and bucket configuration operations.

  • Admin: Full access to all buckets in the org, bypasses all permission checks. When used with bucket_name: "*", the access key is treated as a full org admin. The value of bucket_name should always be * when using this role.

    Example:

    { "bucket_name": "*", "role": "Admin" }

Possible values: [ReadOnly, Editor, Admin]

BucketAccess
{
  "bucket_name": "string",
  "role": "ReadOnly"
}