Retrieving AD Groups

From DreamFactory
Jump to: navigation, search
DreamFactoryTutorialsRetrieving AD Groups
Line 1: Line 1:
### Tutorial
+
=== Tutorial ===
  
 
DreamFactory 2.0 Active Directory service allows you to retrieve your Active Directory Groups using the 'group' resource.
 
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  
 
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).
+
how to setup an Active Directory service see [[DreamFactory/Tutorials/Using_Active_Directory|Using Active Directory]].
  
### API Endpoints
+
=== API Endpoints ===
  
 
* To get a list of all Active Directory Groups and their details.
 
* To get a list of all Active Directory Groups and their details.
Line 14: Line 14:
 
<pre>GET http://{url}/api/v2/{ad_service}/group/{group_name}</pre>
 
<pre>GET http://{url}/api/v2/{ad_service}/group/{group_name}</pre>
  
### Example - Getting list of all Active Directory Groups with all fields.
+
=== Example - Getting list of all Active Directory Groups with all fields. ===
 
* Service name: ad
 
* Service name: ad
 
* Request URL:
 
* Request URL:
 
<pre>GET http://foo.com/api/v2/ad/group</pre>
 
<pre>GET http://foo.com/api/v2/ad/group</pre>
  
### Example - Getting list of all Active Directory Groups with a specific fields.
+
=== Example - Getting list of all Active Directory Groups with a specific fields. ===
 
* Service name: ad
 
* Service name: ad
 
* Fields to retrieve: dn,cn,member
 
* Fields to retrieve: dn,cn,member
Line 25: Line 25:
 
<pre>GET http://foo.com/api/v2/ad/group?fields=dn,cn,member</pre>
 
<pre>GET http://foo.com/api/v2/ad/group?fields=dn,cn,member</pre>
  
### Example - Getting a specific Group information.
+
=== Example - Getting a specific Group information. ===
 
* Service name: ad
 
* Service name: ad
 
* Group to retrieve: DreamFactory
 
* Group to retrieve: DreamFactory
Line 31: Line 31:
 
<pre>GET http://foo.com/api/v2/ad/group/DreamFactory</pre>
 
<pre>GET http://foo.com/api/v2/ad/group/DreamFactory</pre>
  
### Example - Getting list of Groups by Active Directory Username.
+
=== Example - Getting list of Groups by Active Directory Username. ===
 
* Service name: ad
 
* Service name: ad
 
* Active Directory Username: jdoe
 
* Active Directory Username: jdoe
Line 37: Line 37:
 
<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.
+
=== Example - Getting list of Groups by LDAP query filter. ===
 
* Service name: ad
 
* Service name: ad
 
* LDAP Query: (cn=Dream*) [List all groups where the cn starts with Dream]
 
* LDAP Query: (cn=Dream*) [List all groups where the cn starts with Dream]
 
* Request URL:
 
* Request URL:
 
<pre>GET http://foo.com/api/v2/ad/group?filter=(cn=Dream*)</pre>
 
<pre>GET http://foo.com/api/v2/ad/group?filter=(cn=Dream*)</pre>

Revision as of 18:34, 3 February 2016

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.

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}

Example - Getting list of all Active Directory Groups with all fields.

  • Service name: ad
  • Request URL:
GET http://foo.com/api/v2/ad/group

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

Example - Getting a specific Group information.

  • Service name: ad
  • Group to retrieve: DreamFactory
  • Request URL:
GET http://foo.com/api/v2/ad/group/DreamFactory

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

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*)