Retrieving AD Groups
From DreamFactory
Contents
- 1 Tutorial
- 2 API Endpoints
- 3 Example - Get list of all Active Directory Groups with all fields.
- 4 Example - Getting list of all Active Directory Groups with a specific fields.
- 5 Example - Getting a specific Group information.
- 6 Example - Getting list of Groups by Active Directory Username.
- 7 Example - Getting list of Groups by LDAP query filter.
Tutorial
DreamFactory's 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 se tup 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 - Get 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*)