Skip to main content

getResponseActionStatus

You can use this method to request the status and the result of a response action.

Parameters

Parameter

Description

Included in request

Type

Values

actionId

The ID used to verify the status of the action.

Mandatory

String

No additional values.

Return value

Attribute

Type

Description

type

Integer

Indicates the type of action that was taken and the type of user it was taken on.

Possible actions:

  • 1 - Force credentials for an Office 365 user.

  • 2 - Force credentials for an Active Directory user.

  • 3 - Disable an Active Directory user.

  • 4 - Disable an Office 365 user.

  • 5 - Mark an Office 365 user as compromised.

  • 6 - Delete an email account from an Office 365 user.

generatedOn

String

The timestamp when the response action was created.

status

Integer

The status of the response action.

Possible values:

  • 0 - Not started

  • 1 - To be executed

  • 2 - Pending

  • 3 - In execution

  • 4 - Execution success

  • 5 - Execution failed

  • 6 - Dismissed

  • 7 - External action needed

  • 8 - Done externally

errorId

String

The ID of the error message, if the response action failed.

errorDescription

String

The description of the error message, if the response action failed.

incidentId

String

The ID of the incident to which the user nodes belong, if available.

companyId

String

The ID of the company in which the action takes place.

userId

String

The ID of the user that requested the response action.

userName

String

The username who requested the response action.

targetUserId

String

The ID of the user on whom the response action was taken.

targetUserName

String

The username on which the response action was taken, when available.

targetEmailId

String

The ID of the email message on which the response action was taken, if applicable.

Examples

Request

{
     "params": {
         "actionId": "6912758f88df334ddbfb7e1a"
     },
     "jsonrpc": "2.0",
     "method": "getResponseActionStatus",
     "id": "7d2864e9-c67b-48a2-9ba3-0a11d47e83c8"
 }

Response

 {
     "id": "7d2864e9-c67b-48a2-9ba3-0a11d47e83c8",
     "jsonrpc": "2.0",
     "result": {
         "type": 5,
         "generatedOn": "2023-08-06T23:43:27",
         "status": 3,
         "errorId": null,
         "errorDescription": null,
         "incidentId": "6682758b1f3a95f78dd4cc08",
         "companyId": "5b680f6fb1a43d860a7b23c8",
         "userId": "66b9fd2985ecb7506a0ef3e3",
         "userName": "[email protected]",
         "targetUserId": "66b9fd2985ecb7506a0ef3ex",
         "targetUserName": "username",
         "targetEmailId": "7d2864e9-c67b-48a2-9ba3-0a11d47e83c8"
     }
 }
In this section: