Log-in using Session ID

Logs into the tenant using a Session ID.

Base URL:

https://{tenant url}/api/rest/authentication/login

Here is an example to log-in to a tenant using the Session ID authorization.

URL	https://{tenant url}/api/rest/authentication/login
Method	POST
Request Payload	{ "tenant" :"{tenant url}", "username" :"{name of the user}", "password" :"{password set for the user}", "role" :"{user role to log-in to the application}" }
Status Code	200

• When providing the "role" parameter, you need to provide the internal name of the role and not the display name. For example, Admin is the internal name of the role Administrator.

• The generated ID is a JTW Token or a Session ID can be identified by checking for the tenant url in the ID. If the ID contains the tenant url, then it is a Session ID, else it is a JWT Token.

After successfully executing the log-in API, the application generates a Session ID. Follow the steps below to log-in to the tenant:

1.Click the Header tab and select the Authorization check box in the Postman application.

2.Enter the generated Session ID in the VALUE column.

3.Click the Send button.

You are now successfully logged in to the tenant.

Unsuccessful Response

Was this article useful?

Privacy and Legal

Code	ISM_4000
Description	Bad Request
Message	[ "Unhandled system exception: Tenant Not Found or wrong Password or OpenID not Configured Properly." ]
HTTP STATUS CODE	400