---
title: "Authentication API endpoints"
description: "Endpoint reference for the Authentication tag (3 endpoints): Login, token management, and password operations"
type: "reference"
audience: [network-manager, admin]
keywords: [api, rest, endpoints, authentication]
---

Fetch the complete documentation index at: https://epom.com/ad-server/docs/llms.txt. Use this file to discover all available pages before exploring further. Append .md to any documentation page URL to get its markdown version.

# Authentication API endpoints

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](https://epom.com/ad-server/docs/api.md). Parameters marked `form` go in an `application/x-www-form-urlencoded` request body.

### GET /rest-api/auth/{authToken}/login.do

[Request examples](https://epom.com/ad-server/docs/api/authentication/get-auth-login.md)

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](https://epom.com/ad-server/docs/api.md#error-codes).

### POST /rest-api/auth/forgot.do

[Request examples](https://epom.com/ad-server/docs/api/authentication/post-auth-forgot.md)

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](https://epom.com/ad-server/docs/api.md#error-codes).

### POST /rest-api/auth/token.do

[Request examples](https://epom.com/ad-server/docs/api/authentication/post-auth-token.md)

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](https://epom.com/ad-server/docs/api.md#error-codes).

## Related

- [REST API overview](https://epom.com/ad-server/docs/api.md) — authentication and conventions
- [API endpoint reference by tag](https://epom.com/ad-server/docs/api/endpoints.md)

<!-- Generated from the OpenAPI spec. Do not edit by hand. -->