Open Registration

From DreamFactory
Jump to: navigation, search
DreamFactoryTutorialsOpen Registration
Line 1: Line 1:
### Tutorial
+
=== Tutorial ===
  
 
DreamFactory 2.0 supports open registration. By default it is disabled. To enable it, log into the admin console,  
 
DreamFactory 2.0 supports open registration. By default it is disabled. To enable it, log into the admin console,  
Line 11: Line 11:
 
[[File:Tutorial open registration1.png|800px]]
 
[[File:Tutorial open registration1.png|800px]]
  
### API Endpoint
+
=== API Endpoint ===
  
 
<pre>POST https://{url}/api/v2/user/register?login={bool}</pre>
 
<pre>POST https://{url}/api/v2/user/register?login={bool}</pre>
Line 25: Line 25:
  
  
### Example - Open Registration when email confirmation is required.
+
=== Example - Open Registration when email confirmation is required ===
  
 
* Request body:
 
* Request body:
Line 44: Line 44:
 
</source>
 
</source>
  
### Example - Open Registration and Login when email confirmation is required.
+
=== Example - Open Registration and Login when email confirmation is required ===
  
 
* Login: true
 
* Login: true
Line 65: Line 65:
 
</source>
 
</source>
  
> _Note: Forcing login during open registration will not work when email confirmation is required. Therefore, response
 
> includes "confirmation_required":true._
 
  
### Example - Open Registration when email confirmation is turned off.
+
    ''Note: Forcing login during open registration will not work when email confirmation is required. Therefore, response
 +
    includes "confirmation_required":true.''
 +
 
 +
=== Example - Open Registration when email confirmation is turned off ===
  
 
* Request body:
 
* Request body:
Line 88: Line 89:
 
</source>
 
</source>
  
### Example - Open Registration and Login when email confirmation is turned off.
+
=== Example - Open Registration and Login when email confirmation is turned off ===
  
 
* Login: true
 
* Login: true

Revision as of 17:02, 3 February 2016

Tutorial

DreamFactory 2.0 supports open registration. By default it is disabled. To enable it, log into the admin console, click on the services tab and select the user service. On the user service details page, click on the config tab. Check off the 'Allow Open Registration' checkbox there. On this config page you can also select a role in the 'Open Reg Role' field. This role will be used for all your self-registered users. If you would like to require your users to be verified using email confirmation then select an email service in the 'Open Reg Email Service' field. Choose an email template for your confirmation email in the 'Open Reg Email Template' field. If you do not choose an email service for Open Registration, your users will be forced to choose their password during registration.

Tutorial open registration1.png

API Endpoint

POST https://{url}/api/v2/user/register?login={bool}

Request body:

{
  "email": "user_email",        //Required field.
  "password": "password",       //Required only when no Open Registration Email Service is selected.
  "first_name": "first_name",
  "last_name": "last_name"
}


Example - Open Registration when email confirmation is required

  • Request body:
{
  "email": "[email protected]",
  "first_name": "John",
  "last_name": "Doe"
}
  • Request URL:
POST https://foo.com/api/v2/user/register
  • Response
{
    "success":true
}

Example - Open Registration and Login when email confirmation is required

  • Login: true
  • Request body:
{
  "email": "[email protected]",
  "first_name": "John",
  "last_name": "Doe"
}
  • Request URL:
POST https://foo.com/api/v2/user/register?login=true
  • Response
{
    "success":true,
    "confirmation_required": true
}


   Note: Forcing login during open registration will not work when email confirmation is required. Therefore, response 
   includes "confirmation_required":true.

Example - Open Registration when email confirmation is turned off

  • Request body:
{
  "email": "[email protected]",
  "password":"secret",
  "first_name": "John",
  "last_name": "Doe"
}
  • Request URL:
POST https://foo.com/api/v2/user/register
  • Response
{
    "success":true
}

Example - Open Registration and Login when email confirmation is turned off

  • Login: true
  • Request body:
{
  "email": "[email protected]",
  "password":"secret",
  "first_name": "John",
  "last_name": "Doe"
}
  • Request URL:
POST https://foo.com/api/v2/user/register?login=true
  • Response
{
	"success": true,
	"session_token": "abc.123.efg"
}