Authenticate (username and apiKey)

Use this API to authenticate access to a Control Room with the username and apikey. A successful response generates a JSON Web Token. A generated token is valid for 20 minutes. You can generate the token without the need for the user's password, such as for organizations that use single sign-on (SSO).

To generate the token, you require the following:

A custom role with the Generate API-Key permission
Valid username and API-key to the Control Room. The API-Key is a 40-character string generated in the Control Room.
Create and assign API key generation role

Request

POST http://{{ControlRoomURL}}/v1/authentication

Request body:

{
   "username":"jdoe",
   "apiKey":"Vie;Z:IvtAhY0\\1RAD[SWl{NU7baRLYEeIYUJSKO"
}

Nota: With apiKey you will be generating a multi session token. multipleLogin parameter is not applicable while you use apiKey to login.

Nota: apiKey or password is used to generate a valid token. Both (apiKey and password) cannot be used together in a request body.

Request Parameters


Parameter	Type	Description
username	String	Enter your user name.
apikey	String	Enter your apikey. Nota: With .24 or previous versions, you must replace any escape character '\' with '\\' in the API key. With .25 or later versions, the API key will no longer have any escape characters('\').

Response

{
   "token":"eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiIxIiwiY2xpZW50VHlwZSI6IldFQiIsImxpY2Vuc2VzIjpbXSwiYW5hbHl0aWNzTGljZW5zZXNQdXJjaGFzZWQiOnsiQW5hbHl0aWNzQ2xpZW50Ijp0cnVlLCJBbmFseXRpY3NBUEkiOnRydWV9LCJpYXQiOjE1NzMxMDc4NzMsImV4cCI6MTU3MzEwOTA3MywiaXNzIjoiQXV0b21hdGlvbkFueXdoZXJlIiwibmFub1RpbWUiOjM2NTc1NjI0OTQ2MzE2MDAsImNzcmZUb2tlbiI6ImNiZjgwZWNkZmU5YmUwYzViOGI2MDk3NmU0ZTI2MTNiIn0.rGYxbS5kKUTxtZhYtRSXpmIHwbf3IwLBIKDEA7odG5uGVAjD55Tv05bYdARx_3-tl1CBg_cDGbwj5FvaBt9u5xKu5W5j3Nur6x3PF62NeB3ZIdxiUPaFBU0Br84mPJMD4_EpwBfbeSVOMH6ngiLtJYhIOtJa0kp4pAAm3mvkuOUELtH8lf3pQf-2Ose2fUAaebDkqiH13SUF1TONAjUQv6Ef_uY0wgq9SjZwKHg9SKUhX3S8PXAJne_ih2QnN8nUE1SXGlkC04eoIvyWpFkM963XEjptc2uvwtVn42MdA4Nd1opD5yijEl9VM92Fe1sPb6_T5-oV-U1Iw0JHiX2-Ug",
   "user":{
      "id":9,
      "email":"a@a.com",
      "username":"jdoe",
      "domain":null,
      "firstName":"j",
      "lastName":"doe",
      "version":9,
      "principalId":9,
      "deleted":false,
      "roles":[
         {
            "name":"API_Key_Generation",
            "id":23,
            "version":0
         },
         {
            "name":"AAE_Basic",
            "id":2,
            "version":0
         },
         {
            "name":"Docrole1",
            "id":18,
            "version":0
         }
      ],
      "sysAssignedRoles":[
         
      ],
      "groupNames":[
         
      ],
      "permissions":[
         ". . ."
      ],
      "licenseFeatures":[
         "RUNTIME"
      ],
      "emailVerified":true,
      "passwordSet":true,
      "questionsSet":true,
      "enableAutoLogin":false,
      "disabled":false,
      "clientRegistered":false,
      "description":"",
      "createdBy":1,
      "createdOn":"2022-03-10T13:39:56-05:00",
      "updatedBy":1,
      "updatedOn":"2022-03-13T02:09:38-05:00",
      "publicKey":null,
      "appType":null,
      "routingName":null,
      "appUrl":null
   }
}

Response Parameters


Parameter	Type	Description
token	String	Generated access token that acts as a session ID that your application will use for making requests. This token is equivalent to the user credentials and must be protected.
user	Object	The user object returned with all the details of the user. id - Id of the user. email - Email id of the user. username - User name of the user. domain - Domain logged in to. firstname - First name of the user. lastname - Last name of the user. roles - Roles assigned to the user. sysAssignedRoles - System assigned roles. permissions - Permissions assigned to the user. licenseFeatures - License assigned to the user.

Insert the token in the request header of subsequent API requests.

Automation 360