List Client

List clients. Clients are listed in no particular order.

GET /v1/clients

List Client

cURL

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

200

{
  "clients": [
    {
      "displayName": "<string>",
      "createTime": {},
      "updateTime": {},
      "creator": "<string>",
      "updater": "<string>",
      "name": "<string>",
      "lastSeenTime": {},
      "labels": [
        {}
      ],
      "deleteTime": {},
      "owner": "<string>"
    }
  ],
  "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 clients to fetch.

pageToken · string

Token used for pagination.

showDeleted · boolean

If deleted clients should be included. By default false.

filter · string

Filter for clients, follows the lucene query string format. Example: 'displayName: "my-client"'.

orderBy · string

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

Response

200 - application/json

OK

clients · object[] · required

List of clients.

Show child attributes

nextPageToken · string

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