BrokerDirectoryMedia

BrokerDirectoryMedia

Represents a VMware Identity Services directory

JSON Example

{
    "_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,
    "pre_provisioned_groups_enabled": true,
    "pre_provisioned_groups_list": [
        {
            "domain": "mydomain1.com",
            "groups": [
                "[ 'group1',  'group2' ]"
            ]
        }
    ],
    "ldap_configuration_uuid": "string"
}

object

_links

Optional

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

string As uuid As uuid

id

Optional

The unique identifier of the directory

string

name

Optional

Constraints: maxLength: 128

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

Constraints: maxLength: 100

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, LDAP,

string

type

Optional

The type of the directory

Possible values are : PROVISIONED, JIT,

boolean

delete_in_progress

Optional

If true, the directory is marked for deletion and will be deleted soon.

boolean

pre_provisioned_groups_enabled

Optional

To enable pre-provisioned groups, set the parameter to true

array of PreProvisionedGroupsTO

pre_provisioned_groups_list

Optional

List of pre provisioned groups associated with the directory.

string As uuid As uuid

ldap_configuration_uuid

Optional

Ldap Directory Configuration ID

Property Of

BrokerDirectoryList