ipx::auth

Endpoint ipx::auth::post_loginSource

POST /api/login
    body   Credentials
    ->     Me

Sign in with a name and password, for a session cookie.

Answers who signed in and sets the session cookie, which lasts session_days from the last request. A script is better off with an API token, which needs no password kept.

Access: none

Body

Credentials, as JSON.

Returns

Me, as JSON.

Errors

401 Unauthorized

The name or password is wrong.

Example

curl -c cookies -H "Content-Type: application/json" \
  -d '{"name":"sam","password":"…"}' "http://<your server>:8099/api/login"