List User

List users within the organization.

GET /v1/users

List User

cURL

curl --request GET \
  --url https://iam.eu.confidence.dev/v1/users \
  --header 'Authorization: Bearer <token>'

200

{
  "users": [
    {
      "fullName": "<string>",
      "email": "<string>",
      "createTime": {},
      "updateTime": {},
      "identity": "<string>",
      "name": "<string>",
      "givenName": "<string>",
      "familyName": "<string>",
      "externalId": "<string>",
      "scimExternalId": "<string>",
      "username": "<string>",
      "pictureUri": "<string>",
      "lastLoginTime": {},
      "blocked": true,
      "slackUserInfo": {},
      "labels": [
        {}
      ],
      "deleteTime": {}
    }
  ],
  "nextPageToken": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

pageSize · object

The maximum number of users to fetch.

pageToken · string

Token used for pagination.

filter · string

Filter to use for the request, follows the lucene query string format.

orderBy · string

Provide fields and direction to sort by. Will always tiebreak on name. Format: {"<"}field_0{">"}:{"<"}direction{">"}, {"<"}field_1{">"}:{"<"}direction{">"} Example: fullName:desc,createTime:asc

Response

200 - application/json

OK

users · object[] · required

Partial list of returned users.

Show child attributes

nextPageToken · string

A token that can be used to fetch more users, empty if no more users are available.