s3.accesskey.update¶
Update S3 access key id.
Specify rotate: true to generate a new secret under the same access key id. The result then carries the new secret. The account an access key belongs to cannot be changed.
No Additional Items
Tuple Validation
Parameter 1: id
id
Type: integerID of the access key to update.
Parameter 2: data
data
Type: objectAccess key changes to apply.
No Additional PropertiesName
Type: stringHuman-readable name for the access key.
Must be at least 1 characters long
Must be at most 200 characters long
Enabled
Type: booleanWhether the access key may be used.
Expires At
Expiration timestamp for the access key or null for no expiration.
Manage Buckets
Type: booleanWhether 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
Type: booleanGenerate a new secret access key under the same access key id.
Result
The updated access key. It carries secret only when rotate was set.
S3AccesskeyEntryWithSecret
Type: objectNo Additional Properties
Id
Type: integerUnique identifier for the access key.
Name
Type: stringHuman-readable name for the access key.
Must be at least 1 characters long
Must be at most 200 characters long
Username
Account the access key belongs to, or null if that account no longer exists.
Must be at least 1 characters long
User Identifier
Stored account linkage. A numeric user ID for local accounts or a SID for directory services accounts.
Local
Type: booleanWhether the access key belongs to a local user account rather than a directory services one.
Access Key
Type: stringThe S3 access key id clients sign requests with.
Must match regular expression:^[A-Z0-9]{16,128}$
Enabled
Type: booleanWhether the access key may be used. A disabled key is refused by the S3 service.
Expires At
Default: nullExpiration timestamp for the access key or null for no expiration.
Created At
Type: stringFormat: date-timeTimestamp when the access key was created.
Last Used At
Default: nullTimestamp 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.
Manage Buckets
Type: boolean Default: falseWhether 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
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"
Secret
Type: stringThe S3 secret access key. Only s3.accesskey.create, and s3.accesskey.update with rotate, return it.
S3AccesskeyEntry
Type: objectNo Additional Properties
Id
Type: integerUnique identifier for the access key.
Name
Type: stringHuman-readable name for the access key.
Must be at least 1 characters long
Must be at most 200 characters long
Username
Account the access key belongs to, or null if that account no longer exists.
Must be at least 1 characters long
User Identifier
Stored account linkage. A numeric user ID for local accounts or a SID for directory services accounts.
Local
Type: booleanWhether the access key belongs to a local user account rather than a directory services one.
Access Key
Type: stringThe S3 access key id clients sign requests with.
Must match regular expression:^[A-Z0-9]{16,128}$
Enabled
Type: booleanWhether the access key may be used. A disabled key is refused by the S3 service.
Expires At
Default: nullExpiration timestamp for the access key or null for no expiration.
Created At
Type: stringFormat: date-timeTimestamp when the access key was created.
Last Used At
Default: nullTimestamp 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.
Manage Buckets
Type: boolean Default: falseWhether 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
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