Changes

stoney core: Search Resource Mapping (REST - LDAP)

2,266 bytes added, 13:29, 25 May 2014
/* People Search (GET) */
== Global Search (GET) ==
The global search only incorporates a subset of attributes in the search. Detailed examples are described under [[stoney core: Global Searches]].
 
Restrictions.
* To limit the hits per search, the default number of results is set to '''5''' per resource.
Do not forget to restrict the search according to the person who is currently logged in.
== Global Search Response Object (stoney core: Customers Resource) ==
All the resellers customers are stored under the sub tree [[stoney_core:_OpenLDAP_directory_data_organisation#Customers | ou=customers,dc=stoney-cloud,dc=org]]. The actual LDIF of a reseller customer is described under [[stoney_core:_OpenLDAP_directory_data_organisation#Customers_uid_.28per_customer.29 | Customer uid (per Customer)]].
The following LDAP attributes must be included in the search:
* uid (id)
* sstExternalID (externalID)
* organizationName (Company customer: This is the normal case, as we target companies (customerName = organizationName)).
* givenName (Private customer: A private customer does not have a company/organisation name (customerName = givenName surname)).
==== Search for the entered string ====
We presume, that the string to be searched for is '''rescus''' (scope is one, size limit is set to 5):
<pre>
ldapsearch -H ldaps://ldapm.stoney-cloud.org \
-z 5 \
-W -x -LLL \
"(|(uid=*cus*)(organizationName=*cus*)(sstExternalID=*cus*))" uid sstIsCompany sstIsActive organizationName givenName surname sstBelongsToResellerUID
</pre>
|}
== People Global Search Response Object (GETstoney core: People Resource) ==All the people are stored under the sub tree [[stoney_core:_OpenLDAP_directory_data_organisation#People | ou=people,dc=stoney-cloud,dc=org]]. The actual LDIF of a person is described under [[stoney_core:_OpenLDAP_directory_data_organisation#People_uid_.28per_person.29 | People uid (per Person)]]. The following LDAP attributes must be included in the search:* uid (id)* givenName (givenName)* surname (surname) The following LDAP attributes must be returned:* uid (id)* sstIsActive (isActive)* givenName (givenName)* surname (surname)* organizationName (customerName) or givenName and surname (customerName), the same logic applies as for the customer search* sstBelongsToResellerUID (belongsToResellerID)* sstBelongsToCustomerUID (belongsToCustomerID) === Sequence ===The following sequence describes the people search. ==== Search for the entered string ====We presume, that the string to be searched for is '''sto''' (scope is one, size limit is set to 5):<pre>ldapsearch -H ldaps://ldapm.stoney-cloud.org \ -b "ou=people,dc=stoney-cloud,dc=org" \ -s one \ -D "cn=Manager,dc=stoney-cloud,dc=org" \ -z 5 \ -W -x -LLL \ "(|(uid=*sto*)(givenName=*sto*)(surname=*sto*))" uid sstIsActive givenName surname sstBelongsToResellerUID sstBelongsToCustomerUID</pre> The possible answer could look as follows:<pre>dn: uid=4000002,ou=people,dc=stoney-cloud,dc=orguid: 4000002givenName: stoney cloudsn: AdministratorsstIsActive: TRUEsstBelongsToResellerUID: 4000000sstBelongsToCustomerUID: 4000001</pre> ==== Create a second search for each result ====As we are interested, to which customer the person belongs to, we need to execute a second search (scope is base):<pre>ldapsearch -H ldaps://ldapm.stoney-cloud.org \ -b "uid=4000001,ou=customers,dc=stoney-cloud,dc=org" \ -s base \ -D "cn=Manager,dc=stoney-cloud,dc=org" \ -z 5 \ -W -x -LLL \ "(objectclass=*)" organizationName givenName surname</pre> The possible answer could look as follows:<pre>dn: uid=4000001,ou=customers,dc=stoney-cloud,dc=orgo: Customer Ltd.</pre>
=== People Global Search Response Object (GETstoney core: People Resource) Mapping ===
{| border="1" class="wikitable sortable"
! API Attribute
SLB, editor, reviewer
3,407
edits