1. OAA Runtime API
  2. Tasks
  3. ChallengeCounter

OAA API resets Challenge counter for the given challegeType for the user based on the contextId

delete

/challengecounter/v1

OAA API to reset the challenge counter. The contextId is used to locate the user. The returned ModelAPIResponse will consist of response code and response message. The challengeType and contextId are mandatory parameters. Error response will be returned if any of, challengeType or contextId are invalid.

Request

Query Parameters
  • This is the type or channel by which the user was challenged. It can be one of ChallengeEmail, ChallengeSMS, ChallengeOMATOTP, ChallengeYOTP or ChallengeFIDO2.
  • Context Id of one the previous contexts that was returned in previous runtime responses from OAA. This is used to locate the right user and user's challenge data

There's no request body for this operation.

Back to Top

Response

Supported Media Types

200 Response

Challenge Counter is reset.
Body ()
Root Schema : ModelAPIResponse
Type: object
Show Source

404 Response

Invalid input. ContextId or ChallengeType was not found.

500 Response

Internal server error
Back to Top

Examples

The following example shows a sample request and response for resetting the challenge counter for the specified challenge type for the user, based on the context ID.

cURL Command to Reset the Challenge Counter in JSON Format

curl --location --request DELETE '<OAAService>/oaa/runtime/challengecounter/v1?challengeType=challengeTypeExample&contextId=contextIdExample' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data ''

Sample Response in JSON Format

{
  "responseCode": "200",
  "responseMessage": "Challenge Counter is reseted."
}

cURL Command to Reset the Challenge Counter in XML Format

curl --location --request DELETE '<OAAService>/oaa/runtime/challengecounter/v1?challengeType=challengeTypeExample&contextId=contextIdExample' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data ''

Sample Response in XML Format

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <ModelAPIResponse>
	<responseCode>200</responseCode>
	<responseMessage>Challenge Counter is reseted.</responseMessage>
</ModelAPIResponse>
Back to Top