Get All O Auth2 Client Summaries
This endpoint is to list existing OAuth 2.0 clients. Returns a summary for each client.
Request
URI
GET
https://{api_host}/acs/t/{tenant}/broker/oauth2-clients
COPY
Path Parameters
string
tenant
Required
The VMware Identity Services tenant ID
tenant example
my-tenantQuery Parameters
integer
start_index
Optional
Constraints:
default: 1
The index of the page. Pages start with index 1.
start_index example
1
integer
page_size
Optional
Constraints:
default: 20
Number of results per page.
page_size example
50
string
searchTerm
Optional
The string to be searched within the OAuth client' displayName or clientId
searchTerm example
myAppResponses
200
OAuth2 Clients returned successfully.
Returns
BrokerOAuth2ClientList
of type(s)
application/vnd.vmware.horizon.manager.accesscontrol.broker.oauth2client.list+json
{
"items": [
{
"scope": [
"admin",
"openid",
"profile",
"email"
],
"_links": {
"self": {
"href": "https://example.com/path-to-self"
}
},
"client_id": "oauth_clientid"
}
],
"totalCount": 0,
"pageNumber": 0,
"totalPages": 0,
"pageSize": 0,
"_links": {
"self": {
"href": "https://example.com/path-to-self"
}
}
}
array of
object
items
Optional
Represents a summary of an OAuth 2.0 client
integer As int32
As int32
totalCount
Optional
Count of total number of elements for the request
integer As int32
As int32
pageNumber
Optional
Current page number
integer As int32
As int32
totalPages
Optional
Total number of pages for the request
integer As int32
As int32
pageSize
Optional
Number of elements returned per page
object
_links
Optional
The resource HATEOAS links. Usually includes a "self" link for this resource
400
Invalid starting index or page size.
Operation doesn't return any data structure
Code Samples
COPY
curl -H 'Authorization: <value>' https://{api_host}/acs/t/{tenant}/broker/oauth2-clients