API Guide

Back Next

POST /bg.auth/login

Use this URI to allow a client application to obtain an JSESSIONID cookie after providing a user's credentials.

The following table describes the payload parameters for the POST /bg.auth/login URI request:

Parameter	Description
namespace	Required. Security domain of the user. For LDAP users, use the appropriate domain name. The parameter value takes the string input and is case sensitive.
user	Required. Username of the user. The parameter value takes the string input and is not case sensitive.
password	Required. Password of the user. Password cannot be blank. The parameter value takes the string input and is case sensitive.

The following example shows how you can use the parameters:

{
"user":"Administrator",
"password":"Administrator",
"namespace" : "Native"
}

The JSESSIONID cookie and the following response:

{"message":"You have been successfully authenticated.","infaToken":"4o0jYVDadDuD5aLJNyp0RJPAAalTfv08rxnU-gi%2BJKw*"}

The following responses can occur for the URI request:

HTTP Return Code: 200: Response for authentication. For example:

{"message":"You have been successfully authenticated.","infaToken":"4o0jYVDadDuD5aLJNyp0RJPAAalTfv08rxnU-gi%2BJKw*"}

HTTP Return Code: 400: Response to a missing request parameter.

{"error":"JSONObject[\"password\"] not found."}

For example:
{"error":"JSONObject[\"password\"] not found."}
HTTP Return Code: 401: Response to a blank or not valid user name or password:

{"error":"The login information is not valid."}

HTTP Return Code: 500: Response for an internal error. For example:

{ "errorCode": "BG1201", "message": "Internal error." }