1. OAAランタイムAPI
  2. タスク
  3. プリファレンス

OAAで使用可能なユーザーのチャレンジ・プリファレンスを返す

put

/oaa/runtime/preferences/v1/fetchuserpreferencessecurely

ユーザーのチャレンジ・プリファレンスのリストを返します。OAAでユーザーが見つからない場合は、エラーが返されます。

APIコールには、userIdおよびgroupIdを含める必要があります。uniqueUserIdが指定されている場合は、ユーザーを一意に識別するために使用されます。uniqueUserIdが指定されていない場合は、userIdとgroupIdの組合せを使用してユーザーを一意に識別します。

リクエスト

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

サポートされているメディア・タイプ
リクエスト本文 - application/xml ()
ルート・スキーマ: schema
型: object
リクエスト・オブジェクトには、userIdおよびgroupIdが含まれます。
ソースの表示
  • デフォルト値: Default
    ユーザーが属するグループ。このパラメータが存在しない場合は、Defaultという値が使用されます。
  • 外部システムのユーザーの正規のID。これが存在する場合は、userId + groupIdの組合せよりも優先されます。
  • ユーザーの識別子さらにgroupIdで修飾できます。
リクエスト本文 - application/json ()
ルート・スキーマ: schema
型: object
リクエスト・オブジェクトには、userIdおよびgroupIdが含まれます。
ソースの表示
  • デフォルト値: Default
    ユーザーが属するグループ。このパラメータが存在しない場合は、Defaultという値が使用されます。
  • 外部システムのユーザーの正規のID。これが存在する場合は、userId + groupIdの組合せよりも優先されます。
  • ユーザーの識別子さらにgroupIdで修飾できます。
先頭に戻る

レスポンス

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

200レスポンス

成功。
本文()
ルート・スキーマ: schema
型: object
各タイプのチャレンジ・ファクタに対するユーザーおよびユーザーのチャレンジの登録に関する情報。
ソースの表示
  • ユーザー画面で使用できるユーザーの代替名。
  • ユーザーのデフォルト・ロケール。指定しない場合は、デフォルト値の「en_US」が使用されます。
  • ユーザー画面で使用できるユーザーの表示名。
  • factorsRegistered
    ユーザーのファクタ登録データの配列。
  • プリファレンス・データが必要なユーザーのGroupId/ApplicationId。このパラメータが存在しない場合、"Default"という値が使用されます。
  • secureImageの場所。Example:/images/secureImage01.jpg.イメージ・パスを完全なURLとして返すようにシステムが構成されている場合、次の2つのプロパティを構成する必要があります。1.)oaa.preferences.prependBasePath = true (デフォルトはfalse)、2.)oaa.preferences.imageBasePath=。システム・プロパティoaa.preferences.prependBasePath = falseの場合、secureImageの場所のみがそのまま返されます。set (post)の場合は、相対パスのみが使用され、getの場合は、前述のように設定されていれば完全なURLが返されます。
  • ユーザー優先フレーズ文字列(例: Hello World!)
  • ユーザーの正規のID。これが存在する場合は、userId + groupIdの組合せよりも優先されます。
  • ユーザーの識別子さらにgroupIdで修飾できます。
ネストされたスキーマ: factorsRegistered
型: array
ユーザーのファクタ登録データの配列。
ソースの表示
  • FactorRegData
    factorNameおよびキーと値のマップを含むエントリ。キーと値のマップには、そのファクタに固有の属性が含まれます。
ネストされたスキーマ: FactorRegData
型: object
factorNameおよびキーと値のマップを含むエントリ。キーと値のマップには、そのファクタに固有の属性が含まれます。
ソースの表示
  • factorAttributes
    このユーザーのファクタの属性のコレクション。
  • ファクタのキー。これは、OAAシステムで使用可能なファクタの1つにマップする必要がある名前です。これは、challenge.type.enumの列挙名の1つである必要があります。たとえば、ChallengeEmail、ChallengeSMS、ChallengeOMATOTP、ChallangeYOTPおよびChallengeFIDO2です。
  • これは、OAAシステムで使用可能なファクタの1つにマップする必要がある名前です。これは、challenge.type.enumの列挙名の1つである必要があります。たとえば、ファクタが電子メールの場合、factorNameはEmail Challengeです。例として、Email Challenge、SMS Challenge、OMA TOTP Challenge、Yubikey OTP Challange、FIDO2 Challengeがあります。
  • ファクタが、ユーザーがチャレンジする優先ファクタかどうか。
ネストされたスキーマ: factorAttributes
型: array
このユーザーのファクタの属性のコレクション。
ソースの表示
ネストされたスキーマ: PrefFactorAttribute
型: object
エントリの配列として表されるマップ。
ソースの表示
ネストされたスキーマ: factorAttributeValue
型: array
ファクタ固有属性の値。配列に複数の値を指定できます。
ソースの表示
ネストされたスキーマ: PrefFactorAttributeValue
型: object
ファクタの属性値。
ソースの表示
  • "rfc3339セクション5.6の形式の日時文字列。https://tools.ietf.org/html/rfc3339#section-5.6"
  • ファクタ属性が有効どうかを示します。デフォルトでは、trueに設定されています。
  • 属性の値が配列の他の同様の値よりも優先されるかどうかを示します。
  • デフォルト値: true
    指定された属性が検証されているかどうかを示します。一部の属性には検証が不要なため、このフィールドはオプションです。
  • デフォルト値: true
    指定された属性が検証されているかどうかを示します。一部の属性には検証が不要なため、このフィールドはオプションです。
  • デバイスのわかりやすい名前。
  • ファクタ属性の値。

401レスポンス

未認可

412レスポンス

無効な入力
本文()
ルート・スキーマ: PrefAPIResponse
型: object
ソースの表示

500レスポンス

内部サーバー・エラー

503レスポンス

サービス使用不可
先頭に戻る

例

次の例は、ユーザーのチャレンジ・プリファレンスのリストを取得するためのリクエストとレスポンスのサンプルを示しています。

JSON形式でチャレンジ・プリファレンスのリストを取得するcURLコマンド

curl --location --request PUT '<OAAService>/oaa/runtime/preferences/v1/fetchuserpreferencessecurely' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '{
    "userId": "user1",
    "groupId": "financeapp",
    "uniqueUserId": "user1",

}'

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

{
    "userId": "user1",
    "groupId": "financeapp",
    "uniqueUserId": "user1",
    "imageReference": "/u01/oracle/service/store/img001.jpg",
    "phraseString": "Hello World!",
    "factorsRegistered": [
        {
            "isPreferred": false,
            "factorName": "Oracle Mobile Authenticator",
            "factorKey": "ChallengeOMATOTP",
            "factorAttributes": [
                {
                    "factorAttributeName": "omatotpsecretkey",
                    "factorAttributeValue": [
                        {
                            "value": "secret_key",
                            "isPreferred": false,
                            "isVerified": true,
                            "isValidated": true,
                            "name": "Device1",
                            "isEnabled": true,
                            "createTime": {
                                "parseFailed": false,
                                "dateTime": "2025-03-07T19:57:47.262Z",
                                "rawParam": "2025-03-07T19:57:47.262Z"
                            }
                        }
                    ]
                }
            ]
        },
        {
            "isPreferred": false,
            "factorName": "Email Challenge",
            "factorKey": "ChallengeEmail",
            "factorAttributes": [
                {
                    "factorAttributeName": "email",
                    "factorAttributeValue": [
                        {
                            "value": "user1@example.com",
                            "isPreferred": false,
                            "isVerified": true,
                            "isValidated": true,
                            "name": "Device1",
                            "isEnabled": true,
                            "createTime": {
                                "parseFailed": false,
                                "dateTime": "2025-03-07T19:57:47.261Z",
                                "rawParam": "2025-03-07T19:57:47.261Z"
                            }
                        }
                    ]
                }
            ]
        }
    ]
}

XML形式でチャレンジ・プリファレンスのリストを取得するcURLコマンド

curl --location --request PUT '<OAAService>/oaa/runtime/preferences/v1/fetchuserpreferencessecurely' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '<?xml version="1.0" encoding="UTF-8" ?>
 <PrefUserData>
     <userId>user1</userId>
     <groupId>financeapp</groupId>
     <uniqueUserId>user1</uniqueUserId>
 </PrefUserData>
'

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
 <UserPreferences>
    <userId>user1</userId>
    <groupId>financeapp</groupId>
    <uniqueUserId>user1</uniqueUserId>
    <imageReference>/u01/oracle/service/store/img001.jpg</imageReference>
    <phraseString>Hello World!</phraseString>
    <factorsRegistered>
        <isPreferred>false</isPreferred>
        <factorName>Oracle Mobile Authenticator</factorName>
        <factorKey>ChallengeOMATOTP</factorKey>
        <factorAttributes>
            <factorAttributeName>omatotpsecretkey</factorAttributeName>
            <factorAttributeValue>
                <value>secret_key</value>
                <isPreferred>false</isPreferred>
                <isVerified>true</isVerified>
                <isValidated>true</isValidated>
                <name>Device1</name>
                <isEnabled>true</isEnabled>
                <createTime>
                    <dateTime>2025-03-07T20:31:43.782Z</dateTime>
                    <parseFailed>false</parseFailed>
                    <rawParam>2025-03-07T20:31:43.782Z</rawParam>
                </createTime>
            </factorAttributeValue>
        </factorAttributes>
    </factorsRegistered>
    <factorsRegistered>
        <isPreferred>false</isPreferred>
        <factorName>Email Challenge</factorName>
        <factorKey>ChallengeEmail</factorKey>
        <factorAttributes>
            <factorAttributeName>Device1</factorAttributeName>
            <factorAttributeValue>
                <value>true</value>
                <isPreferred>false</isPreferred>
                <isVerified>true</isVerified>
                <isValidated>true</isValidated>
                <name>isValidated</name>
                <isEnabled>true</isEnabled>
                <createTime>
                    <dateTime>2025-03-07T20:31:43.783Z</dateTime>
                    <parseFailed>false</parseFailed>
                    <rawParam>2025-03-07T20:31:43.783Z</rawParam>
                </createTime>
            </factorAttributeValue>
            <factorAttributeValue>
                <value>val2</value>
                <isPreferred>false</isPreferred>
                <isVerified>true</isVerified>
                <isValidated>true</isValidated>
                <name>attr2</name>
                <isEnabled>true</isEnabled>
                <createTime>
                    <dateTime>2025-03-07T20:31:43.783Z</dateTime>
                    <parseFailed>false</parseFailed>
                    <rawParam>2025-03-07T20:31:43.783Z</rawParam>
                </createTime>
            </factorAttributeValue>
            <factorAttributeValue>
                <value>value1</value>
                <isPreferred>false</isPreferred>
                <isVerified>true</isVerified>
                <isValidated>true</isValidated>
                <name>attr1</name>
                <isEnabled>true</isEnabled>
                <createTime>
                    <dateTime>2025-03-07T20:31:43.783Z</dateTime>
                    <parseFailed>false</parseFailed>
                    <rawParam>2025-03-07T20:31:43.783Z</rawParam>
                </createTime>
            </factorAttributeValue>
        </factorAttributes>
        <factorAttributes>
            <factorAttributeName>email</factorAttributeName>
            <factorAttributeValue>
                <value>user1@example.com</value>
                <isPreferred>false</isPreferred>
                <isVerified>true</isVerified>
                <isValidated>true</isValidated>
                <name>Device1</name>
                <isEnabled>true</isEnabled>
                <createTime>
                    <dateTime>2025-03-07T20:31:43.783Z</dateTime>
                    <parseFailed>false</parseFailed>
                    <rawParam>2025-03-07T20:31:43.783Z</rawParam>
                </createTime>
            </factorAttributeValue>
        </factorAttributes>
    </factorsRegistered>
</UserPreferences>
先頭に戻る