Authenticate (username and apiKey)
Use this API to authenticate access to your Control Room with the
username
and apikey
. A successfully completed response
generates a JSON Web Token. By default, a
token is valid for 20 minutes. This endpoint enables users to 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 a valid username
and
apikey
to the Control Room.
To generate the token, you require the following:
- A custom role with the Generate API-Key permission
- Valid
username
andAPI-key
to the Control Room. TheAPI-Key
is a 40-character string generated in the Control Room.
Request
POST http://{{ControlRoomURL}}/v1/authentication
Request body:
{
"username":"jdoe",
"apiKey":"Vie;Z:IvtAhY0\\1RAD[SWl{NU7baRLYEeIYUJSKO"
}
Request Parameters
Parameter | Type | Description |
---|---|---|
username | String | Enter your user name. Note: If the user has multiple sessions
enabled then a multiple session token will be generated. For
more information on multiple-login, see Multi-login user. |
apikey | String | Enter your apikey. Note: Make sure you replace any escape
character '\' with '\\' in the API key. |
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.
|
Insert the token in the request header of subsequent API requests.