Retrieving AD Groups

From DreamFactory
Jump to: navigation, search
DreamFactoryTutorialsRetrieving AD Groups
Line 36: Line 36:
 
* Request URL:
 
* Request URL:
 
<pre>GET http://foo.com/api/v2/ad/group?user=jdoe</pre>
 
<pre>GET http://foo.com/api/v2/ad/group?user=jdoe</pre>
 +
 +
### Example - Getting list of Groups by LDAP query filter.
 +
* Service name: ad
 +
* LDAP Query: (cn=Dream*) [List all groups where the cn starts with Dream]
 +
* Request URL:
 +
<pre>GET http://foo.com/api/v2/ad/group?filter=(cn=Dream*)</pre>

Revision as of 17:08, 2 February 2016

      1. Tutorial

DreamFactory 2.0 Active Directory service allows you to retrieve your Active Directory Groups using the 'group' resource.

This tutorial focuses on retrieving Active Directory Groups 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 Groups and their details.
GET http://{url}/api/v2/{ad_service}/group
  • To get details about a specific Group.
GET http://{url}/api/v2/{ad_service}/group/{group_name}
      1. Example - Getting list of all Active Directory Groups with all fields.
  • Service name: ad
  • Request URL:
GET http://foo.com/api/v2/ad/group
      1. Example - Getting list of all Active Directory Groups with a specific fields.
  • Service name: ad
  • Fields to retrieve: dn,cn,member
  • Request URL:
GET http://foo.com/api/v2/ad/group?fields=dn,cn,member
      1. Example - Getting a specific Group information.
  • Service name: ad
  • Group to retrieve: DreamFactory
  • Request URL:
GET http://foo.com/api/v2/ad/group/DreamFactory
      1. Example - Getting list of Groups by Active Directory Username.
  • Service name: ad
  • Active Directory Username: jdoe
  • Request URL:
GET http://foo.com/api/v2/ad/group?user=jdoe
      1. Example - Getting list of Groups by LDAP query filter.
  • Service name: ad
  • LDAP Query: (cn=Dream*) [List all groups where the cn starts with Dream]
  • Request URL:
GET http://foo.com/api/v2/ad/group?filter=(cn=Dream*)