Configuration of LDAP parameters associated with an enterprise. This will enable authentication through an external LDAP server for this enterprise.
This object has no members.
Accept all certificates from the LDAP server
SDK attribute: acceptAllCertificates
The certificate to authenticate with the LDAP server
Format: free
SDK attribute: certificate
Time stamp when this object was created.
SDK attribute: creationDate
Metadata objects associated with this entity. This will contain a list of Metadata objects if the API request is made using the special flag to enable the embedded Metadata feature. Only a maximum of Metadata objects is returned based on the value set in the system configuration.
SDK attribute: embeddedMetadata
To enable LDAP authentication for an enterprise, set this attribute to true. If enabled is set to false, authorizationEnabled attribute is ignored and LDAP is not used for authentication as well as authorization. The relationship between enabled and authorizationEnabled attributes is as follows, enabled = true, authorizationEnabled = false, LDAP is used only for Authentication enabled = true, authorizationEnabled = true, LDAP is used for both authentication and authorization. enabled = false, authorizationEnabled = true, LDAP is not used. enabled = false, authorizationEnabled = false, LDAP is not used.
SDK attribute: enabled
Specify if scope of entity is Data center or Enterprise level
Allowed values: ENTERPRISE, GLOBAL
SDK attribute: entityScope
External object ID. Used for integration with third party systems
Format: free
SDK attribute: externalID
This attribute is a mandatory field for LDAP authorization. When LDAP is used for authorization for an enterprise, the group DN will be used to get the list of VSD specific groups in LDAP server for the enterprise. For example, OU=VSDGroups,DC=company,DC=com
Format: free
SDK attribute: groupDN
If this is specified, Prefix+Pre-definedGroupName will be used to look for users.
Format: free
SDK attribute: groupNamePrefix
If this is specified, Pre-definedGroupName+Suffix will be used to look for users.
Format: free
SDK attribute: groupNameSuffix
ID of the user who last updated the object.
Format: free
SDK attribute: lastUpdatedBy
Time stamp when this object was last updated.
SDK attribute: lastUpdatedDate
Identifies the user that has created this object.
Format: free
SDK attribute: owner
This attribute is a mandatory field for LDAP authorization. Password that will be used to verify the integrity of groups and users in LDAP server for the enterprise.
Format: free
Min length: 1
Max length: 255
SDK attribute: password
Port to be used for the LDAP server
Format: free
SDK attribute: port
The LDAP server IP or FQDN
Format: free
SDK attribute: server
Enable SSL for communication with the LDAP server
SDK attribute: SSLEnabled
The DN template to be used for authentication. The template needs to have a string _USERID_ in it. This will be replaced by the userId of the user who makes the REST API call. For example, template UID=_USERID_,OU=company,DC=com will converted to UID=admin,OU=company,DC=com and this will be used as DN for LDAP authentication.
Format: free
SDK attribute: userDNTemplate
This is an optional field. This is a LDAP property. If specified, it will be used as the VSD username per organization.
Format: free
SDK attribute: userNameAttribute