Create Admin Error

Create a new admin error.

POST https://instance.securid.com/aveksa/command.submit?cmd=createAdminError

Request

Parameters

command	createAdminError
format	properties - (Default) Returns the response as key=value pairs. json - Returns the response as JSON.
desc	A description for the error.
type	The error type. Defaults to User_Defined_Action if omitted. Valid values: Data_Collection Identity_Data_Load Entitlement_Data_Load Reference_Resolution Role_Data_Load Account_Data_Load Identity_Unification Rule_Execution User_Defined_Action System Workflow EntitlementReview Delete_Users Activity_Handler Metadata_Load Data_Access_Data_Load Security User_Lockout Email_Processing CircuitBreaker SystemStatusEvent TelemetryDataCollection Role_Hierarchy_Import
priority	The error priority. Valid values: High Medium Low

Headers

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

Body

Optional plain text with additional error details.

Error details in text format

Response

Parameters

id	The ID of the created admin error.

Examples

Request

Curl

curl -K -X POST \
"https://instance.securid.com/aveksa/command.submit?cmd=createAdminError&format=json&desc=Sample+error&type=System&priority=Low" \
-H "Authorization: Bearer <token>" \
-H "Content-Type: text/plain" \
-d "Error details in text format"

Python

import requests

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

params = {
    "cmd": "createAdminError",
    "format": "json",
    "desc": "Sample error",
    "type": "System",
    "priority": "Low"
}

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

payload = "Error details in text format"

response = requests.post(url, params=params, headers=headers, data=payload)

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: "createAdminError",
    format: "json",
    desc: "Sample error",
    type: "System",
    priority: "Low"
};

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

const payload = "Error details in text format";

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

Response

200

{
    "data": {
        "type": "createAdminError",
        "id": "1001"
    }
}

412 Missing desc

Returned when the required desc parameter is omitted.

<html>
    <head>
        <title>Error</title>
    </head>
    <body>The desc parameter is required
 Query String=cmd=createAdminError&amp;format=json</body>
</html>

412 Invalid type

Returned when type is not one of the valid values.

<html>
    <head>
        <title>Error</title>
    </head>
    <body>The type parameter must be a value of Data_Collection, Identity_Data_Load, Entitlement_Data_Load, Reference_Resolution, Role_Data_Load, Account_Data_Load, Identity_Unification, Rule_Execution, User_Defined_Action, System, Workflow, EntitlementReview, Delete_Users, Activity_Handler, Metadata_Load, Data_Access_Data_Load, Security, User_Lockout, Email_Processing, CircuitBreaker, SystemStatusEvent, TelemetryDataCollection, Role_Hierarchy_Import
 Query String=cmd=createAdminError&amp;format=json&amp;desc=Sample+error&amp;type=InvalidType</body>
</html>

412 Invalid priority

Returned when priority is not one of the valid values.

<html>
    <head>
        <title>Error</title>
    </head>
    <body>The priority parameter must be a value of High, Medium, Low
 Query String=cmd=createAdminError&amp;format=json&amp;desc=Sample+error&amp;priority=Critical</body>
</html>

401 Invalid Token

<html>
    <head>
        <title>Error</title>
    </head>
    <body>The token is not valid for the command 'createAdminError'. Token is invalid or expired</body>
</html>

Verified with RSA Governance & Lifecycle version 8.0.0.188886 P10_HF01.