REST API for Customer Care Service in Oracle Advanced Risk Manager

Reset challenge counters

delete

/customercare/v1/{customerId}/counters

Reset challenge failure counters for a given user. Must specify a questionId or challengeType, but not both.

Request

Path Parameters

customerId(required): string

It is the uniqueUserId of the user. Details can be found in the user preferences API.

Query Parameters

challengeType: string

If provided, failure counter for the given challengeType is reset. This is one of the challenge.type.enum.
questionId: integer

If provided, failure counters for the given question ID are reset
requestId(required): string

Request Id (session Id) for the user's session.

There's no request body for this operation.

Response

Supported Media Types

application/xml
application/json

200 Response

Success

Root Schema : StatusResponse

Type: object

Status information for API call

Show Source

responseCode: string

status code of the request
responseMessage: string

response message related to the response code if needed.
sessionId: string

session id of the authentcation.
status: boolean

authentication update request status

{
    "type":"object",
    "description":"Status information for API call",
    "properties":{
        "responseCode":{
            "type":"string",
            "description":"status code of the request"
        },
        "responseMessage":{
            "type":"string",
            "description":"response message related to the response code if needed."
        },
        "status":{
            "type":"boolean",
            "description":"authentication update request status"
        },
        "sessionId":{
            "type":"string",
            "description":"session id of the authentcation."
        }
    }
}

400 Response

Invalid input

404 Response

Customer ID not found

Examples

The following example shows a sample request and response for resetting the challenge failure counters for a specific user.

cURL Command to Reset the Challenge Failure Counter in JSON Format

curl --location --request DELETE '<RISKCC>/risk-cc/customercare/v1/{customerId}/counters?requestId=edbe55c6-438f-448f-a742-9925b6471fe1challengeType=ChallengeOMATOTP' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>'

Sample Response in JSON Format

{
    "responseCode": "0",
    "responseMessage": "",
    "status": true
}

cURL Command to Reset the Challenge Failure Counter in XML Format

curl --location --request DELETE '<RISKCC>/risk-cc/customercare/v1/{customerId}/counters?requestId=edbe55c6-438f-448f-a742-9925b6471fe1challengeType=ChallengeOMATOTP' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>'

Sample Response in XML Format

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<StatusResponse>    
    <responseCode>0</responseCode>
    <responseMessage></responseMessage>
    <status>true</status>
</StatusResponse>