Previous Topic: Performing Selected Administration TasksNext Topic: Deleting a User from Exception List


Adding a User to Exception List

You might want to temporarily exclude a user in your organization from risk evaluation during a specific time interval. For example, if a user travels to a country that is configured as negative in RiskMinder, then for the specified interval while they are there, RiskMinder’s advice will always be DENY. To prevent that, their status can be changed to an exception user. In this case, if they perform a transaction during this interval, despite their IP address being negative, RiskMinder will return a low risk score and the advice will typically be ALLOW.

Book: You can also perform this operation by using the Case page in Administration Console. See CA RiskMinder Administration Guide for detailed instructions to do so.

To add a user to Exception User List, you must use the ArcotRiskFortAdminSvc service (available through ArcotRiskFortAdminWebService.wsdl) for:

Preparing the Request Message

You must use the addUserToExceptionListRequest message to add a user to the Exception User List. The following table lists the elements of this request message.

Element

Mandatory

Description

userName

Yes

The name of the user who you want to add to the Exception User List.

groupName

Yes

The name of the organization to which the user belongs.

startDate

Yes

The date (in yyyy-mm-dd format) and time from which you want the user to be exempted from RiskMinder risk evaluation.

For example: 2012-10-04+05:30

endDate

Yes

The date (in yyyy-mm-dd format) and time till which you want the user to be exempted from RiskMinder risk evaluation.

reason

Yes

The reason for which the user is being added to the Exception User List.

callerId

No

Unique transaction identifier that your calling application can include. This identifier helps in tracking related transactions.

Invoking the Web Service

To add a user to the Exception User List:

  1. (Optional) Include the authentication and authorization details in the header of the addUserToExceptionList operation. See "Managing Web Services Security" for more information on the header elements.
  2. Use the addUserToExceptionListRequest elements to set the required information, as listed in the table.
  3. Use the addUserToExceptionListRequest message and construct the input message by using the details specified in preceding step.
  4. Invoke the addUserToExceptionList operation of the ArcotRiskFortAdminSvc service to add the user to the list.

    This operation returns the addUserToExceptionListResponse message that includes the status of the operation and success result. See the following section for more information on the response message.

Interpreting the Response Message

The response message, addUserToExceptionListResponse, returns the status of the operation and the success result in the SOAP envelope header. These elements are explained in the following table. The SOAP body returns a success message if the operation was performed successfully. If there are any errors, then the AdminFault response is returned. See appendix, "Exceptions and Error Codes" for more information on the SOAP error messages.

Element

Description

code

The status of the operation:

  • 0: Indicates that the user was successfully added to the Exception User List.
  • 1: Indicates that the operation failed.

message

Contains the string that indicates whether the information was successfully updated in the database or not.

transactionID

The unique transaction identifier.