Authenticate User
{ authenticateUser }
Generates an access authentication token for the given user to use the API functions or login to the application.
Method
Input Parameters
Name
userCredentials
Object Type
Description
The user credential object used to set a user's login settings.
Output Response
Successful Result Code
200
Description of Response Type
The response is the security token as a base64 string. It is usually stored in a cookie.
Notes
The security token is a string that needs to be embedded in every API call to ensure the API calls are authorized. If saved as a cookie in a web browser, it can be used (for the authenticated user) to auto-login into the application.
Examples
User Client Authentication (C#):
This example demonstrates how to authenticate users for the main application.
User Client Authentication (Java):
This example demonstrates how to authenticate users for the main application.
Authenticate User (JavaScript):
This example demonstrates how to authenticate a user from JavaScript.