MAGES User Authentication

The MAGES User Authentication module controls the user licensing system of MAGES application.

By default, applications created with MAGES are free to play for all your users. However, you can use the user authentication module to restrict or give access to certain users in your MAGES applications.

Additionally, user authentication is required to upload your analytics report to the ORamVR portal (or your own hosted portal).

When the Authentication system is activated, the login UI will spawn in front of the user to enter the credentials.

../../_images/user_auth_login.png

After the user enters his/her account, the Operation Start initializes and the simulation continues.

Note

The scenegraph waits for the user to enter the credentials. Then if everything is ok it initializes the first action.

User Authentication Advanced Settings

The image below shows the MAGES authorization module from the MAGES Panel.

../../_images/user_auth_module.png

Important

To enable the login functionality just check the Require User Login toggle.

Option Name

Explanation

Require User Login And License Before Operation

If True, when the user enters the simulation, the Login UI will spawn asking to enter the username and the password.

Product Code

The product code is a string that defines each product. For example a product code of a simulation can be “TKA” or “Topographical Anatomy”. This is used to search if the user has license on this product and upload his/her analytics on the cloud for the corresponding product.

Authentication UI

The UI that will be displayed to the user asking for the application credentials.

Client Id

A public identifier for our login system to get authorized by the server.

Client Secret

A secret known only to the application and the authorization server.

Authentication URL

The base URL for the authentication requests.

Token Path

Returns the authorization token to connect with the server.

API URL

The base URL for the API requests.

User Path

Returns information for the user: name, username, email and time of login.

Checkout Path

Returns true or false if the Checkout on the current product was successful.

License Type Path

Returns the license type: free, premium

License Explanation Date Path

Returns the expiration date for the current product code about the logged user.

Heartbeat Path

Sends heartbeats for this product code.

Note

Uploading analytics is available with the premium sdk tier. Contact us for more information.

You can upload your analytics to our servers or host your own server using our cloud services sample apps.