GetAccessKeyResponse

idstringrequired

Access key ID

namestringrequired

Name of the access key

statusstringrequired

Status of the access key.

Possible values: [Active, Inactive]

buckets_roles object[]

Bucket roles currently assigned to the key.

Array [

bucket_namestringrequired

Name of the bucket

rolestringrequired

The role defines the permissions for the associated bucket:

• ReadOnly: Read operations such as GetObject, HeadObject and ListObjects, plus creating bucket snapshots and forks.

• ReadWrite: Everything in ReadOnly, plus object writes: PutObject, DeleteObject, CopyObject, object tagging and multipart uploads. Cannot change bucket configuration.

• Editor: Everything in ReadWrite, plus full bucket administration: CORS, lifecycle, tagging, ownership controls, inventory, bucket ACLs (including making the bucket public), custom domains, delete protection, shadow bucket, origin, object notifications, storage tier, and DeleteBucket. Cannot manage bucket shares or create bucket IAM policies.

• 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, ReadWrite, Editor, Admin]

]

attached_policiesstring[]

Names of IAM policies attached to this access key

access_key_scopeAccessKeyScope

Controls whether the key receives the implicit default-allowed operations (such as create bucket or list buckets) on top of what its policies and bucket roles grant.

• standard (default): grants the default-allowed operations.
• no_default_allow: denies them, so the key can do only what its policies and bucket roles explicitly allow.

Possible values: [standard, no_default_allow]

GetAccessKeyResponse

{
  "id": "string",
  "name": "string",
  "status": "Active",
  "buckets_roles": [
    {
      "bucket_name": "string",
      "role": "ReadOnly"
    }
  ],
  "attached_policies": [
    "string"
  ],
  "access_key_scope": "standard"
}