Retrieving AD Users

From DreamFactory
Jump to: navigation, search
DreamFactoryTutorialsRetrieving AD Users
(Created page with "### Tutorial DreamFactory 2.0 Active Directory service allows you to retrieve your Active Directory Users using the 'user' resource. This tutorial focuses on retrieving Acti...")
 
Line 28: Line 28:
 
* Service name: ad
 
* Service name: ad
 
* Username to retrieve: jdoe
 
* Username to retrieve: jdoe
 +
* Request URL:
 +
<pre>GET http://foo.com/api/v2/ad/user/jdoe</pre>
 +
 +
### Example - Getting a list of users by LDAP query filter.
 +
* Service name: ad
 +
* LDAP Query: (sn=Doe) [List users where the sn (last name) is Doe]
 
* Request URL:
 
* Request URL:
 
<pre>GET http://foo.com/api/v2/ad/user/jdoe</pre>
 
<pre>GET http://foo.com/api/v2/ad/user/jdoe</pre>

Revision as of 17:10, 2 February 2016

      1. Tutorial

DreamFactory 2.0 Active Directory service allows you to retrieve your Active Directory Users using the 'user' resource.

This tutorial focuses on retrieving Active Directory Users using an existing DreamFactory Active Directory service. To learn how to setup an Active Directory service see [Using Active Directory](DreamFactory/Tutorials/Using_Active_Directory).

      1. API Endpoints
  • To get a list of all Active Directory Users and their details.
GET http://{url}/api/v2/{ad_service}/user
  • To get details about a specific User.
GET http://{url}/api/v2/{ad_service}/user/{username}
      1. Example - Getting list of all Active Directory Users with all fields.
  • Service name: ad
  • Request URL:
GET http://foo.com/api/v2/ad/user
      1. Example - Getting list of all Active Directory Users with a specific fields.
  • Service name: ad
  • Fields to retrieve: sn,givenname
  • Request URL:
GET http://foo.com/api/v2/ad/user?fields=sn,givenname
      1. Example - Getting a specific User information.
  • Service name: ad
  • Username to retrieve: jdoe
  • Request URL:
GET http://foo.com/api/v2/ad/user/jdoe
      1. Example - Getting a list of users by LDAP query filter.
  • Service name: ad
  • LDAP Query: (sn=Doe) [List users where the sn (last name) is Doe]
  • Request URL:
GET http://foo.com/api/v2/ad/user/jdoe