Get All LDAP Server Settings

Retrieves details of all the LDAP servers that are available in vCenter Chargeback Manager. A Super User can see all the LDAP servers configured in the application. An Administrator can see only the LDAP servers that he has configured.

Syntax

The syntax for calling this API is:

GET <Base_URL>/ldapServers

A sample API call is as follows:

GET https://123.123.123.123/vCenter-CB/api/ldapServers

User Privilege

You must have the Super User role or Administrator role.

API Response

If the request succeeds, the API returns an XML with details of all LDAP servers that are available in vCenter Chargeback Manager. The following table provides the information about the response XML.

XPath

Type

Min Occurs

Max Occurs

Description

LdapServers/LdapServer

 

0

1

This is the LdapServer element.

LdapServers/LdapServer/@id

xs:int

1

1

The LDAP server ID. This ID will be the same as the LDAP Server ID provided in the URL.

LdapServers/LdapServer/Host

xs:string

1

1

URL with the IP address or the FQDN of the LDAP server.

LdapServers/LdapServer/Port

xs:int

1

1

Port on which the LDAP Server service is listening.

LdapServers/LdapServer/BaseDn

xs:string

1

1

The distinguished name (DN) of the entity in the LDAP hierarchy from which groups and users can be added to the application.

LdapServers/LdapServer/ LdapServerName

xs:string

1

1

Name of the LDAP server used by an LDAP user logging into vCenter Chargeback Manager.

LdapServers/LdapServer/LdapServerType/@id

xs:int

1

1

Integer to indicate type of the LDAP server. Currently the only supported LDAP Server type is Active Directory.

LdapServers/LdapServer/Limit

xs:int

1

1

The maximum number of Active Directory users or groups retrieved
and to be displayed in the Add Users Account screen of the application.

LdapServers/LdapServer/SslEnabled

xs:boolean

1

1

Indicates whether communication with the LDAP Server is done over SSL or not. Valid value can be true or false.

A sample response is provided here.