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)
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

client_ipstring required

Example request

{
  "password": {
    "username": "admin",
    "password": "mypassword"
  }
}

Response

Success

password_days_until_expireinteger required

password_hours_until_expireinteger required

Example response

{
  "token": {
    "token": "1d3123585728afee5c37d410a2fbad43",
    "fullname": "admin",
    "server": "server1",
    "username": "admin",
    "password": "mypassword",
    "email": "user@email.com",
    "role": "admin",
    "timeout": 300,
    "locale": "en",
    "role_domains": {
      "role": "admin"
    },
    "last_login_timestamp": 1505755716,
    "login_count": 1
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.