COcouchbase
Api Keys

List API keys

Changed on

Lists all the API keys under an organization.

Organization Owners can list all the API keys inside the Organization.

Organization Members and Project Creators can list all the Project scoped API key for which they are Project Owner.

To learn more, see Organization, Project, and Database Access Overview.

get/v4/organizations/{organizationId}/apikeys

Request

Query parameters

pageinteger

Sets the page you would like to view.

perPageinteger

Sets the number of results you would like to have on each page.

sortBystring[]

Sets the order of how you would like to sort the results and the key you would like to order by. Valid fields to sort the results are: name, createdAt, expiry.

sortDirection'asc' | 'desc'

The order in which the items will be sorted.

Response

Successfully listed all the apikeys under an organization.

Example response

{
  "data": [
    {
      "id": "IS9DrRsw4KWFS72Zhbj4xmhllHvPcdCL",
      "name": "Production",
      "description": "API key to manage production Capella Cluster.",
      "allowedCIDRs": [
        "0.0.0.0/0"
      ],
      "organizationRoles": [
        "organizationMember"
      ],
      "resources": [
        {
          "id": "ffffffff-aaaa-1414-eeee-000000000000",
          "roles": [
            "projectDataReaderWriter",
            "projectManager"
          ]
        }
      ],
      "audit": {
        "createdBy": "ffffffff-aaaa-1414-eeee-000000000000",
        "createdAt": "2021-09-01T12:34:56Z",
        "modifiedBy": "ffffffff-aaaa-1414-eeee-000000000000",
        "modifiedAt": "2021-09-01T12:34:56Z",
        "version": 1
      }
    }
  ],
  "cursor": {
    "pages": {
      "page": 2,
      "next": 3,
      "previous": 1,
      "last": 10,
      "perPage": 10,
      "totalItems": 10
    },
    "hrefs": {
      "first": "https://cloud.couchbase.com/v4/users?page=1&perPage=10",
      "last": "https://cloud.couchbase.com/v4/users?page=1&perPage=10",
      "previous": "https://cloud.couchbase.com/v4/users?page=1&perPage=10",
      "next": "https://cloud.couchbase.com/v4/users?page=1&perPage=10"
    }
  }
}

Changes

  • a5e88bcf71cbRevision changes
    • warning

      added the new organizationBillingAdmin enum value to the /// response property for the response status

    • warning

      added the new organizationBillingViewer enum value to the /// response property for the response status

    • warning

      added the new organizationReadOnly enum value to the /// response property for the response status