Return collection of clients

get/oauth/clients
Internal-Use Only

Returns the collection of clients registered. Authorization: Bearer token with clients.read, clients.admin, zones.{zoneId}.admin, or equivalent (SASAdministrators) scope.

Request Samples

1

Response Samples

1{
2 "items": [
3 {
4 "scope": [
5 "openid",
6 "uaa.user"
7 ],
8 "client_id": "app",
9 "resource_ids": [
10 "none"
11 ],
12 "authorized_grant_types": [
13 "authorization_code"
14 ],
15 "redirect_uri": [
16 "http://example.com/app"
17 ],
18 "autoapprove": [
19 "true"
20 ],
21 "authorities": [
22 "uaa.none"
23 ],
24 "name": "My custom application",
25 "lastModified": 1548439765963
26 },
27 {
28 "scope": [
29 "uaa.none"
30 ],
31 "client_id": "azure",
32 "resource_ids": [
33 "none"
34 ],
35 "authorized_grant_types": [
36 "client_credentials"
37 ],
38 "authorities": [
39 "SCIM"
40 ],
41 "access_token_validity": 63070000,
42 "name": "Microsoft Azure SCIM client",
43 "lastModified": 1548439755441
44 }
45 ],
46 "startIndex": 1,
47 "itemsPerPage": 1,
48 "totalResults": 2,
49 "schemas": [
50 "http://cloudfoundry.org/schema/scim/oauth-clients-1.0"
51 ]
52}

Query Parameters

NameTypeRequiredDescription
count
integer
false

The number of results per page. The default is 100.

filter
string
false

The SCIM filter for querying clients. The default is 'client_id pr'.

sortBy
string
false

The field to sort results by. The default is client_id.

sortOrder
string
false

The sort order of results by ascending or descending order. The default is ascending.

startIndex
integer
false

The index of the first result on which to begin the page. The default is 1.

Responses

StatusMeaningDescription
200OKThe request succeeded.HeadersSchema
400Bad RequestThe request was invalid. An invalid query parameter was specified.