Access Using JWT

From DreamFactory
Jump to: navigation, search
DreamFactoryTutorialsAccess Using JWT
Line 1: Line 1:
### Tutorial
+
=== Tutorial ===
  
 
DreamFactory 2.0 APIs can be consumed with just a JWT (token) from an authenticated session. JWT from an admin user's  
 
DreamFactory 2.0 APIs can be consumed with just a JWT (token) from an authenticated session. JWT from an admin user's  
Line 5: Line 5:
 
require an API Key and their access will be limited by the role assigned to them for the application of the API key being used.
 
require an API Key and their access will be limited by the role assigned to them for the application of the API key being used.
  
### API Endpoints
+
=== API Endpoints ===
  
 
<pre>{Method} https://{url}/api/v2/{service}/{resource}?session_token={JWT}</pre>
 
<pre>{Method} https://{url}/api/v2/{service}/{resource}?session_token={JWT}</pre>
Line 19: Line 19:
 
</pre>
 
</pre>
  
### Example - Using URL parameter
+
=== Example - Using URL parameter ===
  
 
* Service: system
 
* Service: system
Line 28: Line 28:
 
<pre>GET https://foo.com/api/v2/system/user?session_token=abc.123.efg</pre>
 
<pre>GET https://foo.com/api/v2/system/user?session_token=abc.123.efg</pre>
  
### Example - Using request header
+
=== Example - Using request header ===
  
 
* Service: system
 
* Service: system

Revision as of 17:18, 3 February 2016

Tutorial

DreamFactory 2.0 APIs can be consumed with just a JWT (token) from an authenticated session. JWT from an admin user's session will allow full access to the system. Non-admin users cannot consume any protected APIs using just a JWT. He/she will also require an API Key and their access will be limited by the role assigned to them for the application of the API key being used.

API Endpoints

{Method} https://{url}/api/v2/{service}/{resource}?session_token={JWT}

-- OR --

{Method} https://{url}/api/v2/{service}/{resource}

Request header

...
X-DreamFactory-Session-Token: {JWT}
...

Example - Using URL parameter

  • Service: system
  • Resource: user
  • Session Token: abc.123.efg
  • Method: GET
  • Request URL:
GET https://foo.com/api/v2/system/user?session_token=abc.123.efg

Example - Using request header

  • Service: system
  • Resource: user
  • Session Token: abc.123.efg
  • Method: GET
  • Request Header:
...
X-DreamFactory-Session-Token: abc.123.efg
...
  • Request URL:
GET https://foo.com/api/v2/system/user