@akamai/openapi-ts
    Preparing search index...

    Type Alias PostObjectStorageKeysResponses

    type PostObjectStorageKeysResponses = {
        "200": {
            access_key: string;
            bucket_access: {
                bucket_name: string;
                cluster: string;
                permissions: "read_write" | "read_only";
                region: string;
            }[];
            id: number;
            label: string;
            limited: boolean;
            regions: {
                endpoint_type: "E0"
                | "E1"
                | "E2"
                | "E3";
                id: string;
                s3_endpoint: string;
            }[];
            secret_key: string;
        };
    }
    Index

    Properties

    Properties

    "200": {
        access_key: string;
        bucket_access: {
            bucket_name: string;
            cluster: string;
            permissions: "read_write" | "read_only";
            region: string;
        }[];
        id: number;
        label: string;
        limited: boolean;
        regions: {
            endpoint_type: "E0"
            | "E1"
            | "E2"
            | "E3";
            id: string;
            s3_endpoint: string;
        }[];
        secret_key: string;
    }

    The settings necessary to create a new Object Storage access key.

    Type Declaration

    • Readonlyaccess_key: string

      Read-only A unique string chosen by the API to identify this key. Used as a username to identify this key when making requests to an S3 API, such as the Amazon S3 API or Ceph Object Gateway S3 API.

    • bucket_access: {
          bucket_name: string;
          cluster: string;
          permissions: "read_write" | "read_only";
          region: string;
      }[]

      Settings that limit access to specific buckets, each with a specific permission level. See Create a limited access key for more information.

    • Readonlyid: number

      Read-only This Object Storage key's unique ID.

    • label: string

      The label given to this key. For display purposes only.

    • Readonlylimited: boolean

      Read-only Whether this Object Storage key limits access to specific buckets and permissions. Returns false if this key grants full access. Specific limitations are set in bucket_access.

    • regions: { endpoint_type: "E0" | "E1" | "E2" | "E3"; id: string; s3_endpoint: string }[]

      Identifies each region where you can use the Object Storage key.

    • Readonlysecret_key: string

      Read-only This Object Storage key's secret key. Used as a password to validate this key when making requests to an S3 API, such as the Amazon S3 API or Ceph Object Gateway S3 API.

      🚧

      The secret_key is only revealed in the response for this operation. Make sure to store it for later use.