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 action ID returned by the createResponseAction method.

Mandatory

String

No additional requirements.

General parameters

These are common parameters, available across all public API methods:

Parameter

Description

Included in request

Type

Values

id

This parameter adds an identifier to the request, linking it to its corresponding response.

The target replies with the same value in the response, allowing easy call tracking.

Mandatory

String

No additional requirements.

method

The name of the method you are using to send the request.

Mandatory

String

Must be a valid method name.

jsonrpc

The version of JSON-RPC used by the request and the response.

Mandatory

Integer

Possible values:

  • 2.0

params

An object containing the configuration of the request.

Mandatory

Object

No additional requirements.

Return value

Attribute

Type

Description

type

Integer

Indicates the type of action taken and the type of user to which it was applied.

Possible actions:

  • 1 - Reset credentials for a Microsoft 365 (Office 365) or Entra ID (Azure AD) user.

  • 2 - Reset credentials for an Active Directory user.

  • 3 - Disable a Microsoft 365 (Office 365) or Entra ID (Azure AD) user.

  • 4 - Disable an on-premises Active Directory user.

  • 5 - Mark a Microsoft 365 (Office 365) or Entra ID (Azure AD) user as compromised.

  • 6 - Delete an email message from a Microsoft 365 (Office 365) user.

  • 8 - Disable a Google user.

  • 9 - Reset credentials for a Google user.

  • 10 - Delete a Microsoft 365 (Office 365) OneDrive or SharePoint file.

  • 11 - Delete emails similar to a reference email from a Microsoft 365 (Office 365) user.

  • 12 - Disable an AWS 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

Integer

The error code, 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 who requested the response action.

userName

String

The username of the person who requested the response action.

targetUserId

String

The ID of the user to whom the response action was applied.

targetUserName

String

The username to which the response action was applied, when available.

targetEmailId

String

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

outcome

Object

Available only for an action with type 11. Indicates which emails were successfully deleted, which deletions failed either temporarily or permanently, and includes error information for all issues encountered. For details, refer to outcome.

Objects

outcome

Attribute

Type

Description

failedRetriableIds

Array of Strings

The IDs of the emails that could not be deleted due to issues such as insufficient permissions or invalid authorization keys. The Delete similar emails action can be retried for these emails.

failedPermanentIds

Array of Strings

The IDs of the emails that could not be deleted due to permanent issues, such as the email no longer being available. Retrying the Delete similar emails action will have no effect for these emails.

succeededIds

Array of Strings

The IDs of the emails that were successfully deleted.

errors

Array of Objects

Each object contains the following settings:

  • errorCode (Integer) - The code of the error.

  • errorMessage (String) - The message of the error.

  • count (Integer) - The number of emails for which the error occurred.

Examples

Request

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

Response

In this section: