LdapSettings

Element:

LdapSettings

Type:

LdapSettingsType

Namespace:

http://www.vmware.com/vcloud/extension/v1.5

Description:

Defines the hostname and connection details for system LDAP service.

Since:

1.5

Schema:

settings.xsd

Media type(s):

application/vnd.vmware.admin.ldapSettings+xml

Extends:

ResourceType

XML Representation:

<LdapSettings xmlns="http://www.vmware.com/vcloud/extension/v1.5" xmlns:vcloud_v1.5="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string">
    <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string"/>
    <HostName> xs:string </HostName>
    <Port> xs:int </Port>
    <IsSsl> xs:boolean </IsSsl>
    <IsSslAcceptAll> xs:boolean </IsSslAcceptAll>
    <Realm> xs:string </Realm>
    <PagedSearchDisabled> xs:boolean </PagedSearchDisabled>
    <PageSize> xs:int </PageSize>
    <MaxResults> xs:int </MaxResults>
    <MaxUserGroups> xs:int </MaxUserGroups>
    <SearchBase> xs:string </SearchBase>
    <UserName> xs:string </UserName>
    <Password> xs:string </Password>
    <AuthenticationMechanism> xs:string </AuthenticationMechanism>
    <GroupSearchBase> xs:string </GroupSearchBase>
    <IsGroupSearchBaseEnabled> xs:boolean </IsGroupSearchBaseEnabled>
    <ConnectorType> xs:string </ConnectorType>
    <UserAttributes href="xs:anyURI" type="xs:string">
        <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                rel="xs:string"/>
        <ObjectClass> xs:string </ObjectClass>
        <ObjectIdentifier> xs:string </ObjectIdentifier>
        <UserName> xs:string </UserName>
        <Email> xs:string </Email>
        <FullName> xs:string </FullName>
        <GivenName> xs:string </GivenName>
        <Surname> xs:string </Surname>
        <Telephone> xs:string </Telephone>
        <GroupMembershipIdentifier> xs:string </GroupMembershipIdentifier>
        <GroupBackLinkIdentifier> xs:string </GroupBackLinkIdentifier>
    </UserAttributes>
    <GroupAttributes href="xs:anyURI" type="xs:string">
        <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                rel="xs:string"/>
        <ObjectClass> xs:string </ObjectClass>
        <ObjectIdentifier> xs:string </ObjectIdentifier>
        <GroupName> xs:string </GroupName>
        <Membership> xs:string </Membership>
        <MembershipIdentifier> xs:string </MembershipIdentifier>
        <BackLinkIdentifier> xs:string </BackLinkIdentifier>
    </GroupAttributes>
</LdapSettings>

Attributes

Attribute	Type	Required	Modifiable	Since	Description
href	anyURI	No	always	1.5	Contains the URI to the entity.
type	string	No	always	1.5	Contains the type of the entity.

Elements

Element	Type	Occurrence	Modifiable	Since	Description
VCloudExtension	VCloudExtensionType	0..*	always	1.5	An optional extension element that can contain an arbitrary number of elements and attributes.
Link	LinkType	0..*	none	1.5	Optional link to an entity or operation associated with this object.
HostName	string	0..1	always	1.5	Hostname of the LDAP server.
Port	int	1	always	1.5	Port at which to connect to the LDAP service.
IsSsl	boolean	1	always	1.5	True if the LDAP service requires an SSL connection.
IsSslAcceptAll	boolean	1	always	1.5	True if the LDAP service accepts all SSL certificates.
Realm	string	0..1	always	1.5	LDAP realm to use when looking up users.
PagedSearchDisabled	boolean	1	always	1.5	True if paged search is disabled.
PageSize	int	0..1	always	1.5	Size of the page.
MaxResults	int	0..1	always	1.5	Maximum results returned.
MaxUserGroups	int	0..1	always	1.5	Maximum results returned for user groups.
SearchBase	string	0..1	always	1.5	LDAP search base.
UserName	string	0..1	always	1.5	Username to use when logging in to LDAP, specified using LDAP attribute=value pairs (for example: cn="ldap-admin", c="example", dc="com").
Password	string	0..1	always	1.5	On modify, the presence of this element indicates a change in the password, absence indicates that the password should remain the same. Never returned on a GET request. Password for the user identified by UserName. This value is never returned by GET. It is inspected on create and modify. On modify, the absence of this element indicates that the password should not be changed.
AuthenticationMechanism	string	1	always	1.5	Defines the authentication mechanism used by the LDAP service.
GroupSearchBase	string	0..1	always	1.5	LDAP group search base.
IsGroupSearchBaseEnabled	boolean	1	always	1.5	True if the group search base is enabled.
ConnectorType	string	1	always	1.5	Defines the type of the LDAP service.
UserAttributes	LdapUserAttributesType	1	always	1.5	Defines how LDAP attributes are used when importing a user.
GroupAttributes	LdapGroupAttributesType	1	always	1.5	Defines how LDAP attributes are used when importing a group.

Operations

CRUD	Operation	Description	Since
read	GET /admin/extension/settings/ldapSettings	Retrieves the {@link LdapSpec}.	1.5
as input	PUT /admin/extension/settings/ldapSettings	Updates the {@link LdapSpec}.	1.5