Difference between revisions of "stoney core: Search Resource Mapping (REST - LDAP)"
From stoney cloud
| [unchecked revision] | [unchecked revision] |
| Line 4: | Line 4: | ||
= stoney core: search resource methods = | = stoney core: search resource methods = | ||
| − | == | + | == Global Search (GET) == |
| − | The | + | The global search only incorporates a subset of attributes in the search. Detailed examples are described under [[stoney core: Global Searches]]. |
| − | == | + | == Global Search Response Object (stoney core: Resellers Resource) == |
| + | All the resellers are stored under the sub tree [[stoney_core:_OpenLDAP_directory_data_organisation#Reseller | ou=reseller,dc=stoney-cloud,dc=org]]. The actual LDIF of a reseller is described under [[stoney_core:_OpenLDAP_directory_data_organisation#Reseller_uid_.28per_Reseller.29 | Reseller uid (per Reseller)]]. | ||
| + | |||
| + | The following LDAP attributes must be included in the search: | ||
| + | * uid (id) | ||
| + | * organizationName (resellerName) | ||
| + | |||
| + | The following LDAP attributes must be returned (this requires a sub search on each dn found): | ||
| + | * uid (id) | ||
| + | * sstIsCompany (isCompany) | ||
| + | * sstIsActive (isActive) | ||
| + | * organizationName (resellerName) | ||
| + | * countryName (countryCode) | ||
| + | * postalCode (postalCode) | ||
| + | * localityName (localityName) | ||
| + | |||
| + | === Global Search Response Object (stoney core: Resellers Resource) Mapping === | ||
{| border="1" class="wikitable sortable" | {| border="1" class="wikitable sortable" | ||
! API Attribute | ! API Attribute | ||
! LDAP Attribute | ! LDAP Attribute | ||
|- | |- | ||
| + | |||
| id | | id | ||
| uid | | uid | ||
|- | |- | ||
| − | | | + | |
| − | | | + | | isCompany |
| + | | sstIsCompany | ||
| + | |- | ||
| + | |||
| + | | isActive | ||
| + | | sstIsActive | ||
| + | |- | ||
| + | |||
| + | | countryCode | ||
| + | | postalCode | ||
| + | |- | ||
| + | |||
| + | |||
| + | | resellerName | ||
| + | | organizationName | ||
| + | |- | ||
| + | |||
| + | |||
| + | | resellerName | ||
| + | | postalCode | ||
| + | |- | ||
| + | |||
| + | |||
| + | | localityName | ||
| + | | localityName | ||
|- | |- | ||
|} | |} | ||
| − | == | + | |
| + | == Global Search Response Object (stoney core: Customers Resource) == | ||
The following sequence describes the customers search: | The following sequence describes the customers search: | ||
| − | === | + | === Global Search Response Object (stoney core: Customers Resource) Mapping === |
{| border="1" class="wikitable sortable" | {| border="1" class="wikitable sortable" | ||
! API Attribute | ! API Attribute | ||
Revision as of 16:45, 14 May 2014
Also visit stoney core: Search Resource - REST API and stoney core: Global Searches.
Contents
Overview
stoney core: search resource methods
Global Search (GET)
The global search only incorporates a subset of attributes in the search. Detailed examples are described under stoney core: Global Searches.
Global Search Response Object (stoney core: Resellers Resource)
All the resellers are stored under the sub tree ou=reseller,dc=stoney-cloud,dc=org. The actual LDIF of a reseller is described under Reseller uid (per Reseller).
The following LDAP attributes must be included in the search:
- uid (id)
- organizationName (resellerName)
The following LDAP attributes must be returned (this requires a sub search on each dn found):
- uid (id)
- sstIsCompany (isCompany)
- sstIsActive (isActive)
- organizationName (resellerName)
- countryName (countryCode)
- postalCode (postalCode)
- localityName (localityName)
Global Search Response Object (stoney core: Resellers Resource) Mapping
| API Attribute | LDAP Attribute |
|---|---|
| id | uid |
| isCompany | sstIsCompany |
| isActive | sstIsActive |
| countryCode | postalCode |
| resellerName | organizationName |
| resellerName | postalCode |
| localityName | localityName |
Global Search Response Object (stoney core: Customers Resource)
The following sequence describes the customers search:
Global Search Response Object (stoney core: Customers Resource) Mapping
| API Attribute | LDAP Attribute |
|---|---|
| id | uid |
| user |
People Search (GET)
The following sequence describes the people search:
People Search (GET) Mapping
| API Attribute | LDAP Attribute |
|---|---|
| id | uid |
| user |
