Skip to main content

Create a new Access Key

POST 

/v1/providers/:provider_id/orgs/:org_id/key

Creates a new access key for a user. The access key ID and secret will be returned in the response.

Request

Path Parameters

    provider_id stringrequired

    Provider ID

    org_id stringrequired

    Organization ID

Body

required

    namestring

    Name of the access key

    user_idstringrequired

    ID of the user for whom the access key is being created

    user_roleOrgMembership (string)

    Role assigned to the user in the organization

    Possible values: [Admin, Member]

    buckets_roles

    object[]

  • Array [

  • bucket_namestringrequired

    Name of the bucket

    rolestringrequired

    The role assigned to the access key defines the permissions (read, write, admin) for the associated bucket.

    • ReadOnly: Read-only access to the bucket.

    • Editor: Read and write access to the bucket.

    • Admin: Full access to all the buckets in org, including management of permissions. Since, this access key manages all the buckets, the value of bucket_name field should always be *.

      Example:

      { "bucket_name": "*", "role": "Admin" }

    Possible values: [ReadOnly, Editor, Admin]

  • ]

Responses

OK

Schema

    idstringrequired

    Access key ID

    secret_keystringrequired

    Access secret

    namestring

    Name of the access key