Skip to content

SSO account

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 JWT session token

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": "eyJhbGciOiJIUzI1NiIsInR5cCI6Ikp..."
}

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