mirror of
https://github.com/apache/cloudstack.git
synced 2025-11-04 00:02:37 +01:00
524577307c
Adds Apache license to all the e-named files in the docs/en-US folder, also fixes the DTD to point to http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd instead of a file on the local drive, and adds &PRODUCT; in place of CloudPlatform or CloudStack.
48 lines
3.0 KiB
XML
48 lines
3.0 KiB
XML
<?xml version='1.0' encoding='utf-8' ?>
|
||
<!DOCTYPE section PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
||
<!ENTITY % BOOK_ENTITIES SYSTEM "cloudstack.ent">
|
||
%BOOK_ENTITIES;
|
||
]>
|
||
|
||
<!-- Licensed to the Apache Software Foundation (ASF) under one
|
||
or more contributor license agreements. See the NOTICE file
|
||
distributed with this work for additional information
|
||
regarding copyright ownership. The ASF licenses this file
|
||
to you under the Apache License, Version 2.0 (the
|
||
"License"); you may not use this file except in compliance
|
||
with the License. You may obtain a copy of the License at
|
||
|
||
http://www.apache.org/licenses/LICENSE-2.0
|
||
|
||
Unless required by applicable law or agreed to in writing,
|
||
software distributed under the License is distributed on an
|
||
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||
KIND, either express or implied. See the License for the
|
||
specific language governing permissions and limitations
|
||
under the License.
|
||
-->
|
||
|
||
<section id="example-LDAP-configuration-commands">
|
||
<title>Example LDAP Configuration Commands</title>
|
||
<para>To understand the examples in this section, you need to know the basic concepts behind calling the &PRODUCT; API, which are explained in the Developer’s Guide.</para>
|
||
<para>The following shows an example invocation of ldapConfig with an ApacheDS LDAP server</para>
|
||
<programlisting>http://127.0.0.1:8080/client/api?command=ldapConfig&hostname=127.0.0.1&searchbase=ou%3Dtesting%2Co%3Dproject&queryfilter=%28%26%28uid%3D%25u%29%29&binddn=cn%3DJohn+Singh%2Cou%3Dtesting%2Co%project&bindpass=secret&port=10389&ssl=true&truststore=C%3A%2Fcompany%2Finfo%2Ftrusted.ks&truststorepass=secret&response=json&apiKey=YourAPIKey&signature=YourSignatureHash</programlisting>
|
||
<para>The command must be URL-encoded. Here is the same example without the URL encoding:</para>
|
||
<programlisting>http://127.0.0.1:8080/client/api?command=ldapConfig
|
||
&hostname=127.0.0.1
|
||
&searchbase=ou=testing,o=project
|
||
&queryfilter=(&(%uid=%u))
|
||
&binddn=cn=John+Singh,ou=testing,o=project
|
||
&bindpass=secret
|
||
&port=10389
|
||
&ssl=true
|
||
&truststore=C:/company/info/trusted.ks
|
||
&truststorepass=secret
|
||
&response=json
|
||
&apiKey=YourAPIKey&signature=YourSignatureHash
|
||
</programlisting>
|
||
<para>The following shows a similar command for Active Directory. Here, the search base is the testing group within a company, and the users are matched up based on email address.</para>
|
||
<programlisting>http://10.147.29.101:8080/client/api?command=ldapConfig&hostname=10.147.28.250&searchbase=OU%3Dtesting%2CDC%3Dcompany&queryfilter=%28%26%28mail%3D%25e%29%29 &binddn=CN%3DAdministrator%2COU%3Dtesting%2CDC%3Dcompany&bindpass=1111_aaaa&port=389&response=json&apiKey=YourAPIKey&signature=YourSignatureHash</programlisting>
|
||
<para>The next few sections explain some of the concepts you will need to know when filling out the ldapConfig parameters. </para>
|
||
</section>
|