View source for OperatorAPI login

''newadmapi (Operator API) function. Available to: '''Operator, SuperRoot'''.''

== Description ==
Exchanges an operator ukey for a short, revocable session. The key goes in the X-API-Key HEADER and is never accepted in the query string or body. Every failure returns the same auth_invalid, so a blocked key cannot be told apart from an unknown one.

== Call ==
 GET|POST https://YOUR_HOST:9089/newadm?func=login
Send your API key with every request (header <code>X-API-Key: YOUR_KEY</code>, or <code>Authorization: Bearer YOUR_KEY</code>, or the <code>ukey</code> query parameter).

== Parameters ==
None beyond the API key and <code>func=login</code>.

== Example ==
 <nowiki>https://host:port/newadm?func=login</nowiki>

== Response ==
Success is <code>{"ok":true,"data":{...}}</code>; on refusal <code>{"ok":false,"code":"...","message":"..."}</code>. This function's data shape (<code>n</code> = number, <code>s</code> = string, <code>?</code> = present only when set):
<pre>
{
  "ok":true,
  "data":{
    "session":s,
    "operator":{
      "accountcode":s,
      "name":s,
      "groups":[
        s
      ],
      "readonly":b
    }
  }
}
</pre>

== Errors ==
Refusals carry a machine-readable <code>code</code> (branch on the code, never the message). See [[OperatorAPI#Error codes]].

----
Back to [[OperatorAPI]]
[[Category:OperatorAPI]]