Auth API
Login with User and Password
POST /auth
Arguments
| Name | Type | Is Required | Default Value |
|---|---|---|---|
| user | Parameter | Yes | |
| password | Parameter | Yes | |
| locale | Parameter | No | RO |
Given
- A valid username.
- A valid password.
When
- The route is accessed.
Then
- The user is authenticated against the security service.
- Returns a WebSecurityAndToken.
Logout
HEAD /auth
Arguments
| Name | Type | Is Required | Default Value |
|---|---|---|---|
| logout | Parameter | No | |
| one.erp.rest.auth.token | Cookie | No |
Given
- A non empty logout parameter.
When
- The route is accessed.
Then
- The user identified by the token cookie is logged off from the security service.
- Returns a WebSecurityAndToken that signifies the user has been logged off.
Get authentication providers
GET /auth or OPTIONS /auth
Parameters
None.
Responses
200 Ok
The operation was successful.
{"providers": [
{
"name": "facebook",
"url": "https://www.facebook.com/v3.1/dialog/oauth?client_id=...&scope=email&state=...&redirect_uri=..."
},
{
"name": "google",
"url": "https://accounts.google.com/o/oauth2/v2/auth?scope=openid email&access_type=offline&state=...&include_granted_scopes=true&redirect_uri=...&response_type=code&client_id=..."
},
{
"name": "yahoo",
"url": "https://api.login.yahoo.com/oauth2/request_auth?scope=openid&redirect_uri=...&response_type=code&nonce=xxx&state=...&client_id=..."
}
]}
POST /auth
Create an entity.
Request
| Parameter | Type | Description |
|---|---|---|
| set-password | string | the new password |
Headers
| Header | Value | Description |
|---|---|---|
| Content-Type | application/x-www-form-urlencoded | |
| X-CSRF-Token | The value from the one.erp.csrf.token cookie. | CSRF protection token. |
Response
The operation is not authorized. Check if the authentication cookie is set. The operation is forbidden. Check if the X-CSRF-Token header is set and is correct. All errors except for JSON message deserialization errors.200 Ok
The operation was successful.401 Unauthorized
403 Forbidden
500 Internal Error
{
"detail": "error detail"
}
cURL Example
Set the password for the currently authenticated user
Given the following cURL request:
curl -X POST https://developer.oneerp.ro/auth
-H "Content-Type: application/x-www-form-urlencoded"
-d "set-password=1234"