Skip to main content

List all Access Keys

POST 

/v1/providers/:provider_id/orgs/:org_id/keys

Lists all the access keys for a user in the organization account.

Request

Path Parameters

    provider_id stringrequired

    Provider ID

    org_id stringrequired

    Organization ID

Body

required

    user_idstringrequired

    ID of the user for whom the access keys are being listed

    user_roleOrgMembership (string)

    Role assigned to the user in the organization

    Possible values: [Admin, Member]

Responses

OK

Schema

    keys

    object[]

    required

  • Array [

  • idstringrequired

    Access key ID

    namestringrequired

    Name of the access key

    statusstringrequired

    Status of the access key.

    Possible values: [Active, Inactive]

    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]

  • ]

  • ]