Retrieving AD Computers
From DreamFactory
(Created page with "### Tutorial DreamFactory 2.0 Active Directory service allows you to retrieve your Active Directory Computers using the 'computer' resource. This tutorial focuses on retriev...") |
|||
| Line 1: | Line 1: | ||
| − | + | === Tutorial === | |
DreamFactory 2.0 Active Directory service allows you to retrieve your Active Directory Computers using the 'computer' resource. | DreamFactory 2.0 Active Directory service allows you to retrieve your Active Directory Computers using the 'computer' resource. | ||
This tutorial focuses on retrieving Active Directory Computers using an existing DreamFactory Active Directory service. To learn | This tutorial focuses on retrieving Active Directory Computers using an existing DreamFactory Active Directory service. To learn | ||
| − | how to setup an Active Directory service see [ | + | how to setup an Active Directory service see [[DreamFactory/Tutorials/Using_Active_Directory|Using Active Directory]]. |
| − | + | === API Endpoints === | |
* To get a list of all Active Directory Computers and their details. | * To get a list of all Active Directory Computers and their details. | ||
| Line 14: | Line 14: | ||
<pre>GET http://{url}/api/v2/{ad_service}/computer/{computer_name}</pre> | <pre>GET http://{url}/api/v2/{ad_service}/computer/{computer_name}</pre> | ||
| − | + | === Example - Getting list of all Active Directory Computers with all fields. === | |
* Service name: ad | * Service name: ad | ||
* Request URL: | * Request URL: | ||
<pre>GET http://foo.com/api/v2/ad/computer</pre> | <pre>GET http://foo.com/api/v2/ad/computer</pre> | ||
| − | + | === Example - Getting list of all Active Directory Computers with a specific fields. === | |
* Service name: ad | * Service name: ad | ||
* Fields to retrieve: cn,dn | * Fields to retrieve: cn,dn | ||
| Line 25: | Line 25: | ||
<pre>GET http://foo.com/api/v2/ad/computer?fields=cn,dn</pre> | <pre>GET http://foo.com/api/v2/ad/computer?fields=cn,dn</pre> | ||
| − | + | === Example - Getting a specific Computer information. === | |
* Service name: ad | * Service name: ad | ||
* Username to retrieve: MSSQL | * Username to retrieve: MSSQL | ||
| Line 31: | Line 31: | ||
<pre>GET http://foo.com/api/v2/ad/computer/MSSQL</pre> | <pre>GET http://foo.com/api/v2/ad/computer/MSSQL</pre> | ||
| − | + | === Example - Getting a list of Computers by LDAP query filter. === | |
* Service name: ad | * Service name: ad | ||
* LDAP Query: (cn=*server) [List computers where the cn ends with server] | * LDAP Query: (cn=*server) [List computers where the cn ends with server] | ||
* Request URL: | * Request URL: | ||
<pre>GET http://foo.com/api/v2/ad/computer?filter=(cn=*server)</pre> | <pre>GET http://foo.com/api/v2/ad/computer?filter=(cn=*server)</pre> | ||
Revision as of 18:36, 3 February 2016
Contents
- 1 Tutorial
- 2 API Endpoints
- 3 Example - Getting list of all Active Directory Computers with all fields.
- 4 Example - Getting list of all Active Directory Computers with a specific fields.
- 5 Example - Getting a specific Computer information.
- 6 Example - Getting a list of Computers by LDAP query filter.
Tutorial
DreamFactory 2.0 Active Directory service allows you to retrieve your Active Directory Computers using the 'computer' resource.
This tutorial focuses on retrieving Active Directory Computers 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 Computers and their details.
GET http://{url}/api/v2/{ad_service}/computer
- To get details about a specific Computer.
GET http://{url}/api/v2/{ad_service}/computer/{computer_name}
Example - Getting list of all Active Directory Computers with all fields.
- Service name: ad
- Request URL:
GET http://foo.com/api/v2/ad/computer
Example - Getting list of all Active Directory Computers with a specific fields.
- Service name: ad
- Fields to retrieve: cn,dn
- Request URL:
GET http://foo.com/api/v2/ad/computer?fields=cn,dn
Example - Getting a specific Computer information.
- Service name: ad
- Username to retrieve: MSSQL
- Request URL:
GET http://foo.com/api/v2/ad/computer/MSSQL
Example - Getting a list of Computers by LDAP query filter.
- Service name: ad
- LDAP Query: (cn=*server) [List computers where the cn ends with server]
- Request URL:
GET http://foo.com/api/v2/ad/computer?filter=(cn=*server)
