mirror of
				https://github.com/apache/cloudstack.git
				synced 2025-10-26 08:42:29 +01:00 
			
		
		
		
	
		
			
				
	
	
		
			61 lines
		
	
	
		
			2.7 KiB
		
	
	
	
		
			XML
		
	
	
	
	
	
			
		
		
	
	
			61 lines
		
	
	
		
			2.7 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="query-filter">
 | |
| <title>Query Filter</title>
 | |
| <para>The query filter is used to find a mapped user in the external LDAP server. The query filter should uniquely map the &PRODUCT; user to LDAP user for a meaningful authentication. For more information about query filter syntax, consult the documentation for your LDAP server.</para>
 | |
| <para>The &PRODUCT; query filter wildcards are:</para>    
 | |
|     <informaltable>
 | |
|         <tgroup cols="2" align="left" colsep="1" rowsep="1">
 | |
|         <thead>
 | |
|             <row>
 | |
|                 <entry><para>Query Filter Wildcard</para></entry>
 | |
|                 <entry><para>Description</para></entry>                                                                    
 | |
|             </row>
 | |
|         </thead>
 | |
|         <tbody>
 | |
|             <row>
 | |
|                 <entry><para>%u</para></entry>
 | |
|                 <entry><para>User name</para></entry>                                    
 | |
|             </row>
 | |
|             <row>
 | |
|                 <entry><para>%e</para></entry>
 | |
|                 <entry><para>Email address</para></entry>
 | |
|             </row>
 | |
|             <row>
 | |
|                 <entry><para>%n</para></entry>
 | |
|                 <entry><para>First and last name</para></entry>
 | |
|             </row>
 | |
|         </tbody>
 | |
|         </tgroup>
 | |
|     </informaltable>
 | |
| <para>The following examples assume you are using Active Directory, and refer to user attributes from the Active Directory schema.</para>
 | |
| <para>If the &PRODUCT; user name is the same as the LDAP user ID:</para>
 | |
| <programlisting>(uid=%u)</programlisting>
 | |
| <para>If the &PRODUCT; user name is the LDAP display name:</para>
 | |
| <programlisting>(displayName=%u)</programlisting>
 | |
| <para>To find a user by email address:</para>
 | |
| <programlisting>(mail=%e)</programlisting>
 | |
| </section>
 |