---
title: "Login Authentication"
method: POST
path: "/auth"
tags: ["Authentication"]
---

# Login Authentication

`POST /auth`

## Request

- Base URL: `/v1` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/v1/auth`
- Auth: none declared
- TypeScript: <https://skmtc.dev/neuvector/apis/neuvector-api/docs/auth/post.ts> (a function with typed inputs; its response is checked against the schema)

## Request body

- RESTAuthData
  - `client_ip` string, required
  - `password` RESTAuthPassword
    - `username` string, required
    - `password` string, required
  - `Token` RESTAuthToken
    - `token` string, required
    - `state` string, required
    - `redirect_endpoint` string, required

## Response `200`

Success

- RESTTokenData
  - `token` RESTToken, required
    - `token` string, required
    - `fullname` string, required
    - `server` string, required
    - `username` string, required
    - `password` string, required
    - `email` string, required
    - `role` string, required
    - `timeout` integer, required
    - `locale` string, required
    - `default_password` boolean, required
    - `modify_password` boolean, required
    - `role_domains` object
      - `role` string
      - `domains` string[]
    - `last_login_timestamp` integer, required
    - `last_login_at` string, required
    - `login_count` integer, required
  - `password_days_until_expire` integer, required
  - `password_hours_until_expire` integer, required

## Other responses

- `401`: Authentication failed

---

[API](https://skmtc.dev/neuvector/apis/neuvector-api.md) - [All operations](https://skmtc.dev/neuvector/apis/neuvector-api/llms.txt) - [OpenAPI document](https://skmtc.dev/neuvector/apis/neuvector-api/revisions/b8d8d28840b3?raw)