Get Broker Directory

This endpoint is responsible for fetching a directory by ID.

Request

URI

GET

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

COPY

Path Parameters

string

Required

The ID of the directory

string

tenant

Required

The VMware Identity Services tenant ID

tenant example

my-tenant

Authentication

This operation uses the following authentication methods.

admin

Responses

200

Successfully fetched the directory info.

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

{
    "_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
}

object

_links

Optional

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

string As uuid As uuid

Optional

The unique identifier of the directory

string

name

Optional

User provided directory name. This must be unique. The allowed symbols are letters in any language, digits (0-9), space and -_

array of string

domains

Optional

List of directory domain names

string

default_domain

Optional

The default domain is required when users and groups are provisioned from an external directory without a domain. If the default domain is not set when the directory is created and the domain name is not synced from the external directory, user records in the directory will not have the domain attribute associated with the record and underlying services that rely on the domain attribute may fail. Must be one of the list of domain names. Note that the field is not returned in list directories API.

string

source

Optional

The type of the directory source

Possible values are : AZURE, PING, OKTA, ACCESS, GENERIC,

string

type

Optional

The type of the directory

Possible values are : PROVISIONED, JIT,

boolean

delete_in_progress