Get Login Instructions

The getLoginInstructions API command retrieves the following information displayed on the login page:

• User name label: The label for the username field.
• Password label: The label for the password field.
• Login page message: A custom message displayed on the login page.

Depending on system configurations, the returned data may include HTML and/or JavaScript. If present, these elements will be included in the response.

GET https://instance.securid.com/aveksa/command.submit?cmd=getLoginInstructions

Request

Parameters

command	getLoginInstructions
format	properties - (Default) key=value. most useful when requesting a single object. If multiple objects are returned, values is a csv. ie key=value1,value2,value3 where value1 is the value for the first object, value2 is the value for the 2nd object, etc. json - Useful format for parsing into javascript or other languages. See www.json.org for details.

Headers

Authorization	Bearer token
Accept	application/json
Content-Type	application/json

Response

Parameters

username-label	The label for the username field. This may include HTML or JavaScript for dynamic rendering.
password-label	The label for the password field. Similar to the username label, it may contain HTML or JavaScript.
instructions	Optional login instructions displayed on the login page. This field may be empty or include HTML and JavaScript.

Examples

Request

Curl

curl -K -X GET  \
"https://instance.securid.com/aveksa/command.submit?cmd=getLoginInstructions&format=json" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: application/json"

Python

import requests

url = "https://instance.securid.com/aveksa/command.submit?cmd=getLoginInstructions&format=json"
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

try:
    response = requests.get(url, headers=headers)
    print("Status Code:", response.status_code)
    print("Response JSON:", response.json())
except requests.exceptions.RequestException as e:
    print("Error:", e)

Node.js

const https = require('https');

const options = {
  hostname: 'instance.securid.com',
  port: 443,
  path: '/aveksa/command.submit?cmd=getLoginInstructions&format=json',
  method: 'GET',
  headers: {
    'Authorization': 'Bearer <token>',
    'Content-Type': 'application/json'
  }
};

const req = https.request(options, (res) => {
  let data = '';

  res.on('data', (chunk) => {
    data += chunk;
  });

  res.on('end', () => {
    try {
      console.log("Response JSON:", JSON.parse(data));
    } catch (error) {
      console.error("Error parsing JSON:", error);
    }
  });
});

req.on('error', (error) => {
  console.error("Request Error:", error);
});

req.end();

Response

200

{
    "data": {
        "type": "getLoginInstructions",
        "instructions": "",
        "username-label": "User Name",
        "password-label": "Password"
    }
}