OrgLdapSettings

Element:

OrgLdapSettings

Type:

OrgLdapSettingsType

Namespace:

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

Description:

Base settings for LDAP connection

Since:

1.5

Schema:

vCloudEntities.xsd

Media type(s):

application/vnd.vmware.admin.organizationLdapSettings+xml

Extends:

ResourceType

XML Representation:

<OrgLdapSettings xmlns="http://www.vmware.com/vcloud/v1.5" href="xs:anyURI" type="xs:string">
    <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string"/>
    <OrgLdapMode> xs:string </OrgLdapMode>
    <CustomUsersOu> xs:string </CustomUsersOu>
    <CustomOrgLdapSettings>
        <HostName> xs:string </HostName>
        <Port> xs:int </Port>
        <IsSsl> xs:boolean </IsSsl>
        <IsSslAcceptAll> xs:boolean </IsSslAcceptAll>
        <Realm> xs:string </Realm>
        <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>
            <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>
            <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>
    </CustomOrgLdapSettings>
</OrgLdapSettings>

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.
OrgLdapMode	string	0..1	always	1.5	Defines whether this organization is connected to an LDAP service, and whether it uses the system default LDAP service or a custom LDAP service. One of: NONE (This organization has no LDAP connection.), SYSTEM (This organization uses the system default LDAP service.), CUSTOM (This organization uses the LDAP service specified in CustomOrgLdapSettings.)
CustomUsersOu	string	0..1	always	1.0	If OrgLdapMode is SYSTEM, specifies an LDAP attribute=value pair to use for OU (organizational unit).
CustomOrgLdapSettings	CustomOrgLdapSettingsType	0..1	always	1.0	If OrgLdapMode=CUSTOM, this element defines the hostname and connection details for the organization's LDAP service.

Operations

CRUD	Operation	Description	Since
read	GET /admin/org/{id}/settings/ldap	Retrieves LDAP settings for an organization.	1.5
update	PUT /admin/org/{id}/settings/ldap	Updates LDAP settings for an organization.	1.5