s3.accesskey.create =================== Create an S3 access key. An access key is the SigV4 credential pair a client signs S3 requests with. It belongs to a local or directory services account, and the S3 service runs that key's requests as the account. It can never authenticate to the TrueNAS API. The access key id and the secret are generated unless supplied. The result carries the secret. .. raw:: html
Configuration for the new access key.
No Additional PropertiesHuman-readable name for the access key.
Must be at least 1 characters long
Must be at most 200 characters long
Account the access key belongs to.
Must be at least 1 characters long
Access key id for the new key. Generated when omitted.
^[A-Z0-9]{16,128}$
Whether the access key may be used.
Expiration timestamp for the access key or null for no expiration.
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.
Secret access key for the new key. Generated when omitted.
^[\x21-\x7E]+$
Must be at least 16 characters long
Must be at most 128 characters long
The created access key and its secret.
No Additional PropertiesUnique identifier for the access key.
Human-readable name for the access key.
Must be at least 1 characters long
Must be at most 200 characters long
Account the access key belongs to, or null if that account no longer exists.
Must be at least 1 characters long
Stored account linkage. A numeric user ID for local accounts or a SID for directory services accounts.
Whether the access key belongs to a local user account rather than a directory services one.
The S3 access key id clients sign requests with.
Must match regular expression:^[A-Z0-9]{16,128}$
Whether the access key may be used. A disabled key is refused by the S3 service.
Expiration timestamp for the access key or null for no expiration.
Timestamp when the access key was created.
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.
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.
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.
The S3 secret access key. Only s3.accesskey.create, and s3.accesskey.update with rotate, return it.