Access Using JWT
From DreamFactory
(Created page with "Hi there, I am Joan but you can call me anything you such as. I used to be unemployed now I am an interviewer as well as the salary has actually been actually satisfying. As...") |
(Created page with "### 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 syst...") |
||
Line 1: | Line 1: | ||
− | + | ### 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 | ||
+ | |||
+ | <pre>{Method} https://{url}/api/v2/{service}/{resource}?session_token={JWT}</pre> | ||
+ | |||
+ | -- OR -- | ||
+ | |||
+ | <pre>{Method} https://{url}/api/v2/{service}/{resource}</pre> | ||
+ | Request header | ||
+ | <pre> | ||
+ | ... | ||
+ | X-DreamFactory-Session-Token: {JWT} | ||
+ | ... | ||
+ | </pre> | ||
+ | |||
+ | ### Example - Using URL parameter | ||
+ | |||
+ | * Service: system | ||
+ | * Resource: user | ||
+ | * Session Token: abc.123.efg | ||
+ | * Method: GET | ||
+ | * Request URL: | ||
+ | <pre>GET https://foo.com/api/v2/system/user?session_token=abc.123.efg</pre> | ||
+ | |||
+ | ### Example - Using Request header | ||
+ | |||
+ | * Service: system | ||
+ | * Resource: user | ||
+ | * Session Token: abc.123.efg | ||
+ | * Method: GET | ||
+ | * Request Header: | ||
+ | <pre> | ||
+ | ... | ||
+ | X-DreamFactory-Session-Token: abc.123.efg | ||
+ | ... | ||
+ | </pre> | ||
+ | * Request URL: | ||
+ | <pre>GET https://foo.com/api/v2/system/user</pre> |
Revision as of 21:44, 14 October 2015
- 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