Sign in
Access Keys

Create an S3 access key

Changed on

Provisions an AWS Sig V4 access-key pair scoped by the supplied permissions and (optionally) a list of buckets. The secretAccessKey is returned only in this response.

post/tenants/{tenantId}/access-keys

Request

  • Base URL: https://api.example.com
  • URL: https://api.example.com/tenants/{tenantId}/access-keys
  • Auth: HTTP bearer

Request body

namestring required

Unique within the tenant.

permissionsAccessKeyPermission[] required
bucketsBucketName[]

Optional. When set and non-empty, the key may only operate on these buckets. Omit (or pass an empty array) for tenant-wide access.

expiresAtstring date-time nullable

Optional expiration. The Service Orchestrator must reject the credentials after this time.

Response

Access key created.

accessKeyIdstring required

AWS-style access key ID, used by S3 clients.

namestring required
permissionsAccessKeyPermission[] required
bucketsBucketName[]

Empty or omitted when the key has tenant-wide access.

expiresAtstring date-time nullable
createdAtstring date-time required
secretAccessKeystring required

AWS-style secret. Returned only on creation; the Service Orchestrator must not expose it via subsequent reads.

Changes

  • 5fe053853bc7Revision changes
    • warning

      added the new s3:ListBucketMultipartUploads enum value to the ///// response property for the response status

    • info

      added the new s3:ListBucketMultipartUploads enum value to the request property /