Search Clients By Roles

Searches OAuth2 clients based on the assigned roles

Request

URI

POST

https://{api_host}/acs/t/{tenant}/broker/oauth2-clients/search

COPY

Path Parameters

string

tenant

Required

The VMware Identity Services tenant ID

tenant example

my-tenant

Query Parameters

integer

start_index

Optional

Constraints: default: 1

The index of the page. Pages start with index 1.

start_index example

integer

page_size

Optional

Constraints: default: 20

Number of results per page.

page_size example

Request Body

Roles assigned to the OAuth2 clients for filtering

RoleSearchMedia of type(s) application/vnd.vmware.horizon.manager.accesscontrol.roles.search+json

Required

Show optional properties

{
    "roles": [
        {
            "type": "vc",
            "role_name": "roleA"
        }
    ]
}

{
    "roles": [
        {
            "type": "vc",
            "_links": {
                "self": {
                    "href": "https://example.com/path-to-self"
                }
            },
            "role_name": "roleA"
        }
    ],
    "_links": {
        "self": {
            "href": "https://example.com/path-to-self"
        }
    }
}

array of object

roles

Required

List of roles to filter the search by

object

_links

Optional

The resource HATEOAS links. Usually includes a "self" link for this resource

Authentication

This operation uses the following authentication methods.

admin

Responses

200

OAuth2 clients successfully found based on roles

Returns BrokerOAuth2ClientList of type(s) application/vnd.vmware.horizon.manager.accesscontrol.broker.oauth2client.list+json

"BrokerOAuth2ClientList Object"

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

Request contains invalid information

Operation doesn't return any data structure

404

The role or tenant was not found.

Operation doesn't return any data structure

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/vnd.vmware.horizon.manager.accesscontrol.roles.search+json' -d '{"roles":["object"]}' https://{api_host}/acs/t/{tenant}/broker/oauth2-clients/search

On This Page

Description

Request

Path Parameters

Query Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Administration Operations

DELETE