Jump to

• Request
• Response

This 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. contextId is used to locate the user. The returned ModelAPIResponse will consist of response code and resonse message. The challengeType and contextId are mandatory parameters. Error response will be returned if any of, challengeType or contextId are invalid.

Request

Query Parameters

• challengeType(required): string
  This is the type or channel byt which the user was challenged. It can be one of ChallengeEmail, ShallengeSMS, ShallengeOMATOTP, ChallengeYOTP or ChallengeFIDO2.
• contextId(required): string
  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

• application/xml
• application/json
• text/plain

200 Response

Challenge Counter is reset.

Body ()

Root Schema : ModelAPIResponse

Type: object

Show Source

• responseCode: string
• responseMessage: string

{
    "type":"object",
    "properties":{
        "responseCode":{
            "type":"string"
        },
        "responseMessage":{
            "type":"string"
        }
    }
}

404 Response

Invalid input. ContextId or ChallengeType was not found.

500 Response

Internal server error

Back to Top