auth_login

global   unauth

Starts a new session for:

Depending on the session impersonation, the range of available APIs differs.

User sessions are initiated by setting the Login parameter to the users’ login and the IsUser parameter to true.

Developer sessions are initiated by setting the Login parameter to the developers’ login.

API Client sessions are initiated by setting the Login parameter to the registered APIKey and the IsApi parameter to true.

The Hash value of a login request is calculated as:

Hash = base64encode( sha3_256( Nonce+TimeStamp+Secret ))

For subsequent requests, the base64 SHA3 hash of SessionNonce+Secret has to be used as the SessionKey in signing. The Secret is the same secret used for generating the Hash value of the login request.

The Timestamp variable encodes microseconds since 1900-1-1 00:00 UTC and is safe for dates between 1900-1-1 00:00 UTC and (roughly) 2185-1-1 00:00 UTC. Use the following formula to calculate the Timestamp from UNIX timestamp in milliseconds:

TimeStamp = (UNIX_TimeStamp + 2208988800000) * 1000

Input

SDK Type: AuthLoginIn FZeuzAuthLoginIn AuthLoginIn

Field Type Notes
Login string Login Name
IsUser bool Set to true if the provided credentials are from a user
IsApi bool Set to true if the provided credentials are a combination of api key and secret
Time int64
Nonce string
Hash string

Output

SDK Type: AuthLoginResult FZeuzAuthLoginResult AuthLoginResult

Field Type Notes
Dev string
User string
ApiKey string
Proj string
SessionID string
SessionNonce string
ValidThru int64