s3.accesskey.update

Update S3 access key id.

Specify rotate: true to generate a new secret under the same access key id. The account an access key belongs to cannot be changed.

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer

ID of the access key to update.

Parameter 2: data

data

Type: object

Access key changes to apply.

No Additional Properties

name

Name

Type: string

Human-readable name for the access key.

Must be at least 1 characters long

Must be at most 200 characters long

enabled

Enabled

Type: boolean

Whether the access key may be used.

expires_at

Expires At

Expiration timestamp for the access key or null for no expiration.

Any of

• Option 1
• Option 2

Type: stringFormat: date-time

Type: null

manage_buckets

Manage Buckets

Type: boolean

Whether this access key may create, delete, or modify buckets through the S3 protocol. Setting it requires the account that owns the key to hold the SHARING_S3_WRITE role.

rotate

Rotate

Type: boolean

Generate a new secret access key under the same access key id.

Return value

S3AccesskeyEntry

Type: object

The updated access key, including its secret.

No Additional Properties

id Required

Id

Type: integer

Unique identifier for the access key.

name Required

Name

Type: string

Human-readable name for the access key.

Must be at least 1 characters long

Must be at most 200 characters long

username Required

Username

Account the access key belongs to, or null if that account no longer exists.

Any of

• Option 1
• Option 2
• Option 3

Type: string

Type: string

Must be at least 1 characters long

Type: null

user_identifier Required

User Identifier

Stored account linkage. A numeric user ID for local accounts or a SID for directory services accounts.

Any of

• Option 1
• Option 2

Type: integer

Type: string

local Required

Local

Type: boolean

Whether the access key belongs to a local user account rather than a directory services one.

access_key Required

Access Key

Type: string

The S3 access key id clients sign requests with.

Must match regular expression: ^[A-Z0-9]{16,128}$

secret Required

Secret

The S3 secret access key. Readable only by administrators holding SHARING_S3_WRITE; redacted for everyone else. null when the secret was lost to a configuration restore without the secret seed.

Any of

• Option 1
• Option 2

Type: string

Type: null

enabled Required

Enabled

Type: boolean

Whether the access key may be used. A disabled key is refused by the S3 service.

expires_at

Expires At

Default: null

Expiration timestamp for the access key or null for no expiration.

Any of

• Option 1
• Option 2

Type: stringFormat: date-time

Type: null

created_at Required

Created At

Type: stringFormat: date-time

Timestamp when the access key was created.

last_used_at

Last Used At

Default: null

Timestamp of when the S3 service last accepted a request signed with this key. The value is null if the key has never been used. Access Key timestamps are updated from the S3 service at periodic intervals. This field is read-only.

Any of

• Option 1
• Option 2

Type: stringFormat: date-time

Type: null

manage_buckets

Manage Buckets

Type: boolean Default: false

Whether this access key may create, delete, or modify buckets through the S3 protocol. Setting it requires the account that owns the key to hold the SHARING_S3_WRITE role.

status Required

Status

Type: enum (of string)

Effective state of the access key. Only ENABLED keys are usable. DISABLED was set by an administrator, EXPIRED passed its expiration, USER_MISSING belongs to a directory account that no longer resolves (a deleted local account takes its keys with it), and SECRET_LOST lost its secret to a configuration restore without the secret seed and must be rotated.

Must be one of:

• "ENABLED"
• "DISABLED"
• "EXPIRED"
• "USER_MISSING"
• "SECRET_LOST"

Required roles: SHARING_S3_WRITE