Authentication API endpoints
Endpoint reference for the Authentication tag (3 endpoints): Login, token management, and password operations
Login, token management, and password operations. 3 endpoints, generated from the OpenAPI spec. Authentication, the response envelope, pagination and error codes are shared by all endpoints — see REST API overview. Parameters marked form go in an application/x-www-form-urlencoded request body.
GET /rest-api/auth/{authToken}/login.do
Login with authentication token.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
authToken | path | string | yes | One-time authentication token obtained from POST /rest-api/auth/token.do. Valid for one minute and consumed on first use. A random 128-bit value as 32 hex characters. |
json | query | boolean | no | If true, returns the result as JSON instead of performing a redirect. Defaults to false. |
Responses: 200 — Authentication result (JSON/JSONP) containing ‘success’, ‘redirectUrl’, or ‘error’ fields · 302 — Redirect to /index.do (default mode when neither ‘callback’ nor ‘json’ are specified) · 404 — Not found — resource does not exist. Errors follow the shared conventions.
POST /rest-api/auth/forgot.do
Reset forgotten password.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
email | form | string | no | Email address associated with the account |
Responses: 200 — Password reset email sent (or no-op if email not found). Errors follow the shared conventions.
POST /rest-api/auth/token.do
Obtain authentication token.
| Parameter | In | Type | Required | Description |
|---|---|---|---|---|
username | form | string | yes | The username of the account to authenticate. Must correspond to an existing active user. |
password | form | string | yes | The user’s password. |
Responses: 200 — Token generated successfully. Response JSON: {success: true, authToken: ’…’, role: ’…’}. Errors follow the shared conventions.
Related
- REST API overview — authentication and conventions
- API endpoint reference by tag
