LdapDirectoryConfigMedia

LdapDirectoryConfigMedia

Represents the directory configuration for a tenant

JSON Example

{
    "name": "example_ldap_dir_config_name",
    "domainControllerHost": "string",
    "domainControllerPort": 636,
    "domainControllerSecondaryHost": "string",
    "domainControllerSecondaryPort": 636,
    "type": "ACTIVE_DIRECTORY_LDAP",
    "certificate": {
        "filename": "server.crt",
        "certificate": "[\"-----BEGIN CERTIFICATE-----\\n<encoded-certificate>\\n-----END CERTIFICATE-----\\"
    },
    "secondaryServerCertificate": {
        "filename": "server.crt",
        "certificate": "[\"-----BEGIN CERTIFICATE-----\\n<encoded-certificate>\\n-----END CERTIFICATE-----\\"
    },
    "bindDn": "uid=admin,ou=system",
    "baseDn": "dc=example,dc=org",
    "directorySearchAttribute": "sAMAccountName",
    "communicationMode": "SSL",
    "groupsFilterQuery": "(objectClass=group)",
    "usersFilterQuery": "(objectClass=user)",
    "objectUuidAttribute": "entryUUID",
    "bindUserFilterQuery": "(objectClass=user)",
    "openLdapConfigurations": {
        "directorySearchUserAttribute": "uid",
        "directorySearchGroupAttribute": "memberOf",
        "uniquelyIdentifiableAttributeForUser": "distinguishedName",
        "uniquelyIdentifiableAttributeForGroup": "distinguishedName",
        "userMembershipsFilterQuery": "uid",
        "membershipAttribute": "member"
    },
    "brokerDirectoryId": "cb7acbfb-8202-4621-ad51-ade0ad49e2d1",
    "bindDnPassword": "sample_password",
    "_links": {
        "self": {
            "href": "https://example.com/path-to-self"
        }
    },
    "id": "5e895ddb-c2ae-414a-9db3-a2d693ee0db1",
    "useForAuthentication": true,
    "syncProfileConfig": {
        "identityInfo": {
            "includeNestedGroupsAndMembers": false,
            "identityGroupInfo": {
                "identityGroupInfo": {
                    "mappedGroupData": [
                        {
                            "mappedGroup": {
                                "groupName": "groupName",
                                "dn": "dc=vidb,dc=com",
                                "objectGuid": "dfd3c968-0b6d-4750-a66e-405d4c04c245",
                                "groupBaseDN": "CN=Users,DC=vidb,DC=com",
                                "source": "DIRECTORY",
                                "isCompliant": false,
                                "validationResult": {
                                    "invalidAttributes": [
                                        "string"
                                    ],
                                    "isDuplicateId": false
                                }
                            },
                            "selected": false
                        }
                    ],
                    "numSelected": 1,
                    "numTotal": 0,
                    "selected": true
                }
            },
            "identityUserInfo": {
                "identityUserInfo": {
                    "users": [
                        {
                            "userId": "2d825955-c4bc-4ea0-8c79-d1a0ed9a9de6",
                            "user": "John Doe",
                            "userDn": "CN=Administrator,CN=Users,DC=vidb,DC=com",
                            "mail": "[email protected]",
                            "admin": false,
                            "selected": false
                        }
                    ],
                    "numTotal": 0
                }
            },
            "allGroupsSelectedGroupDns": [
                "string"
            ],
            "groupNameOnlyGroupDNs": [
                "string"
            ],
            "entitledGroupsGroupDNs": [
                "string"
            ]
        },
        "syncSchedule": {
            "frequency": "string",
            "dayOfWeek": "string",
            "hour": 0,
            "minutes": 0,
            "seconds": 0
        },
        "_links": {
            "self": {
                "href": "https://example.com/path-to-self"
            }
        }
    }
}

string

name

Required

Constraints: maxLength: 64

Identifies the name of the LDAP directory configuration with the tenant

string

domainControllerHost

Required

Constraints: maxLength: 256

Identifies the Domain Controller host. LDAP is not a secure connection, its highly recommended to use LDAPS.

integer As int32 As int32

domainControllerPort

Required

Constraints: minimum: 1 maximum: 65535

Identifies the port of the single target directory's Domain Controller

string

domainControllerSecondaryHost

Optional

Constraints: maxLength: 256

Identifies the Domain Controller Secondary host. LDAP is not a secure connection, its highly recommended to use LDAPS.

integer As int32 As int32

domainControllerSecondaryPort

Optional

Constraints: minimum: 1 maximum: 65535

Identifies the secondary port of the single target directory's Domain Controller

string

type

Required

Identifies the Active Directory connection type

Possible values are : ACTIVE_DIRECTORY_LDAP, ACTIVE_DIRECTORY_DNS_LOOKUP, OPEN_LDAP, ACTIVE_DIRECTORY_GLOBAL_CATALOG,

Certificate

certificate

Optional

Represents an SSL certificate

Certificate

secondaryServerCertificate

Optional

Represents an SSL certificate

string

bindDn

Required

Identifies the bind distinguished name

string

baseDn

Optional

Identifies the base distinguished name

string

directorySearchAttribute

Required

Identifies the name of the attribute that will be used to search for users in a directory

string

communicationMode

Optional

Communication mode to use with the ldap server

Possible values are : SSL, UNSECURE,

string

groupsFilterQuery

Required

Custom filter query for groups in the schema

string

usersFilterQuery

Required

Custom filter query for Users in the schema

string

objectUuidAttribute

Required

Name of the UUID attribute for user or group in the schema

string

bindUserFilterQuery

Required

Custom filter query for bind user in the schema

OpenLdapConfigurations

openLdapConfigurations

Optional

OpenLDAP configurations, required when type = "OPEN_LDAP"

string As uuid As uuid

brokerDirectoryId

Optional

The unique identifier of the associated SCIM directory

string

bindDnPassword

Required

Identifies the bind distinguished name password

object

_links

Optional

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

string As uuid As uuid

id

Optional

Uniquely identifies the LDAP directory configuration

boolean

useForAuthentication

Optional

Indicates whether this LDAP directory configuration will be used for user authentication.If yes, it will be linked to the vIDB's embedded IdP.

LdapDirectorySyncProfileMedia

syncProfileConfig

Optional

Represents the Directory Sync Profile

Property Of

BrokerDirectorySwitchProvisioningRequestMedia