Authentication Method

Overview

Every request made to the API must be prefaced with an authentication request. When using the REST services, a valid username and password must be supplied by the calling application. Every service requires authentication, except the versions service. The first step in authenticating is calling the authenticate service, passing a valid username and password. The user must be a part of the API userGroup. The authenticate service must be called with a POST and will return a sessionID to be used in subsequent calls as part of the header. The sessionID is valid for a 24 hour period, after which the authenticate method must be called again to receive a new sessionID.

Return: 

	Status Code	Error Code	Return
Success	200		SessionID
Invalid Username and Password	401	INVALID_LOGIN_CREDENTIALS
User not in API usergroup	401	INVALID_API_USER

Example:

Method	URL	Content-Type
POST	https://<relaywareHost>/api/v1/authenticate	Application/x-www-form-urlencoded

HTML Example

POST /api/v1/authenticate HTTP/1.1
Host: <relaywareHost>
Content-Type: application/x-www-form-urlencoded

username=example+user&password=p%40ssw0rd