Log-in using OIDC

Logs into a tenant using the JWT Token through the Open ID Connect (OIDC) authorization.

Base URL:

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

Here is an example to log-in to a tenant using the OIDC 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.

• To differentiate a JWT Token from a Session ID, check the format of the generated ID, if the ID contains a tenant url, it is a Session ID and if it does not contain tenant url, it is a JWT Token. For more information, see OpenID Connect Configuration.

If the log-in API is executed successfully, the application generates a JWT Token. Follow the below steps to execute an endpoint:

1.Create a new request in the Postman application.

2.Enter the following information in the Authorization tab:

•Set the option as Bearer Token in the Type field.

•Enter the generated JWT Token in the Token field.

3.Enter the endpoint request payload details and click the Send button or press the ENTER key.

Unsuccessful Response

Invalid User Name, Password or Role

Scenario: Trying to log-in to a tenant with invalid user name, password or role.

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

Code	ISM_4000
Description	Bad Request
Message	[ "Unhandled system exception: Invalid Parameters." ]
HTTP STATUS CODE	400