PUT /admin/org/{id}/settings/ldap

Operation:

PUT /admin/org/{id}/settings/ldap

Description:

Update organization LDAP settings.

Since:

1.5

Deprecated:

Since 5.1

Input parameters

Consume media type(s):

application/vnd.vmware.admin.organizationLdapSettings+xml

Input type:

OrgLdapSettingsType

Output parameters

{@link JAXBElement}

Produce media type(s):

application/vnd.vmware.admin.organizationLdapSettings+xml

Output type:

OrgLdapSettingsType

Examples

Request

HTTP 1.1
PUT /api/admin/org/7cc8d565-1203-49bd-b50c-24e0acbaeb5a/settings/ldap

Headers:
Content-Length: 2054
Content-Type: application/vnd.vmware.admin.organizationLdapSettings+xml; charset=ISO-8859-1
x-vcloud-authorization: FQMWZgFq5mhMRSpt2ecxnsAXTxRpxdbZ/z2u6uwEH+w=

Body:

<?xml version="1.0" encoding="UTF-8"?><vcloud:OrgLdapSettings
    xmlns:vcloud="http://www.vmware.com/vcloud/v1.5">
    <vcloud:OrgLdapMode>CUSTOM</vcloud:OrgLdapMode>
    <vcloud:CustomOrgLdapSettings>
        <vcloud:HostName>example.com</vcloud:HostName>
        <vcloud:Port>389</vcloud:Port>
        <vcloud:IsSsl>false</vcloud:IsSsl>
        <vcloud:IsSslAcceptAll>false</vcloud:IsSslAcceptAll>
        <vcloud:SearchBase>dc=example,dc=com</vcloud:SearchBase>
        <vcloud:UserName>cn=user,dc=example,dc=com</vcloud:UserName>
        <vcloud:Password>password</vcloud:Password>
        <vcloud:AuthenticationMechanism>SIMPLE</vcloud:AuthenticationMechanism>
        <vcloud:IsGroupSearchBaseEnabled>false</vcloud:IsGroupSearchBaseEnabled>
        <vcloud:ConnectorType>OPEN_LDAP</vcloud:ConnectorType>
        <vcloud:UserAttributes>
            <vcloud:ObjectClass>user</vcloud:ObjectClass>
            <vcloud:ObjectIdentifier>objectGuid</vcloud:ObjectIdentifier>
            <vcloud:UserName>sAMAccountName</vcloud:UserName>
            <vcloud:Email>mail</vcloud:Email>
            <vcloud:FullName>displayName</vcloud:FullName>
            <vcloud:GivenName>givenName</vcloud:GivenName>
            <vcloud:Surname>sn</vcloud:Surname>
            <vcloud:Telephone>telephoneNumber</vcloud:Telephone>
            <vcloud:GroupMembershipIdentifier>dn</vcloud:GroupMembershipIdentifier>
            <vcloud:GroupBackLinkIdentifier>tokenGroups</vcloud:GroupBackLinkIdentifier>
        </vcloud:UserAttributes>
        <vcloud:GroupAttributes>
            <vcloud:ObjectClass>group</vcloud:ObjectClass>
            <vcloud:ObjectIdentifier>objectGuid</vcloud:ObjectIdentifier>
            <vcloud:GroupName>cn</vcloud:GroupName>
            <vcloud:Membership>member</vcloud:Membership>
            <vcloud:MembershipIdentifier>dn</vcloud:MembershipIdentifier>
            <vcloud:BackLinkIdentifier>objectSid</vcloud:BackLinkIdentifier>
        </vcloud:GroupAttributes>
    </vcloud:CustomOrgLdapSettings>
</vcloud:OrgLdapSettings>

Response

HTTP/1.1 200 OK

Headers:
Content-Length: 3278
Content-Type: application/vnd.vmware.admin.organizationldapsettings+xml;version=5.5
Vary: Accept-Encoding

Body:

<?xml version="1.0" encoding="UTF-8"?><OrgLdapSettings
    xmlns="http://www.vmware.com/vcloud/v1.5"
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    href="https://vcloud.example.com/api/admin/org/7cc8d565-1203-49bd-b50c-24e0acbaeb5a/settings/ldap"
    type="application/vnd.vmware.admin.organizationLdapSettings+xml"
    xsi:schemaLocation="http://www.vmware.com/vcloud/v1.5 http://https://vcloud.example.com/api/v1.5/schema/master.xsd">
    <Link
        href="https://vcloud.example.com/api/admin/org/7cc8d565-1203-49bd-b50c-24e0acbaeb5a/settings/ldap"
        rel="edit"
        type="application/vnd.vmware.admin.organizationLdapSettings+xml"/>
    <Link
        href="https://vcloud.example.com/api/admin/org/7cc8d565-1203-49bd-b50c-24e0acbaeb5a/settings/ldap/action/updateLdapCertificate"
        rel="certificate:update"
        type="application/vnd.vmware.admin.certificateUpdateParams+xml"/>
    <Link
        href="https://vcloud.example.com/api/admin/org/7cc8d565-1203-49bd-b50c-24e0acbaeb5a/settings/ldap/action/resetLdapCertificate"
        rel="certificate:reset"/>
    <Link
        href="https://vcloud.example.com/api/admin/org/7cc8d565-1203-49bd-b50c-24e0acbaeb5a/settings/ldap/action/updateLdapKeyStore"
        rel="keystore:update"
        type="application/vnd.vmware.admin.keystoreUpdateParams+xml"/>
    <Link
        href="https://vcloud.example.com/api/admin/org/7cc8d565-1203-49bd-b50c-24e0acbaeb5a/settings/ldap/action/resetLdapKeyStore"
        rel="keystore:reset"/>
    <Link
        href="https://vcloud.example.com/api/admin/org/7cc8d565-1203-49bd-b50c-24e0acbaeb5a/settings/ldap/action/updateLdapSspiKeytab"
        rel="keytab:update"
        type="application/vnd.vmware.admin.sspiKeytabUpdateParams+xml"/>
    <Link
        href="https://vcloud.example.com/api/admin/org/7cc8d565-1203-49bd-b50c-24e0acbaeb5a/settings/ldap/action/resetLdapSspiKeytab"
        rel="keytab:reset"/>
    <OrgLdapMode>CUSTOM</OrgLdapMode>
    <CustomOrgLdapSettings>
        <HostName>example.com</HostName>
        <Port>389</Port>
        <IsSsl>false</IsSsl>
        <IsSslAcceptAll>false</IsSslAcceptAll>
        <SearchBase>dc=example,dc=com</SearchBase>
        <UserName>cn=user,dc=example,dc=com</UserName>
        <AuthenticationMechanism>SIMPLE</AuthenticationMechanism>
        <IsGroupSearchBaseEnabled>false</IsGroupSearchBaseEnabled>
        <ConnectorType>OPEN_LDAP</ConnectorType>
        <UserAttributes>
            <ObjectClass>user</ObjectClass>
            <ObjectIdentifier>objectGuid</ObjectIdentifier>
            <UserName>sAMAccountName</UserName>
            <Email>mail</Email>
            <FullName>displayName</FullName>
            <GivenName>givenName</GivenName>
            <Surname>sn</Surname>
            <Telephone>telephoneNumber</Telephone>
            <GroupMembershipIdentifier>dn</GroupMembershipIdentifier>
            <GroupBackLinkIdentifier>tokenGroups</GroupBackLinkIdentifier>
        </UserAttributes>
        <GroupAttributes>
            <ObjectClass>group</ObjectClass>
            <ObjectIdentifier>objectGuid</ObjectIdentifier>
            <GroupName>cn</GroupName>
            <Membership>member</Membership>
            <MembershipIdentifier>dn</MembershipIdentifier>
            <BackLinkIdentifier>objectSid</BackLinkIdentifier>
        </GroupAttributes>
        <UseExternalKerberos>false</UseExternalKerberos>
    </CustomOrgLdapSettings>
</OrgLdapSettings>