OAAランタイムAPI

ユーザー固有の回答と質問を関連付けて更新する。

put

/oaa-kba/runtime/kba/v1/questions

ユーザーはアクティブな質問でチャレンジされます。ユーザーに関連付けられた質問は、ユーザーの身元を確認するために、認証時に使用されます。提供された回答は、その質問に対するユーザーのプライベートな回答として保存されます。ユーザー・アイデンティティ・データは、putリクエストの本文に存在する必要があります。指定された質問についてのみ、ユーザーの関連付けおよびユーザーの回答が更新されます。Activeフラグがtrueに設定されている質問はアクティブとみなされ、後でユーザーのチャレンジに使用できます。ユーザーは、質問の選択ごとに少なくとも1つの質問をアクティブにする必要があります。ユーザーは、システム・プロパティchallenge.question.registration.maxcount.from.each.groupsに基づいて、選択ごとに複数の質問をアクティブにできます。デフォルトでは、ユーザーは認証中にいずれかのアクティブな質問によってチャレンジされる可能性があります。12.2.1.4.1-20230630以降、システムが適切なアクティブな質問で構成されている場合、この動作はシステム・プロパティoracle.security.oaa.kba.challenge.numberによってオーバーライドされる可能性があります。OAAサーバーが複数の質問でユーザーにチャレンジするように構成されている場合、生成されたチャレンジには、システム・プロパティoracle.security.oaa.kba.challenge.separatorの値で区切られたチャレンジのリストを含む文字列として複数のチャレンジが含まれます。チャレンジへの回答がOAAサーバーに提示されると、その回答も同じセパレータによって区切られることが予想されます。デフォルトでは、このセパレータは「|」文字として宣言されています。これは、他の文字、またはチャレンジやレスポンスで使用されない文字の組合せでオーバーライドできます。

リクエスト

この操作にはリクエスト・パラメータはありません。

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

application/xml
application/json

ルート・スキーマ: schema

型: object

ソースの表示

choices: array choices
user: object User

{
    "required":[
        "categories"
    ],
    "type":"object",
    "properties":{
        "user":{
            "$ref":"#/components/schemas/User"
        },
        "choices":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Choice"
            }
        }
    }
}

ネストされたスキーマ: choices

型: array

ソースの表示

配列: object Choice

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Choice"
    }
}

ネストされたスキーマ: User

型: object

ソースの表示

group: string

デフォルト値: default

ユーザーが属するグループ
uniqueUserId: string

外部システムのユーザーの不変ID。これが存在する場合は、userId + groupIdの組合せよりも優先されます。
userid: string

グループ内で一意のユーザID。

{
    "type":"object",
    "properties":{
        "userid":{
            "type":"string",
            "description":"userid unique in group."
        },
        "group":{
            "type":"string",
            "description":"group to which user belongs",
            "default":"default"
        },
        "uniqueUserId":{
            "type":"string",
            "description":"Immutable ID of the user in the external systems. If this is present, then it takes precedence over userId + groupId combination."
        }
    }
}

ネストされたスキーマ: Choice

型: object

ソースの表示

questions: array questions

{
    "type":"object",
    "properties":{
        "questions":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Question"
            }
        }
    }
}

ネストされたスキーマ: questions

型: array

ソースの表示

配列: object Question

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Question"
    }
}

ネストされたスキーマ: Question

型: object

ソースの表示

active: boolean

デフォルト値: true

trueの場合、この質問はユーザーに関連付けられ、ユーザーのチャレンジに使用されます。
answer: string

ユーザーに関連付けられた質問に対するユーザーの回答
question: string

ユーザーに関連付けられた質問テキスト
questionId: integer (int64)

ユーザーに関連付けられた質問の一意の識別子

{
    "required":[
        "questionid"
    ],
    "type":"object",
    "properties":{
        "questionId":{
            "type":"integer",
            "description":"unique identifier of question associated with user",
            "format":"int64"
        },
        "question":{
            "type":"string",
            "description":"question text associated with user"
        },
        "answer":{
            "type":"string",
            "description":"User's answer to question associated with user"
        },
        "active":{
            "type":"boolean",
            "description":"If true, this question is associated with user and will be used to challenge the user.",
            "default":true
        }
    }
}

ルート・スキーマ: schema

型: object

ソースの表示

choices: array choices
user: object User

{
    "required":[
        "categories"
    ],
    "type":"object",
    "properties":{
        "user":{
            "$ref":"#/components/schemas/User"
        },
        "choices":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Choice"
            }
        }
    }
}

ネストされたスキーマ: choices

型: array

ソースの表示

配列: object Choice

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Choice"
    }
}

ネストされたスキーマ: User

型: object

ソースの表示

group: string

デフォルト値: default

ユーザーが属するグループ
uniqueUserId: string

外部システムのユーザーの不変ID。これが存在する場合は、userId + groupIdの組合せよりも優先されます。
userid: string

グループ内で一意のユーザID。

{
    "type":"object",
    "properties":{
        "userid":{
            "type":"string",
            "description":"userid unique in group."
        },
        "group":{
            "type":"string",
            "description":"group to which user belongs",
            "default":"default"
        },
        "uniqueUserId":{
            "type":"string",
            "description":"Immutable ID of the user in the external systems. If this is present, then it takes precedence over userId + groupId combination."
        }
    }
}

ネストされたスキーマ: Choice

型: object

ソースの表示

questions: array questions

{
    "type":"object",
    "properties":{
        "questions":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Question"
            }
        }
    }
}

ネストされたスキーマ: questions

型: array

ソースの表示

配列: object Question

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Question"
    }
}

ネストされたスキーマ: Question

型: object

ソースの表示

active: boolean

デフォルト値: true

trueの場合、この質問はユーザーに関連付けられ、ユーザーのチャレンジに使用されます。
answer: string

ユーザーに関連付けられた質問に対するユーザーの回答
question: string

ユーザーに関連付けられた質問テキスト
questionId: integer (int64)

ユーザーに関連付けられた質問の一意の識別子

{
    "required":[
        "questionid"
    ],
    "type":"object",
    "properties":{
        "questionId":{
            "type":"integer",
            "description":"unique identifier of question associated with user",
            "format":"int64"
        },
        "question":{
            "type":"string",
            "description":"question text associated with user"
        },
        "answer":{
            "type":"string",
            "description":"User's answer to question associated with user"
        },
        "active":{
            "type":"boolean",
            "description":"If true, this question is associated with user and will be used to challenge the user.",
            "default":true
        }
    }
}

先頭に戻る

レスポンス

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

application/json

204レスポンス

成功

401レスポンス

未認可

ルート・スキーマ: KBAAPIResponse

型: object

ソースの表示

responseCode: string
responseMessage: string

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

415レスポンス

Content-Typeヘッダー値が無効であるか、サーバーで受け入れられません

ルート・スキーマ: KBAAPIResponse

型: object

ソースの表示

responseCode: string
responseMessage: string

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

422レスポンス

処理できないエンティティ。ユーザー質問データの更新に失敗しました。

ルート・スキーマ: KBAAPIResponse

型: object

ソースの表示

responseCode: string
responseMessage: string

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

500レスポンス

サーバー・エラー。

ルート・スキーマ: KBAAPIResponse

型: object

ソースの表示

responseCode: string
responseMessage: string

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

先頭に戻る

例

次の例は、ユーザーのプライベート情報に基づいてユーザーのアイデンティティを検証するサンプルのリクエストとレスポンスを示します。

JSON形式でユーザーのアイデンティティを検証するcURLコマンド

curl --location --request PUT '<OAAService>/oaa-kba/runtime/kba/v1/questions' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '{
    "user": {
        "userid": "user1",
        "group": "Default"
    },
    "choices": [
        {
            "questions": [
                                {
                    "questionId": 2,
                    "question": "What was your father'\''s profession when you were born?",
                    "active": true,
                    "answer": "born"
                }
            ]
        },
        {
            "questions": [
                {
                    "questionId": 87,
                    "question": "What was the name of your favorite childhood musical group?",
                    "active": true,
                    "answer": "group"
                }
            ]
        },
        {
            "questions": [
                {
                    "questionId": 60,
                    "question": "What is your best friend'\''s birthday?",
                    "active": true,
                    "answer": "birthday"
                }
            ]
            
        }
    ]
}
'

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

204 No Content

XML形式でユーザーのアイデンティティを検証するcURLコマンド

curl --location --request PUT '<OAAService>/oaa-kba/runtime/kba/v1/questions' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '<?xml version="1.0" encoding="UTF-8" ?>
<UserQuestion>
<user>
  <userid>testuser1</userid>
  <group>financeapp4</group>
</user>
<choices>
    <questions>
            <questionId>2</questionId>
            <question>What was your father's profession when you were born?</question>
            <answer>born</answer>
            <active>true</active>
    </questions>
	<questions>
            <questionId>87</questionId>
            <question>What was the name of your favorite childhood musical group?</question>
            <answer>born</answer>
            <active>true</active>
    </questions>
	<questions>
            <questionId>60</questionId>
            <question>What is your best friend's birthday?</question>
            <answer>birthday</answer>
            <active>true</active>
    </questions>
</choices>
</UserQuestion>

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

204 No Content

先頭に戻る