SSOAuthUser

Description: Performs single sign-on (SSO) authentication for a user by login. Returns user account data and a session token for further API use.

Access Control

🛡️ Access Level Required: SESSION_ADMIN

---

Request Parameters

Name	Type	Required	Description
login	int	Yes	User login ID to authenticate

Request Example

{
  "login": 123456
}

---

Response Parameters

Name	Type	Description
id	int	User ID (same as login)
login	int	User login
regdate	int	Registration timestamp
leverage	int	User's leverage
email	string	Email address
name	string	Full name
phone	string	Phone number
address	string	Address
city	string	City
state	string	State
country	string	Country
zipcode	string	Zip code
group	string	Trading group
currency	string	Group base currency
__token	string	Existing primary JWT session token
__datalake_token	string or null	License-signed Data Lake token; may be null if the active v2 signer or authorization context is unavailable

---

Response Example

{
  "id": 123456,
  "login": 123456,
  "regdate": 1695000000,
  "leverage": 100,
  "email": "[email protected]",
  "name": "John Doe",
  "phone": "+1234567890",
  "address": "123 Wall Street",
  "city": "New York",
  "state": "NY",
  "country": "US",
  "zipcode": "10005",
  "group": "standard",
  "currency": "USD",
  "__token": "<HS256 session JWT>",
  "__datalake_token": "<EdDSA Data Lake JWT or null>"
}

Only __token is the normal session token. The Data Lake token is a separate response value; see Data Lake token profile.

---

Possible Errors

Error Code	Description
INVALID_DATA	Missing or invalid request fields
USER_NOT_FOUND_OR_INCORRECT	User login does not exist
GROUP_NOT_FOUND	User group could not be loaded
INVALID_MARGIN_LEVEL	Error while calculating user margin level
USER_DISABLED	User is not enabled
BRAND_NOT_AVAILABLE	User brand is not admitted by the negotiated license policy