Authentication

Endpoints for user authentication.

Authenticates a user for the current websocket session

post

https://apstage.proxy.kiiex.io/aphttps://alphaprod.proxy.kiiex.io/ap

/AuthenticateUser

Authenticates using either username/password or API key method.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Authentication result

application/json

authenticatedbooleanOptional

lockedbooleanOptional

requires2FAbooleanOptional

twoFATypestringOptional

twoFATokenstringOptional

400

Invalid authentication request format

401

Invalid credentials or token

post

/AuthenticateUser

HTTPcURLJavaScriptPython

POST /ap/AuthenticateUser HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 85

{
  "APIKey": "text",
  "Signature": "text",
  "UserId": "text",
  "UserName": "text",
  "Nonce": "text"
}

{
  "user": {
    "userId": 1,
    "userName": "text",
    "email": "text",
    "emailVerified": true,
    "accountId": 1,
    "omsId": 1,
    "use2FA": true
  },
  "authenticated": true,
  "locked": true,
  "requires2FA": true,
  "twoFAType": "text",
  "twoFAToken": "text"
}