Authentication
Authentication
Benlly Platform provide authentication method as per OAuth 2.0 Framework’s specification (RFC 6749).Register User
You can execute this process by making a POST request to the endpoint /api/oauth/token.Request Header
There are no required Request Headers.URL Parameters
There are no required URL Parameters.Request Parameters
Name | Description | Type | Example |
---|---|---|---|
grant_type | Grant Type as per (RFC 6749) specification. For Register User, we use custom grant type: register | String | register |
client_id | Client ID that was registered beforehand with Benlly Platform | Integer | 123465789 |
client_secret | Client Secret that was provided when register client | String | 0sgF8AClPDRcwRFYZpcmKwySdQDEPDzo3IaG0uEf |
username | A pair of client_id / username MUST be unique | String | Myusername |
password | User’s password that we want to create | String | Mypassword |
scope | Should be NULL in this case | String |
Response Format
Name | Description | Type | Example |
---|---|---|---|
token_type | The type of return access token. | String | Bearer |
access_token | Access Token. This will be used for future authentication | String | <access_token> |
expires_in | How long this access token will last, measure in seconds | Integer | 31536000 |
refresh_token | Use this to get new access token when the old one expired | String | <refresh_token> |
Example
{
"token_type": "Bearer",
"expires_in": 31536000,
"access_token": "eyJ0eXAiOiJKV1QiLCJhbGciOiJSUzI1NiIsImp0aSI6ImY2MDkzZmEwNmM3NTc1OTk5OTAzNzMwZGQ0ZTY1ZjkwODU0YWZlMTU3MDhhNjcxYTdiZDhjY2I2MzhiYmFiMjRkYTU0YzYyZTFhM2ZiMjJjIn0.eyJhdWQiOiIxNjc4NCIsImp0aSI6ImY2MDkzZmEwNmM3NTc1OTk5OTAzNzMwZGQ0ZTY1ZjkwODU0YWZlMTU3MDhhNjcxYTdiZDhjY2I2MzhiYmFiMjRkYTU0YzYyZTFhM2ZiMjJjIiwiaWF0IjoxNTAxNTcwMzkwLCJuYmYiOjE1MDE1NzAzOTAsImV4cCI6MTUzMzEwNjM5MCwic3ViIjoiMyIsInNjb3BlcyI6W119.rCkFLJXMCEWTP2Vh0_K20fFD1VdE1GE5fH-MRpm4mlaC3cRYRgEdFjIxnqi9du6LZs7SIkDdlTZ2AgaiUb3Vf4LEBmDnJe3UyBgDKPZWKiyRrV2boV3dzvF-FSXdIQYl7Z9iX3BSN8b2EmQTXx3hz1b_Lv7-szlnL0Awgn5g_D5GCk21PWqrOD4c1_VxTAk--C5FhM8a1J6rqxKGKblFcabZcJNEWdFjIPbZjI81szsJsUG6zdchqDNeIoKjX9sPFtNbJaaLPas9A1vl969PYceZT8jfto22h72riUJ4LIDMNIqYI8ndL9uX9grnqniDSeNHk1Svlwg22EZJphPkpBTC9zsxuKqCTOAL-zTHDUgYA3R5am8W5sEEVRmuykjNXfiCUxeLwHR3taLP_M2aHorgsPyVKZqqMDY2xt6zezwBquKc3UdsiSDTSx_JjGAAT_8nvoAciHh7rxCRNsYLWGJJbBjPW38PAqIVwXrySKYG-eBxnSnJyWzBWjJ155dzFBWlkLYnniDYv5m9_V6VblVON6UN7WFLYEqzR7hXpA9_fBZFIlCS0iNZMLK3Kp8lzmDT3uTXV9iBG4LJTiqy3UuDH82gv0LsGLHxeBrDFlhzjsiqjrcfmWQSkXytKnrVBJVE37KYR1-PokXaZqE0t7yIEjfR3AGjNftV0H0IZh0",
"refresh_token": "MyrZ92aOs37fDdKZu+7zSCXg1FNoY63CeBaHilYXSZXx7FXchvyDEIofgPQ3bOWitgg+76jzEzbqWduSKEc3vR6R6C221TbMaoFToMN9KY8LUg7pQOrFFb+Wa19nDRkVz7COMSqOFMCBHEpW5Z/yfrpDXh29AnELg1F26Qxb584joHlk8ReEeZb4akVggM3A9gpGenI1xHnpCybuMPjx8VOFbaG106zAducy3M5lesTRP0QLzIt5eljghYTJr+K8S9QvZeN4QN6TPZk+0zuyvtmA7vtI2OhLNRzgeDqk3yTmEWI7bU3pDLMzYBqzk1TtKcrfzG/z57U6DtUwWOV4VWD9GS/KSc8oGIgJhopHjyQDWhf96cqyQXIeTt6jUKxrEVGOmy5DBTRbsv837jVI5ulQZZUpWMS5YI7lC40dvgw78i0qPkLPm+b5/fxw+/26iPHZgXNy3l6JC1e1vQesKOpe13mfcTMcH7hnBchv6csR4J6iHsrCLFwibUmqG2v6b5RXmma2Lnzc/qPj7AeYYpg/hyd6SQJF6VxLo13auQ7ucqqqJkjby3UM76mVlj+dU7satjWtSF6mFRoc1vwtrFY37QrQcDIblDv+ZTzoojtiAwzz5rWk7+Ax//FPC6huSDrjTHejSJlfq3y9PNzTimny0sGWq9c8ywWyyAE6MKQ="
}