1. Oracle Advanced Risk ManagerでのRisk ServiceのためのREST API
  2. タスク
  3. ユーザー・セッション

セッションの作成

post

https://oaainstall-host/risk-analyzer/session/v1

ユーザー認証リクエストの新しいOARMセッションを作成します。

リクエスト

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

サポートされているメディア・タイプ
リクエスト本文 - application/xml ()
ルート・スキーマ: schema
型: object
セッションを作成するためのリクエスト・オブジェクト
ソースを表示
  • DeviceFingerprintDataList
    デバイス・フィンガープリント・データのリスト
  • IPData
    認証中に使用されるIP関連データ
  • リクエストのリクエストID。移入されない場合は、サーバーで生成され、レスポンスで返されます。
  • rfc3339セクション5.6の形式の日時文字列。https://tools.ietf.org/html/rfc3339#section-5.6 (例: 2021-08-13T01:29:29.768Z)
  • SessionData
    リクエストに存在するセッション・データ。
  • SessionRiskUserData
    ユーザー関連データ。loginNameは必須パラメータです。
    ユーザーを一意に識別できる正規のuserIdがクライアントにある場合、正規のuserIdを使用するすべてのAPIコールで正規のuserIdを指定する必要があります。ユーザーを識別する正規のuserIdがクライアントにない場合、OARMシステムではユーザーの作成時に正規のIDが生成されます。そのユーザーに対する後続のすべてのAPIコールで、生成された正規のuserIdをそのユーザーに指定する必要があります。
    正規のuserIdが指定されていない場合、またはシステムに存在しない正規のuserIdが指定されている場合は、新しいユーザーがシステムに作成されます。ユーザー・レコードは、指定された正規のuserIdに基づいてシステムで検出されます。
    正規のuserIdは、loginNameおよびgroupNameを使用してユーザー・プリファレンスをコールすることで、OARMシステムで検出できます。
ネストされたスキーマ: DeviceFingerprintDataList
型: array
デバイス・フィンガープリント・データのリスト
ソースを表示
ネストされたスキーマ: IPData
型: object
認証中に使用されるIP関連データ
ソースを表示
  • 位置の緯度。最小値は-90 (南半球の場合は負の値)で、最大値は+90 (北半球の場合は正の値)です
  • この属性は、位置情報(経度、緯度のペア)の精度を示します。この属性は、位置精度単位とともに精度を示します。典型的な例は、指定された座標から2メートル以内を示します。この例では、この属性の値は2.0になり、位置精度タイプの値は、メートルを指す列挙になります。
  • locationAccuracyが存在する場合は必須です。この属性は、locationAccuracy属性とともに、位置情報(経度、緯度のペア)の精度を示します。この属性は、位置精度単位とともに精度を示します。典型的な例は、指定された座標から2メートル以内を示します。この例では、この属性の値はメートルを指す列挙になり、locationAccuracy属性の値は2.0になります。
  • rfc3339セクション5.6の形式の日時文字列。https://tools.ietf.org/html/rfc3339#section-5.6 (例: 2021-08-13T01:29:29.768Z)
  • locationAccuracyが存在する場合は必須です。この属性は、位置が取得されたタイプ/メソッドを示します。これは、location.source.type.enumタイプの列挙です。可能な整数値の中には、gps、アシストgps、wifiホットスポットなどに対応するものがあります。
  • 位置の経度。最小値は-180 (西半球の場合は負の値)で、最大値は+180 (東半球の場合は正の値)です。
  • この属性は、プロキシが存在する場合のセッションのプロキシIPアドレスです。(A.B.C.D形式)
  • この属性は、リクエストを受信するリモート・ホスト・マシン名を取得します。
  • この属性は、セッションのIPアドレスを文字列形式で取得します。(A.B.C.D)
ネストされたスキーマ: SessionData
型: object
リクエストに存在するセッション・データ。
ソースを表示
ネストされたスキーマ: SessionRiskUserData
型: object
ユーザー関連データ。loginNameは必須パラメータです。
ユーザーを一意に識別できる正規のuserIdがクライアントにある場合、正規のuserIdを使用するすべてのAPIコールで正規のuserIdを指定する必要があります。ユーザーを識別する正規のuserIdがクライアントにない場合、OARMシステムではユーザーの作成時に正規のIDが生成されます。そのユーザーに対する後続のすべてのAPIコールで、生成された正規のuserIdをそのユーザーに指定する必要があります。
正規のuserIdが指定されていない場合、またはシステムに存在しない正規のuserIdが指定されている場合は、新しいユーザーがシステムに作成されます。ユーザー・レコードは、指定された正規のuserIdに基づいてシステムで検出されます。
正規のuserIdは、loginNameおよびgroupNameを使用してユーザー・プリファレンスをコールすることで、OARMシステムで検出できます。
ソースを表示
  • グループ名。loginNameとgroupNameの組合せは一意である必要があります。
  • 認証に使用されるログイン名
  • 正規のユーザー識別子。このユーザーIDは、指定された場合、ユーザーを識別するメカニズムになります。このパラメータを指定しない場合、loginNameとgroupNameの組合せを使用してユーザーの検索が行われます。
ネストされたスキーマ: DeviceFingerprintData
型: object
リクエストに存在するデバイス・フィンガープリント・データ
ソースを表示
リクエスト本文 - application/json ()
ルート・スキーマ: schema
型: object
セッションを作成するためのリクエスト・オブジェクト
ソースを表示
  • DeviceFingerprintDataList
    デバイス・フィンガープリント・データのリスト
  • IPData
    認証中に使用されるIP関連データ
  • リクエストのリクエストID。移入されない場合は、サーバーで生成され、レスポンスで返されます。
  • rfc3339セクション5.6の形式の日時文字列。https://tools.ietf.org/html/rfc3339#section-5.6 (例: 2021-08-13T01:29:29.768Z)
  • SessionData
    リクエストに存在するセッション・データ。
  • SessionRiskUserData
    ユーザー関連データ。loginNameは必須パラメータです。
    ユーザーを一意に識別できる正規のuserIdがクライアントにある場合、正規のuserIdを使用するすべてのAPIコールで正規のuserIdを指定する必要があります。ユーザーを識別する正規のuserIdがクライアントにない場合、OARMシステムではユーザーの作成時に正規のIDが生成されます。そのユーザーに対する後続のすべてのAPIコールで、生成された正規のuserIdをそのユーザーに指定する必要があります。
    正規のuserIdが指定されていない場合、またはシステムに存在しない正規のuserIdが指定されている場合は、新しいユーザーがシステムに作成されます。ユーザー・レコードは、指定された正規のuserIdに基づいてシステムで検出されます。
    正規のuserIdは、loginNameおよびgroupNameを使用してユーザー・プリファレンスをコールすることで、OARMシステムで検出できます。
ネストされたスキーマ: DeviceFingerprintDataList
型: array
デバイス・フィンガープリント・データのリスト
ソースを表示
ネストされたスキーマ: IPData
型: object
認証中に使用されるIP関連データ
ソースを表示
  • 位置の緯度。最小値は-90 (南半球の場合は負の値)で、最大値は+90 (北半球の場合は正の値)です
  • この属性は、位置情報(経度、緯度のペア)の精度を示します。この属性は、位置精度単位とともに精度を示します。典型的な例は、指定された座標から2メートル以内を示します。この例では、この属性の値は2.0になり、位置精度タイプの値は、メートルを指す列挙になります。
  • locationAccuracyが存在する場合は必須です。この属性は、locationAccuracy属性とともに、位置情報(経度、緯度のペア)の精度を示します。この属性は、位置精度単位とともに精度を示します。典型的な例は、指定された座標から2メートル以内を示します。この例では、この属性の値はメートルを指す列挙になり、locationAccuracy属性の値は2.0になります。
  • rfc3339セクション5.6の形式の日時文字列。https://tools.ietf.org/html/rfc3339#section-5.6 (例: 2021-08-13T01:29:29.768Z)
  • locationAccuracyが存在する場合は必須です。この属性は、位置が取得されたタイプ/メソッドを示します。これは、location.source.type.enumタイプの列挙です。可能な整数値の中には、gps、アシストgps、wifiホットスポットなどに対応するものがあります。
  • 位置の経度。最小値は-180 (西半球の場合は負の値)で、最大値は+180 (東半球の場合は正の値)です。
  • この属性は、プロキシが存在する場合のセッションのプロキシIPアドレスです。(A.B.C.D形式)
  • この属性は、リクエストを受信するリモート・ホスト・マシン名を取得します。
  • この属性は、セッションのIPアドレスを文字列形式で取得します。(A.B.C.D)
ネストされたスキーマ: SessionData
型: object
リクエストに存在するセッション・データ。
ソースを表示
ネストされたスキーマ: SessionRiskUserData
型: object
ユーザー関連データ。loginNameは必須パラメータです。
ユーザーを一意に識別できる正規のuserIdがクライアントにある場合、正規のuserIdを使用するすべてのAPIコールで正規のuserIdを指定する必要があります。ユーザーを識別する正規のuserIdがクライアントにない場合、OARMシステムではユーザーの作成時に正規のIDが生成されます。そのユーザーに対する後続のすべてのAPIコールで、生成された正規のuserIdをそのユーザーに指定する必要があります。
正規のuserIdが指定されていない場合、またはシステムに存在しない正規のuserIdが指定されている場合は、新しいユーザーがシステムに作成されます。ユーザー・レコードは、指定された正規のuserIdに基づいてシステムで検出されます。
正規のuserIdは、loginNameおよびgroupNameを使用してユーザー・プリファレンスをコールすることで、OARMシステムで検出できます。
ソースを表示
  • グループ名。loginNameとgroupNameの組合せは一意である必要があります。
  • 認証に使用されるログイン名
  • 正規のユーザー識別子。このユーザーIDは、指定された場合、ユーザーを識別するメカニズムになります。このパラメータを指定しない場合、loginNameとgroupNameの組合せを使用してユーザーの検索が行われます。
ネストされたスキーマ: DeviceFingerprintData
型: object
リクエストに存在するデバイス・フィンガープリント・データ
ソースを表示
先頭に戻る

レスポンス

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

201レスポンス

リクエストのセッションを作成します。
本文()
ルート・スキーマ: CreateSessionResponse
型: object
セッション作成レスポンス
ソースを表示
ネストされたスキーマ: CookieSet
型: object
ソースを表示
ネストされたスキーマ: StatusResponse
型: object
APIコールのステータス情報
ソースを表示
ネストされたスキーマ: SessionUserData
型: object
ユーザー関連データ
ソースを表示

400レスポンス

無効な入力
本文()
ルート・スキーマ: StatusResponse
型: object
APIコールのステータス情報
ソースを表示
ネストされたスキーマ: SessionUserData
型: object
ユーザー関連データ
ソースを表示

401レスポンス

未認可

500レスポンス

内部サーバー・エラー

503レスポンス

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

例

次の例では、ユーザー認証リクエストのOARMセッションを作成するサンプルのリクエストとレスポンスを示します。

JSON形式でOARMセッションを作成するcURLコマンド

curl --location --request POST '<RISK>/risk-analyzer/session/v1' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '{
    "user": {
        "loginName": "user1",
        "groupName": "financeapp",
        "userId": "22a29071-16f2-4b69-a94c-73be672e34eb"
    },
    "ip": {
        "remoteIP": "10.175.171.219",
        "remoteHost": "TESTCLIENT",
        "proxyIP": "10.175.171.219"
    },
    "fpList": [
        {
            "cookie": "",
            "fingerprint": "accept-encoding#^#gzip, deflate, br#^#accept-language#^#en-GB,en;q=0.9#^#userAgent#^#Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko)Chrome/112.0.0.0 Safari/537.36",
            "cookieType": "1"
        },
        {
            "cookie": "",
            "fingerprint": "acn#^#Mozilla#^#ah#^#1040#^#an#^#Netscape#^#av#^#5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/109.0.0.0 Safari/537.36#^#aw#^#1920#^#cd#^#24#^#ce#^#true#^#gl#^#51.4108518,-0.8705637,16.634#^#h#^#1080#^#je#^#false#^#l#^#en-GB#^#mt#^#application/pdf,text/pdf#^#o#^#true#^#p#^#Win32#^#pd#^#24#^#pl#^#PDF Viewer,Chrome PDF Viewer,Chromium PDF Viewer,Microsoft Edge PDF Viewer,WebKit built-in PDF#^#prod#^#Gecko#^#prods#^#20030107#^#tzo#^#0#^#ua#^#Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/109.0.0.0 Safari/537.6#^#w#^#1920",
            "cookieType": "4"
        }
    ],
    "sessionData": {
        "authenticationStatus": "999",
        "registerDevice": "false",
        "clientApplication": "OAA",
        "clientType": "0",
        "clientVersion": "12.2.1.4.0",
        "analyzePatterns": "true"
    }
}
'

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

{
    "cookieSet": {
        "digitalCookie": "2c5eae23-96f6-4721-997e-059748e70165",
        "secureCookie": "c65230e1-d909-4f13-8c91-9c72e555e3a3",
        "requestId": "9cc1b37c-2ce9-49b6-8103-85d0e59a7f1f"
    },
    "statusResponse": {
        "responseCode": "0",
        "responseMessage": "",
        "status": true,
        "sessionId": "9cc1b37c-2ce9-49b6-8103-85d0e59a7f1f"
    }
}

XML形式でOARMセッションを作成するcURLコマンド

curl --location --request POST '<RISK>/risk-analyzer/session/v1' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '
<?xml version="1.0" encoding="UTF-8" ?>
<CreateSessionRequest>
    <user>
        <loginName>user1</loginName>
        <groupName>financeapp</groupName>
        <userId>22a29071-16f2-4b69-a94c-73be672e34eb</userId>
    </user>
    <ip>
        <remoteIP>10.175.171.219</remoteIP>
        <remoteHost>TESTCLIENT</remoteHost>
        <proxyIP>10.175.171.219</proxyIP>
    </ip>
    <fpList>
        <cookie></cookie>
        <fingerprint>accept-encoding#^#gzip, deflate, br#^#accept-language#^#en-GB,en;q=0.9#^#userAgent#^#Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko)Chrome/112.0.0.0 Safari/537.36</fingerprint>
        <cookieType>1</cookieType>
    </fpList>
    <fpList>
        <cookie></cookie>
        <fingerprint>acn#^#Mozilla#^#ah#^#1040#^#an#^#Netscape#^#av#^#5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/109.0.0.0 Safari/537.36#^#aw#^#1920#^#cd#^#24#^#ce#^#true#^#gl#^#51.4108518,-0.8705637,16.634#^#h#^#1080#^#je#^#false#^#l#^#en-GB#^#mt#^#application/pdf,text/pdf#^#o#^#true#^#p#^#Win32#^#pd#^#24#^#pl#^#PDF Viewer,Chrome PDF Viewer,Chromium PDF Viewer,Microsoft Edge PDF Viewer,WebKit built-in PDF#^#prod#^#Gecko#^#prods#^#20030107#^#tzo#^#0#^#ua#^#Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/109.0.0.0 Safari/537.6#^#w#^#1920</fingerprint>
        <cookieType>4</cookieType>
    </fpList>
    <sessionData>
        <authenticationStatus>999</authenticationStatus>
        <registerDevice>false</registerDevice>
        <clientApplication>OAA</clientApplication>
        <clientType>0</clientType>
        <clientVersion>12.2.1.4.0</clientVersion>
        <analyzePatterns>true</analyzePatterns>
    </sessionData>
</CreateSessionRequest>'

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<CreateSessionResponse>
    <cookieSet>
        <digitalCookie>47d96150-783e-4c67-94a8-4e17d0d67748</digitalCookie>
        <secureCookie>5e65f8c5-51e7-435f-89ad-379ab014bc5d</secureCookie>
        <requestId>8b39a615-51f8-4ca9-b8d8-f5b0e71e6ca6</requestId>
    </cookieSet>
    <statusResponse>
        <responseCode>0</responseCode>
        <responseMessage></responseMessage>
        <status>true</status>
        <sessionId>8b39a615-51f8-4ca9-b8d8-f5b0e71e6ca6</sessionId>
    </statusResponse>
</CreateSessionResponse>
先頭に戻る