Get Broker Directories

This endpoint is responsible for listing the existing directories.

Request

URI

GET

https://{api_host}//usergroup/t/{tenant}/broker/directories

COPY

Path Parameters

string

tenant

Required

The VMware Identity Services tenant ID

tenant example

my-tenant

Authentication

This operation uses the following authentication methods.

admin

Responses

200

Directory list was successfully returned.

Returns BrokerDirectoryList of type(s) application/vnd.vmware.vidm.usergroup.broker.directory.list+json

{
    "items": [
        {
            "_links": {
                "self": {
                    "href": "https://example.com/path-to-self"
                }
            },
            "id": "string",
            "name": "my_dir 1",
            "domains": [
                "domain1",
                "domain2"
            ],
            "default_domain": "domain1",
            "source": "AZURE",
            "type": "PROVISIONED",
            "delete_in_progress": false
        }
    ],
    "_links": {
        "self": {
            "href": "https://example.com/path-to-self"
        }
    }
}

array of BrokerDirectoryMedia

items

Optional

items

object

_links

Optional

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

401

Unauthorized to list existing directories.

Operation doesn't return any data structure

403