Update S3 keys for a User

post

https://cluster.ip.address/v2/users/{sid}/update-s3-keys

No Privileges Required

Syncs S3 Access Keys for a user. Use the 'keys' array (element i sets key slot i). Slots beyond the provided list are retained; this API replaces or extends key slots and cannot remove existing keys (use DELETE /users/{sid}/s3-keys/{keyId} to remove a key). The deprecated flat fields update only the primary key and are ignored when 'keys' is set.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

sid

string

required

Specify the SID of the user.

Body Params

Specifies the body to update the User S3 Keys

Carries the 'keys' array used to sync S3 keys for a user.

expirationTimeMsecs

int64 | null

Specifies the epoch timestamp in milliseconds when this S3 key expires. Post expiry the S3 key cannot be used for authentication.

s3AccessKeyId

string | null

Specifies the S3 Account Access Key ID. Allowed characters are: AlphaNumeric(a-zA-z0-9), underscore(_) and hyphen(-). Key should contain exactly 43 characters.

s3SecretKey

string | null

Specifies the S3 Account Secret Key. Allowed characters are: AlphaNumeric(a-zA-z0-9), underscore(_) and hyphen(-). Key should contain exactly 43 characters.

keys

array of objects | null

Ordered list of S3 keys; element i sets key slot i (index 0 is the primary key), replacing whatever occupies that slot. Slots beyond the provided list are retained; keys cannot be removed via this API. Access key ids must be unique across all users and key slots. When set, the deprecated flat fields are ignored.

keys

A single S3 key. Its position in the 'keys' array determines the key slot it occupies (index 0 is the primary key), and it fully replaces any key currently in that slot. s3AccessKeyId and s3SecretKey are required. If status or expirationTimeMsecs are omitted, they revert to their defaults (Enabled and no expiry, respectively). status uses the same values reported by the GET API ('Enabled'/'Disabled').

expirationTimeMsecs

int64 | null

Specifies the epoch timestamp in milliseconds when this S3 key expires. Post expiry the S3 key cannot be used for authentication.

s3AccessKeyId

string

required

S3 Access Key ID. Must be unique across all users and key slots.

s3SecretKey

string

required

S3 Secret Key.

status

string | null

enum

Status to set for an S3 key when syncing keys via the update-s3-keys APIs. Accepts the same values reported by the GET API ('Enabled'/'Disabled'/'Expired') so a GET response can be posted back as-is. 'Expired' is a derived state and is treated as 'Disabled' on input (control actual expiry via expirationTimeMsecs). Omitted defaults to 'Enabled'.

Allowed:

Responses

204

No Content

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

defaultError