OAAランタイムAPI

OAA APIは、contextIdに基づいて、ユーザーに指定されたchallegeTypeのチャレンジ・カウンタをリセットする

delete

/challengecounter/v1

チャレンジ・カウンタをリセットするためのOAA API。contextIdは、ユーザーの検索に使用されます。返されたModelAPIResponseは、レスポンス・コードとレスポンス・メッセージで構成されます。challengeTypeおよびcontextIdは必須パラメータです。challengeTypeまたはcontextIdのいずれかが無効な場合は、エラー・レスポンスが返されます。

リクエスト

問合せパラメータ

challengeType(required): string

これは、ユーザーがチャレンジされたタイプまたはチャネルです。ChallengeEmail、ChallengeSMS、ChallengeOMATOTP、ChallengeYOTP、ChallengeFIDO2のいずれかです。
contextId(required): string

OAAからの以前のランタイム・レスポンスで返された以前のコンテキストのコンテキストID。これは、適切なユーザーおよびユーザーのチャレンジ・データの検索に使用されます

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

サポートされているメディア・タイプ

application/xml
application/json
text/plain

200レスポンス

チャレンジ・カウンタがリセットされました。

ルート・スキーマ: ModelAPIResponse

型: object

ソースの表示

responseCode: string
responseMessage: string

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

404レスポンス

無効な入力。ContextIdまたはChallengeTypeが見つかりませんでした。

500レスポンス

内部サーバー・エラー

先頭に戻る

例

次の例は、コンテキストIDに基づいて、ユーザーに対して指定されたチャレンジ・タイプのチャレンジ・カウンタをリセットするサンプルのリクエストとレスポンスを示します。

JSON形式でチャレンジ・カウンタをリセットするcURLコマンド

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 ''

JSON形式のサンプル・レスポンス

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

XML形式でチャレンジ・カウンタをリセットするcURLコマンド

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 ''

XML形式のサンプル・レスポンス

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

先頭に戻る