Sign in

v1

latestOpenAPI 3.0.22026-08-062794201004.1 KB
Users

List Users

Lists all the users in the organization and filter on the basis of projectId.

In order to access this endpoint, the provided API key must have at least one of the following roles:

  • Organization Owner
  • Organization Member
  • Project Creator

The results are always limited by the role and scope of the caller's privileges.

When retrieving a list of users through a GET request, if a user holds the organization owner role, the response will exclude project-level permissions for those users. This is because organization owners have full access to all resources within the organization, making project-level permissions irrelevant for them.

To learn more about the roles, see Organization Roles and Project Roles.

get/v4/organizations/{organizationId}/users

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: id, name, email, status, inactive.

sortDirection'asc' | 'desc'

The order in which the items will be sorted.

projectIdstring uuid
Example:ffffffff-aaaa-1414-eeee-000000000000

The GUID4 ID of the project.

Response

Successfully listed all the user in the organization.

Example response

{
  "data": [
    {
      "id": "ffffffff-aaaa-1414-eeee-000000000000",
      "name": "alex",
      "email": "john.doe@example.com",
      "status": "not-verified",
      "organizationId": "ffffffff-aaaa-1414-eeee-000000000000",
      "organizationRoles": [
        "projectCreator"
      ],
      "lastLogin": "2023-07-17T07:05:39.116124897Z",
      "region": "North America",
      "timeZone": "(UTC -9:00) Alaska Standard Time",
      "enableNotifications": true,
      "expiresAt": "2023-07-17T07:05:39.116124897Z",
      "resources": [
        {
          "type": "project",
          "id": "ffffffff-aaaa-1414-eeee-000000000000",
          "roles": [
            "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"
    }
  }
}