s3.accesskey.query ================== Sent on s3.accesskey changes. .. raw:: html
Type: object

S3AccesskeyAddedEvent

Type: object
No Additional Properties

Id

Type: integer

S3AccesskeyEntry

Type: object
No Additional Properties

Id

Type: integer

Unique identifier for the access key.

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


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

Type: string
Type: string

Must be at least 1 characters long

Type: null

User Identifier


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

Type: integer
Type: string

Local

Type: boolean

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

Access Key

Type: string

The S3 access key id clients sign requests with.

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

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.

Type: string
Type: null

Enabled

Type: boolean

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

Expires At

Default: null

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

Type: stringFormat: date-time
Type: null

Created At

Type: stringFormat: date-time

Timestamp when the access key was created.

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"

S3AccesskeyChangedEvent

Type: object
No Additional Properties

Id

Type: integer

S3AccesskeyEntry

Type: object
No Additional Properties

Id

Type: integer

Unique identifier for the access key.

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


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

Type: string
Type: string

Must be at least 1 characters long

Type: null

User Identifier


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

Type: integer
Type: string

Local

Type: boolean

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

Access Key

Type: string

The S3 access key id clients sign requests with.

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

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.

Type: string
Type: null

Enabled

Type: boolean

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

Expires At

Default: null

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

Type: stringFormat: date-time
Type: null

Created At

Type: stringFormat: date-time

Timestamp when the access key was created.

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"

S3AccesskeyRemovedEvent

Type: object
No Additional Properties

Id

Type: integer


*Required roles:* SHARING_S3_READ