Get Login Instructions

Obtain the user name label, password label, and login page message that are displayed on the login page. Depending on the system settings, all of these results could contain HTML and/or JavaScript. If HTML or JavaScript exists, it will be returned in the output.

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

Accept	application/json
Content-Type	application/json

Response

Parameters

type	Executed command name
username-label	The label for the user name field. May contain HTML and JavaScript.
password-label	The label for the password field. May contain HTML and JavaScript.
instructions	The instructions for logging in, if any. The instructions may be blank, or they may contain HTML and JavaScript.

Examples

Request

Curl

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

Python

import requests, json

url = "https://instance.securid.com/aveksa/command.submit"

params = {
    "cmd": "getLoginInstructions",
    "format": "json"
}

headers = {
    'Authorization': 'Bearer <token>',
    'Content-Type': 'application/json'
}

response = requests.get(url, params=params, headers=headers)

if response.status_code == 200:
    data = response.json()
    print(data)
else:
    print(f"Request failed with status code {response.status_code}")

Node.js

const axios = require('axios');

const url = "https://instance.securid.com/aveksa/command.submit";

const params = {
    cmd: "getLoginInstructions",
    format: "json"
};

const headers = {
    'Authorization': 'Bearer <token>',
    'Content-Type': 'application/json'
};

axios.get(url, { params, headers })
    .then(response => {
        if (response.status === 200) {
            const data = response.data;
            console.log(data);
        } else {
            console.log(`Request failed with status code ${response.status}`);
        }
    })
    .catch(error => {
        console.error('Error:', error);
    });

Response

200 JSON

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

200 Properties

instructions=
username-label=User Name
password-label=Password