Using LDAP
BrigetteJjf (Talk | contribs) (Created page with "I'm Manual and I live in Wandearah. <br>I'm interested in American Politics, Speed skating and English art. I like travelling and watching Psych.<br><br>My web page; [http://w...") |
(Created page with "### Tutorial To use LDAP authentication in a DreamFactory Instance, you need to provision an LDAP service first. You can provision an LDAP service from the 'Services' tab in...") |
||
Line 1: | Line 1: | ||
− | + | ### Tutorial | |
+ | |||
+ | To use LDAP authentication in a DreamFactory Instance, you need to provision an LDAP | ||
+ | service first. You can provision an LDAP service from the 'Services' tab in Admin Console. Click on the 'Create' | ||
+ | button on the services tab to create a new service. Select 'LDAP Integration' from the 'Service Type' | ||
+ | drop down menu. For the name field use a short, meaningful, one word name for your service. This will be used as your | ||
+ | LDAP service identifier. Fill out rest of the information on this form and then go to 'Config' tab. | ||
+ | |||
+ | [[File:Tutorial using ldap 1.png|800px]] | ||
+ | |||
+ | On the config form you will need to provide all the details of your LDAP server and select a default role for your | ||
+ | LDAP service. This role will be assigned (for all applications in the system) to all users signing in using this LDAP service. | ||
+ | |||
+ | [[File:Tutorial using ad 2.png|800px]] | ||
+ | |||
+ | ### API Endpoint | ||
+ | |||
+ | <pre>POST https://your-url/api/v2/user/session?service={ldap_service_name}</pre> | ||
+ | <source lang="JavaScript"> | ||
+ | { | ||
+ | "username" : "user_name", | ||
+ | "password" : "password" | ||
+ | } | ||
+ | </source> | ||
+ | |||
+ | -- OR -- | ||
+ | |||
+ | <pre>POST https://your-url/api/v2/user/session</pre> | ||
+ | <source lang="JavaScript"> | ||
+ | { | ||
+ | "username" : "user_name", | ||
+ | "password" : "password", | ||
+ | "service" : "ldap_service_name" | ||
+ | } | ||
+ | </source> | ||
+ | |||
+ | ### Example - Sign-in using LDAP Authentication | ||
+ | |||
+ | * Service name: demo | ||
+ | * Request URL: <pre>POST https://your-url/api/v2/user/session?service=demo</pre> | ||
+ | <source lang="JavaScript"> | ||
+ | { | ||
+ | "username" : "user_name", | ||
+ | "password" : "password" | ||
+ | } | ||
+ | </source> | ||
+ | * Response: | ||
+ | <source lang="JavaScript"> | ||
+ | { | ||
+ | "session_token": “abc.123abc.efg”, | ||
+ | "session_id": “abc.123abc.efg”, | ||
+ | "id": 1, | ||
+ | "name": "John", | ||
+ | "first_name": "John", | ||
+ | "last_name": "Doe", | ||
+ | "email": "jdoe@gmail.com", | ||
+ | "is_sys_admin": false, | ||
+ | "last_login_date": "2015-06-30 16:46:59", | ||
+ | "host": "your-url" | ||
+ | } | ||
+ | </source> |
Revision as of 21:00, 21 September 2015
- Tutorial
To use LDAP authentication in a DreamFactory Instance, you need to provision an LDAP service first. You can provision an LDAP service from the 'Services' tab in Admin Console. Click on the 'Create' button on the services tab to create a new service. Select 'LDAP Integration' from the 'Service Type' drop down menu. For the name field use a short, meaningful, one word name for your service. This will be used as your LDAP service identifier. Fill out rest of the information on this form and then go to 'Config' tab.
On the config form you will need to provide all the details of your LDAP server and select a default role for your LDAP service. This role will be assigned (for all applications in the system) to all users signing in using this LDAP service.
- API Endpoint
POST https://your-url/api/v2/user/session?service={ldap_service_name}
{ "username" : "user_name", "password" : "password" }
-- OR --
POST https://your-url/api/v2/user/session
{ "username" : "user_name", "password" : "password", "service" : "ldap_service_name" }
- Example - Sign-in using LDAP Authentication
- Service name: demo
- Request URL:
POST https://your-url/api/v2/user/session?service=demo
{ "username" : "user_name", "password" : "password" }
- Response:
{ "session_token": “abc.123abc.efg”, "session_id": “abc.123abc.efg”, "id": 1, "name": "John", "first_name": "John", "last_name": "Doe", "email": "jdoe@gmail.com", "is_sys_admin": false, "last_login_date": "2015-06-30 16:46:59", "host": "your-url" }