Authentication

The zeuz Authentication service provides a unified login facility across all platforms.

Endpoints

 auth_check

Scope: Global   Authentication: unauth

Verifies a logged in session is still valid.

Returns the Timestamp of when the session will expire or the invalid timestamp (0) if the session is not valid.

Input

SessionID (String)

Output

int64


 auth_login

Scope: Global   Authentication: 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

Data type GO: AuthLoginIn UE4: FZeuzAuthLoginIn C#: 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

Data type GO: AuthLoginResult UE4: FZeuzAuthLoginResult C#: AuthLoginResult

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

 auth_logout

Scope: Global   Authentication: unauth

Terminates a session.

Input

SessionID (String)

Output

This endpoint has no output.