Creating users

From DreamFactory
Jump to: navigation, search
DreamFactoryTutorialsCreating users
Line 1: Line 1:
### Tutorial
+
=== Tutorial ===
  
 
There are two types of users in a DreamFactory 2.0 instance - Admins and Users (non-admins). Admins are part of system and  
 
There are two types of users in a DreamFactory 2.0 instance - Admins and Users (non-admins). Admins are part of system and  
Line 6: Line 6:
 
API endpoints.  
 
API endpoints.  
  
### Creating Admins
+
=== Creating Admins ===
  
 
Log into the admin console and click on the 'Admins' tab. From there click on the 'Create' button from the left menu. Fill out  
 
Log into the admin console and click on the 'Admins' tab. From there click on the 'Create' button from the left menu. Fill out  
 
the new admin form and click on the 'Create' form button. You must be an admin to create another admin account.  
 
the new admin form and click on the 'Create' form button. You must be an admin to create another admin account.  
  
#### API Endpoint
+
==== API Endpoint ====
  
 
<pre>POST https://{url}/api/v2/system/admin?session_token={jwt_for_an_admin_session}</pre>
 
<pre>POST https://{url}/api/v2/system/admin?session_token={jwt_for_an_admin_session}</pre>
Line 31: Line 31:
 
> _Note: Session token can also be supplied using X-DreamFactory-Session-Token request header._
 
> _Note: Session token can also be supplied using X-DreamFactory-Session-Token request header._
  
#### Example - Creating an Admin
+
==== Example - Creating an Admin ====
  
 
* Session Token: abc.123.efg
 
* Session Token: abc.123.efg
Line 52: Line 52:
  
  
### Creating Users
+
=== Creating Users ===
  
 
Log into the admin console and click on the 'Users' tab. From there click on the 'Create' button from the left menu. Fill out  
 
Log into the admin console and click on the 'Users' tab. From there click on the 'Create' button from the left menu. Fill out  
Line 60: Line 60:
 
or a user with role-service access to 'POST api/v2/system/user' API to create another user.
 
or a user with role-service access to 'POST api/v2/system/user' API to create another user.
  
#### API Endpoints  
+
==== API Endpoints ====
  
##### With email invitation:
+
===== With email invitation: =====
  
 
<pre>POST https://{url}/api/v2/system/user?send_invite=true&session_token={jwt_for_an_user_session_with_proper_role}</pre>
 
<pre>POST https://{url}/api/v2/system/user?send_invite=true&session_token={jwt_for_an_user_session_with_proper_role}</pre>
Line 79: Line 79:
 
</source>
 
</source>
  
##### Without email invitation:
+
===== Without email invitation: =====
  
 
<pre>POST https://{url}/api/v2/system/user?session_token={jwt_for_an_user_session_with_proper_role}</pre>
 
<pre>POST https://{url}/api/v2/system/user?session_token={jwt_for_an_user_session_with_proper_role}</pre>
Line 100: Line 100:
 
> _Note: Session token can also be supplied using X-DreamFactory-Session-Token request header._
 
> _Note: Session token can also be supplied using X-DreamFactory-Session-Token request header._
  
#### Example - Creating an User  
+
==== Example - Creating an User ====
  
##### With email invitation:
+
===== With email invitation: =====
  
 
* Session Token: abc.123.efg
 
* Session Token: abc.123.efg
Line 123: Line 123:
  
  
##### Without email invitation:
+
===== Without email invitation: =====
  
 
* Session Token: abc.123.efg
 
* Session Token: abc.123.efg

Revision as of 16:12, 3 February 2016

Tutorial

There are two types of users in a DreamFactory 2.0 instance - Admins and Users (non-admins). Admins are part of system and uses the API api/v2/system/admin. Users are part of the df-user (https://github.com/dreamfactorysoftware/df-user) package and uses the API api/v2/system/user. This tutorial will go over creating both Admins and Users using admin console as well as the API endpoints.

Creating Admins

Log into the admin console and click on the 'Admins' tab. From there click on the 'Create' button from the left menu. Fill out the new admin form and click on the 'Create' form button. You must be an admin to create another admin account.

API Endpoint

POST https://{url}/api/v2/system/admin?session_token={jwt_for_an_admin_session}

Request body:

{
  "resource": [
    {
      "name": "display_name",           //Required field
      "first_name": "user_first_name",
      "last_name": "user_last_name",
      "email": "email_address",         //Required field
      "password": "password"
    }
  ]
}

> _Note: Session token can also be supplied using X-DreamFactory-Session-Token request header._

Example - Creating an Admin

  • Session Token: abc.123.efg
  • Request body:
{
  "resource": [
    {
      "name": "John",
      "first_name": "John",
      "last_name": "Doe",
      "email": "[email protected]",
      "password": "secret"
    }
  ]
}
  • Request URL:
POST https://foo.com/api/v2/system/admin?session_token=abc.123.efg


Creating Users

Log into the admin console and click on the 'Users' tab. From there click on the 'Create' button from the left menu. Fill out the new user form and click on the 'Create' form button. You can send out an email invitation to the new user by checking off the 'Send Email Invitation' checkbox before creating the user. If you send out email invitation then there is no need to manually set the password as the user will create his/her own password using the invitation email. You need to be an admin or a user with role-service access to 'POST api/v2/system/user' API to create another user.

API Endpoints

With email invitation:
POST https://{url}/api/v2/system/user?send_invite=true&session_token={jwt_for_an_user_session_with_proper_role}

Request body:

{
  "resource": [
    {
      "name": "display_name",           //Required field
      "first_name": "user_first_name",
      "last_name": "user_last_name",
      "email": "email_address"          //Required field
    }
  ]
}
Without email invitation:
POST https://{url}/api/v2/system/user?session_token={jwt_for_an_user_session_with_proper_role}

Request body:

{
  "resource": [
    {
      "name": "display_name",           //Required field
      "first_name": "user_first_name",
      "last_name": "user_last_name",
      "email": "email_address",         //Required field
      "password": "password"
    }
  ]
}


> _Note: Session token can also be supplied using X-DreamFactory-Session-Token request header._

Example - Creating an User

With email invitation:
  • Session Token: abc.123.efg
  • Send Invite: true
  • Request Body:
{
  "resource": [
    {
      "name": "John",
      "first_name": "John",
      "last_name": "Doe",
      "email": "[email protected]"
    }
  ]
}
  • Request URL:
POST https://foo.com/api/v2/system/user?send_invite=true&session_token=abc.123.efg


Without email invitation:
  • Session Token: abc.123.efg
  • Request Body:
{
  "resource": [
    {
      "name": "John",
      "first_name": "John",
      "last_name": "Doe",
      "email": "[email protected]",
      "password": "secret"
    }
  ]
}
  • Request URL:
POST https://foo.com/api/v2/system/user?session_token=abc.123.efg