ジャンプ先

• リクエスト
• レスポンス
• 例

セッションの作成

post

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

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

リクエスト

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

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

• application/xml
• application/json

リクエスト本文 - application/xml ()

ルート・スキーマ: schema

型: object

セッションを作成するためのリクエスト・オブジェクト

ソースを表示

• fpList: array DeviceFingerprintDataList
  デバイス・フィンガープリント・データのリスト
• ip: object IPData
  認証中に使用されるIP関連データ
• requestId: string
  リクエストのリクエストID。移入されない場合は、サーバーで生成され、レスポンスで返されます。
• requestTime: string (date-time)
  rfc3339セクション5.6の形式の日時文字列。https://tools.ietf.org/html/rfc3339#section-5.6 (例: 2021-08-13T01:29:29.768Z)
• sessionData: object SessionData
  リクエストに存在するセッション・データ。
• user: object SessionUserData
  ユーザー関連データ

{
    "type":"object",
    "description":"Request object for creating the session",
    "properties":{
        "requestId":{
            "type":"string",
            "description":"requestId for the request. If not populated will be generated in the server and returned in the response."
        },
        "requestTime":{
            "$ref":"#/components/schemas/DateTime",
            "description":"The date-time stamp on the request. (If not populated then will be generated in the server)"
        },
        "user":{
            "$ref":"#/components/schemas/SessionUserData",
            "description":"User Data associated with this session."
        },
        "ip":{
            "$ref":"#/components/schemas/IPData",
            "description":"IP Address data assocuated with this session."
        },
        "fpList":{
            "$ref":"#/components/schemas/DeviceFingerprintDataList",
            "description":"List of device fingerprints."
        },
        "sessionData":{
            "$ref":"#/components/schemas/SessionData",
            "description":"Session data associated with this session."
        }
    }
}

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

型: array

デバイス・フィンガープリント・データのリスト

ソースを表示

• 配列: object DeviceFingerprintData
  リクエストに存在するデバイス・フィンガープリント・データ

{
    "type":"array",
    "description":"List of the device fingerprint data",
    "items":{
        "$ref":"#/components/schemas/DeviceFingerprintData"
    }
}

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

型: object

認証中に使用されるIP関連データ

ソースを表示

• latitude: number
  位置の緯度。最小値は-90 (南半球の場合は負の値)で、最大値は+90 (北半球の場合は正の値)です
• locationAccuracy: number
  この属性は、位置情報(経度、緯度のペア)の精度を示します。この属性は、位置精度単位とともに精度を示します。典型的な例は、指定された座標から2メートル以内を示します。この例では、この属性の値は2.0になり、位置精度タイプの値は、メートルを指す列挙になります。
• locationAccuracyUnits: integer
  locationAccuracyが存在する場合は必須です。この属性は、locationAccuracy属性とともに、位置情報(経度、緯度のペア)の精度を示します。この属性は、位置精度単位とともに精度を示します。典型的な例は、指定された座標から2メートル以内を示します。この例では、この属性の値はメートルを指す列挙になり、locationAccuracy属性の値は2.0になります。
• locationAcquireTime: string (date-time)
  rfc3339セクション5.6の形式の日時文字列。https://tools.ietf.org/html/rfc3339#section-5.6 (例: 2021-08-13T01:29:29.768Z)
• locationAcquireType: integer
  locationAccuracyが存在する場合は必須です。この属性は、位置が取得されたタイプ/メソッドを示します。これは、location.source.type.enumタイプの列挙です。可能な整数値の中には、gps、アシストgps、wifiホットスポットなどに対応するものがあります。
• longitude: number
  位置の経度。最小値は-180 (西半球の場合は負の値)で、最大値は+180 (東半球の場合は正の値)です。
• proxyIP: string
  この属性は、プロキシが存在する場合のセッションのプロキシIPアドレスです。(A.B.C.D形式)
• remoteHost: string
  この属性は、リクエストを受信するリモート・ホスト・マシン名を取得します。
• remoteIP(required): string
  この属性は、セッションのIPアドレスを文字列形式で取得します。(A.B.C.D)

{
    "type":"object",
    "description":"IP related data used during authentication",
    "required":[
        "remoteIP"
    ],
    "properties":{
        "remoteIP":{
            "type":"string",
            "description":"This attribute captures the IP address of the session in String format. (A.B.C.D)"
        },
        "remoteHost":{
            "type":"string",
            "description":"This attribute captures the remote Host machine name from which the request somes in."
        },
        "proxyIP":{
            "type":"string",
            "description":"This attribute is the proxy IP address of the session if proxy is present. (in A.B.C.D format)"
        },
        "longitude":{
            "type":"number",
            "description":"The longitude of the location. Min value is -180 (negative values for western hemisphere) and max value is +180 (positive values for eastern hemispehre)."
        },
        "latitude":{
            "type":"number",
            "description":"The latitude of the location. Min value is -90 (negative values for sounthern hemisphere) and max value is +90 (positive values for northern hemisphere)"
        },
        "locationAccuracy":{
            "type":"number",
            "description":"This attribute describes the accuracy of the location information (longitude, latitude pair). This attribute along with location accuracy units will indicate the accuracy. Typical example will be say within 2 meters of the indicated co-ordinates. For this example the value of this attribute will be 2.0 and the value of location accuracy type will be a enumeration pointing to metere."
        },
        "locationAccuracyUnits":{
            "type":"integer",
            "description":"Required when locationAccuracy is present. This attribute along with locationAccuracy attribute describes the accuracy of the location information (longitude, latitude pair). This attribute along with location accuracy units will indicate the accuracy. Typical example will be say within 2 meters of the indicated co-ordinates. For this example the value of this attribute will be a enumeration pointing to meter and value of locationAccuracy attribute will be 2.0."
        },
        "locationAcquireType":{
            "type":"integer",
            "description":"Required when locationAccuracy is present. This attribute indicates the type / method by which location was acquired. This is enumeration of the type location.source.type.enum. Some of the possible integer values will correspond to gps, asisted gps, wifi hotspot etc."
        },
        "locationAcquireTime":{
            "$ref":"#/components/schemas/DateTime",
            "description":"This date-time field is the time at which mobile device acquired the location co-ordinates."
        }
    }
}

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

型: object

リクエストに存在するセッション・データ。

ソースを表示

• analyzePatterns: boolean
  このセッションに対してパターン分析を実行する必要があるかどうかを示すフラグ。パターン・ベースのルールを使用する場合は、このフラグをtrueに設定します。
• authenticationStatus(required): integer
  auth.status.enumの構成値の1つ。auth.status.enumの使用可能な値を確認するには、構成プロパティのREST API操作GETを、URL <PolicyURL>/policy/config/property/v1?propertyName=auth.status.enumとともに使用します。セッションの作成時には、保留ステータスに対応する値を使用することをお薦めします。
• clientApplication: string
  ユーザーのセッションのクライアント・アプリケーション。これはユーザー定義の値で、通常はこのAPIを使用またはこのAPIと統合しているアプリケーション名です。
• clientType(required): integer
  ユーザーのセッションのクライアント・タイプ。client.type.enumの構成値の1つ。client.type.enumの使用可能な値を確認するには、構成プロパティのREST API操作GETを、URL <PolicyURL>/policy/config/property/v1?propertyName=client.type.enumとともに使用します
• clientVersion: string
  ユーザーのセッションのクライアント・アプリケーションのバージョン。これはユーザー定義の値で、通常はこのAPIを使用またはこのAPIと統合しているアプリケーションのバージョンです。
• externalDeviceId: string
  クライアントが移入する場合は外部デバイスID。これはユーザー定義の値であり、このセッションが実行されている可能性のあるデバイス名や外部IDを識別または指定するために使用できます。セッションが実行されている端末の名前やIDが一般的な例です
• registerDevice: boolean
  属性は、trueの場合、ユーザーに対してデバイスを登録するフラグになります。
• requestId(required): string
  リクエストのリクエストID

{
    "type":"object",
    "description":"Session data present in the request.",
    "required":[
        "requestId",
        "authenticationStatus",
        "clientType"
    ],
    "properties":{
        "requestId":{
            "type":"string",
            "description":"requestId for the request"
        },
        "authenticationStatus":{
            "type":"integer",
            "description":"One of the config values from auth.status.enum. To check the possible values of the auth.status.enum, use the config property REST API operation GET with URL <PolicyURL>/policy/config/property/v1?propertyName=auth.status.enum. It is recommended to use a value corresponding to pending status when creating the session."
        },
        "registerDevice":{
            "type":"boolean",
            "description":"Attribute is flag when true will result in registering the device for the user."
        },
        "clientApplication":{
            "type":"string",
            "description":"The client application of the user's session. This is a customer defined\nvalue, typically of the application name that is  using or integrating with\nthis API."
        },
        "clientType":{
            "type":"integer",
            "description":"The client type of the user's session.\nOne of the config values from client.type.enum.\nTo check the possible values of the client.type.enum, use the config property\nREST API  operation GET  with URL\n<PolicyURL>/policy/config/property/v1?propertyName=client.type.enum"
        },
        "clientVersion":{
            "type":"string",
            "description":"The version of the client application of the user's session. This is a\ncustomer defined value, typically of the version of the application that is\nusing or integrating with this API."
        },
        "analyzePatterns":{
            "type":"boolean",
            "description":"Flag to indicate if pattern analysis should be done for this session.\nSet this flag to true, if pattern based rules are used."
        },
        "externalDeviceId":{
            "type":"string",
            "description":"External device id if the client wants to populate. This is a customer defined value, and can be used to identify, or indicate, a device name or some external Id, that this session may be coming from. A typical example can be a name or id of the terminal where the session is originating"
        }
    }
}

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

型: object

ユーザー関連データ

ソースを表示

• groupName(required): string
  グループ名
• loginName(required): string
  認証に使用されるログイン名
• userId: string
  ユーザー識別子。

{
    "type":"object",
    "description":"user related data",
    "required":[
        "loginName",
        "groupName"
    ],
    "properties":{
        "loginName":{
            "type":"string",
            "description":"Login name used for authentication"
        },
        "groupName":{
            "type":"string",
            "description":"group name"
        },
        "userId":{
            "type":"string",
            "description":"user identifier."
        }
    }
}

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

型: object

リクエストに存在するデバイス・フィンガープリント・データ

ソースを表示

• cookie: string
  リクエストのcookie
• cookieType: integer
  列挙構成vcrypt.fingerprint.type.enumのcookieタイプ値。
• fingerprint: string
  ユーザーのセッションのフィンガー・プリント・タイプ。fingerprint.type.enumの値でサポートされているのは、2つの値(ブラウザ(1)およびjavascript(4))のみです。fingerprint.type.enumの使用可能な値を確認するには、構成プロパティのREST API操作GETを、URL <PolicyURL>/policy/config/property/v1?propertyName=fingerprint.type.enumとともに使用します

{
    "type":"object",
    "description":"Device fingerprint data that is present in the request",
    "properties":{
        "cookie":{
            "type":"string",
            "description":"cookie in the request"
        },
        "fingerprint":{
            "type":"string",
            "description":"The finger print type of the user's session.\nOnly 2 values are supported (browser (1) and javascript (4) ) values from\nfingerprint.type.enum.\nTo check the possible values of the fingerprint.type.enum, use the config\nproperty REST API  operation GET  with URL\n<PolicyURL>/policy/config/property/v1?propertyName=fingerprint.type.enum"
        },
        "cookieType":{
            "type":"integer",
            "description":"cookie type value from the enum configuration vcrypt.fingerprint.type.enum."
        }
    }
}

リクエスト本文 - application/json ()

ルート・スキーマ: schema

型: object

セッションを作成するためのリクエスト・オブジェクト

ソースを表示

• fpList: array DeviceFingerprintDataList
  デバイス・フィンガープリント・データのリスト
• ip: object IPData
  認証中に使用されるIP関連データ
• requestId: string
  リクエストのリクエストID。移入されない場合は、サーバーで生成され、レスポンスで返されます。
• requestTime: string (date-time)
  rfc3339セクション5.6の形式の日時文字列。https://tools.ietf.org/html/rfc3339#section-5.6 (例: 2021-08-13T01:29:29.768Z)
• sessionData: object SessionData
  リクエストに存在するセッション・データ。
• user: object SessionUserData
  ユーザー関連データ

{
    "type":"object",
    "description":"Request object for creating the session",
    "properties":{
        "requestId":{
            "type":"string",
            "description":"requestId for the request. If not populated will be generated in the server and returned in the response."
        },
        "requestTime":{
            "$ref":"#/components/schemas/DateTime",
            "description":"The date-time stamp on the request. (If not populated then will be generated in the server)"
        },
        "user":{
            "$ref":"#/components/schemas/SessionUserData",
            "description":"User Data associated with this session."
        },
        "ip":{
            "$ref":"#/components/schemas/IPData",
            "description":"IP Address data assocuated with this session."
        },
        "fpList":{
            "$ref":"#/components/schemas/DeviceFingerprintDataList",
            "description":"List of device fingerprints."
        },
        "sessionData":{
            "$ref":"#/components/schemas/SessionData",
            "description":"Session data associated with this session."
        }
    }
}

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

型: array

デバイス・フィンガープリント・データのリスト

ソースを表示

• 配列: object DeviceFingerprintData
  リクエストに存在するデバイス・フィンガープリント・データ

{
    "type":"array",
    "description":"List of the device fingerprint data",
    "items":{
        "$ref":"#/components/schemas/DeviceFingerprintData"
    }
}

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

型: object

認証中に使用されるIP関連データ

ソースを表示

• latitude: number
  位置の緯度。最小値は-90 (南半球の場合は負の値)で、最大値は+90 (北半球の場合は正の値)です
• locationAccuracy: number
  この属性は、位置情報(経度、緯度のペア)の精度を示します。この属性は、位置精度単位とともに精度を示します。典型的な例は、指定された座標から2メートル以内を示します。この例では、この属性の値は2.0になり、位置精度タイプの値は、メートルを指す列挙になります。
• locationAccuracyUnits: integer
  locationAccuracyが存在する場合は必須です。この属性は、locationAccuracy属性とともに、位置情報(経度、緯度のペア)の精度を示します。この属性は、位置精度単位とともに精度を示します。典型的な例は、指定された座標から2メートル以内を示します。この例では、この属性の値はメートルを指す列挙になり、locationAccuracy属性の値は2.0になります。
• locationAcquireTime: string (date-time)
  rfc3339セクション5.6の形式の日時文字列。https://tools.ietf.org/html/rfc3339#section-5.6 (例: 2021-08-13T01:29:29.768Z)
• locationAcquireType: integer
  locationAccuracyが存在する場合は必須です。この属性は、位置が取得されたタイプ/メソッドを示します。これは、location.source.type.enumタイプの列挙です。可能な整数値の中には、gps、アシストgps、wifiホットスポットなどに対応するものがあります。
• longitude: number
  位置の経度。最小値は-180 (西半球の場合は負の値)で、最大値は+180 (東半球の場合は正の値)です。
• proxyIP: string
  この属性は、プロキシが存在する場合のセッションのプロキシIPアドレスです。(A.B.C.D形式)
• remoteHost: string
  この属性は、リクエストを受信するリモート・ホスト・マシン名を取得します。
• remoteIP(required): string
  この属性は、セッションのIPアドレスを文字列形式で取得します。(A.B.C.D)

{
    "type":"object",
    "description":"IP related data used during authentication",
    "required":[
        "remoteIP"
    ],
    "properties":{
        "remoteIP":{
            "type":"string",
            "description":"This attribute captures the IP address of the session in String format. (A.B.C.D)"
        },
        "remoteHost":{
            "type":"string",
            "description":"This attribute captures the remote Host machine name from which the request somes in."
        },
        "proxyIP":{
            "type":"string",
            "description":"This attribute is the proxy IP address of the session if proxy is present. (in A.B.C.D format)"
        },
        "longitude":{
            "type":"number",
            "description":"The longitude of the location. Min value is -180 (negative values for western hemisphere) and max value is +180 (positive values for eastern hemispehre)."
        },
        "latitude":{
            "type":"number",
            "description":"The latitude of the location. Min value is -90 (negative values for sounthern hemisphere) and max value is +90 (positive values for northern hemisphere)"
        },
        "locationAccuracy":{
            "type":"number",
            "description":"This attribute describes the accuracy of the location information (longitude, latitude pair). This attribute along with location accuracy units will indicate the accuracy. Typical example will be say within 2 meters of the indicated co-ordinates. For this example the value of this attribute will be 2.0 and the value of location accuracy type will be a enumeration pointing to metere."
        },
        "locationAccuracyUnits":{
            "type":"integer",
            "description":"Required when locationAccuracy is present. This attribute along with locationAccuracy attribute describes the accuracy of the location information (longitude, latitude pair). This attribute along with location accuracy units will indicate the accuracy. Typical example will be say within 2 meters of the indicated co-ordinates. For this example the value of this attribute will be a enumeration pointing to meter and value of locationAccuracy attribute will be 2.0."
        },
        "locationAcquireType":{
            "type":"integer",
            "description":"Required when locationAccuracy is present. This attribute indicates the type / method by which location was acquired. This is enumeration of the type location.source.type.enum. Some of the possible integer values will correspond to gps, asisted gps, wifi hotspot etc."
        },
        "locationAcquireTime":{
            "$ref":"#/components/schemas/DateTime",
            "description":"This date-time field is the time at which mobile device acquired the location co-ordinates."
        }
    }
}

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

型: object

リクエストに存在するセッション・データ。

ソースを表示

• analyzePatterns: boolean
  このセッションに対してパターン分析を実行する必要があるかどうかを示すフラグ。パターン・ベースのルールを使用する場合は、このフラグをtrueに設定します。
• authenticationStatus(required): integer
  auth.status.enumの構成値の1つ。auth.status.enumの使用可能な値を確認するには、構成プロパティのREST API操作GETを、URL <PolicyURL>/policy/config/property/v1?propertyName=auth.status.enumとともに使用します。セッションの作成時には、保留ステータスに対応する値を使用することをお薦めします。
• clientApplication: string
  ユーザーのセッションのクライアント・アプリケーション。これはユーザー定義の値で、通常はこのAPIを使用またはこのAPIと統合しているアプリケーション名です。
• clientType(required): integer
  ユーザーのセッションのクライアント・タイプ。client.type.enumの構成値の1つ。client.type.enumの使用可能な値を確認するには、構成プロパティのREST API操作GETを、URL <PolicyURL>/policy/config/property/v1?propertyName=client.type.enumとともに使用します
• clientVersion: string
  ユーザーのセッションのクライアント・アプリケーションのバージョン。これはユーザー定義の値で、通常はこのAPIを使用またはこのAPIと統合しているアプリケーションのバージョンです。
• externalDeviceId: string
  クライアントが移入する場合は外部デバイスID。これはユーザー定義の値であり、このセッションが実行されている可能性のあるデバイス名や外部IDを識別または指定するために使用できます。セッションが実行されている端末の名前やIDが一般的な例です
• registerDevice: boolean
  属性は、trueの場合、ユーザーに対してデバイスを登録するフラグになります。
• requestId(required): string
  リクエストのリクエストID

{
    "type":"object",
    "description":"Session data present in the request.",
    "required":[
        "requestId",
        "authenticationStatus",
        "clientType"
    ],
    "properties":{
        "requestId":{
            "type":"string",
            "description":"requestId for the request"
        },
        "authenticationStatus":{
            "type":"integer",
            "description":"One of the config values from auth.status.enum. To check the possible values of the auth.status.enum, use the config property REST API operation GET with URL <PolicyURL>/policy/config/property/v1?propertyName=auth.status.enum. It is recommended to use a value corresponding to pending status when creating the session."
        },
        "registerDevice":{
            "type":"boolean",
            "description":"Attribute is flag when true will result in registering the device for the user."
        },
        "clientApplication":{
            "type":"string",
            "description":"The client application of the user's session. This is a customer defined\nvalue, typically of the application name that is  using or integrating with\nthis API."
        },
        "clientType":{
            "type":"integer",
            "description":"The client type of the user's session.\nOne of the config values from client.type.enum.\nTo check the possible values of the client.type.enum, use the config property\nREST API  operation GET  with URL\n<PolicyURL>/policy/config/property/v1?propertyName=client.type.enum"
        },
        "clientVersion":{
            "type":"string",
            "description":"The version of the client application of the user's session. This is a\ncustomer defined value, typically of the version of the application that is\nusing or integrating with this API."
        },
        "analyzePatterns":{
            "type":"boolean",
            "description":"Flag to indicate if pattern analysis should be done for this session.\nSet this flag to true, if pattern based rules are used."
        },
        "externalDeviceId":{
            "type":"string",
            "description":"External device id if the client wants to populate. This is a customer defined value, and can be used to identify, or indicate, a device name or some external Id, that this session may be coming from. A typical example can be a name or id of the terminal where the session is originating"
        }
    }
}

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

型: object

ユーザー関連データ

ソースを表示

• groupName(required): string
  グループ名
• loginName(required): string
  認証に使用されるログイン名
• userId: string
  ユーザー識別子。

{
    "type":"object",
    "description":"user related data",
    "required":[
        "loginName",
        "groupName"
    ],
    "properties":{
        "loginName":{
            "type":"string",
            "description":"Login name used for authentication"
        },
        "groupName":{
            "type":"string",
            "description":"group name"
        },
        "userId":{
            "type":"string",
            "description":"user identifier."
        }
    }
}

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

型: object

リクエストに存在するデバイス・フィンガープリント・データ

ソースを表示

• cookie: string
  リクエストのcookie
• cookieType: integer
  列挙構成vcrypt.fingerprint.type.enumのcookieタイプ値。
• fingerprint: string
  ユーザーのセッションのフィンガー・プリント・タイプ。fingerprint.type.enumの値でサポートされているのは、2つの値(ブラウザ(1)およびjavascript(4))のみです。fingerprint.type.enumの使用可能な値を確認するには、構成プロパティのREST API操作GETを、URL <PolicyURL>/policy/config/property/v1?propertyName=fingerprint.type.enumとともに使用します

{
    "type":"object",
    "description":"Device fingerprint data that is present in the request",
    "properties":{
        "cookie":{
            "type":"string",
            "description":"cookie in the request"
        },
        "fingerprint":{
            "type":"string",
            "description":"The finger print type of the user's session.\nOnly 2 values are supported (browser (1) and javascript (4) ) values from\nfingerprint.type.enum.\nTo check the possible values of the fingerprint.type.enum, use the config\nproperty REST API  operation GET  with URL\n<PolicyURL>/policy/config/property/v1?propertyName=fingerprint.type.enum"
        },
        "cookieType":{
            "type":"integer",
            "description":"cookie type value from the enum configuration vcrypt.fingerprint.type.enum."
        }
    }
}

先頭に戻る

レスポンス

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

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

201レスポンス

リクエストのセッションを作成します。

本文()

ルート・スキーマ: CreateSessionResponse

型: object

セッション作成レスポンス

ソースを表示

• cookieSet: object CookieSet
• statusResponse: object StatusResponse
  APIコールのステータス情報

{
    "type":"object",
    "description":"session create response",
    "properties":{
        "cookieSet":{
            "$ref":"#/components/schemas/CookieSet"
        },
        "statusResponse":{
            "$ref":"#/components/schemas/StatusResponse"
        }
    }
}

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

型: object

ソースを表示

• digitalCookie: string
  デジタルcookie
• requestId: string
  リクエスト識別子
• secureCookie: string
  セキュアなcookie

{
    "type":"object",
    "properties":{
        "digitalCookie":{
            "type":"string",
            "description":"Digital cookie"
        },
        "secureCookie":{
            "type":"string",
            "description":"secure cookie"
        },
        "requestId":{
            "type":"string",
            "description":"Request identifier"
        }
    }
}

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

型: object

APIコールのステータス情報

ソースを表示

• responseCode: string
  リクエストのステータス・コード
• responseMessage: string
  レスポンス・コードに関連するレスポンス・メッセージ(必要に応じて)。
• sessionId: string
  認証のセッションID。
• status: boolean
  認証更新リクエスト・ステータス
• transactionId: number
  トランザクション・データの場合はtransactionId。
• userData: object SessionUserData
  ユーザー関連データ

{
    "type":"object",
    "description":"Status information for API call",
    "properties":{
        "responseCode":{
            "type":"string",
            "description":"status code of the request"
        },
        "responseMessage":{
            "type":"string",
            "description":"response message related to the response code if needed."
        },
        "status":{
            "type":"boolean",
            "description":"authentication update request status"
        },
        "sessionId":{
            "type":"string",
            "description":"session id of the authentcation."
        },
        "transactionId":{
            "type":"number",
            "description":"transactionId in case of transaction data."
        },
        "userData":{
            "$ref":"#/components/schemas/SessionUserData",
            "description":"user data used in the session."
        }
    }
}

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

型: object

ユーザー関連データ

ソースを表示

• groupName(required): string
  グループ名
• loginName(required): string
  認証に使用されるログイン名
• userId: string
  ユーザー識別子。

{
    "type":"object",
    "description":"user related data",
    "required":[
        "loginName",
        "groupName"
    ],
    "properties":{
        "loginName":{
            "type":"string",
            "description":"Login name used for authentication"
        },
        "groupName":{
            "type":"string",
            "description":"group name"
        },
        "userId":{
            "type":"string",
            "description":"user identifier."
        }
    }
}

400レスポンス

無効な入力

本文()

ルート・スキーマ: StatusResponse

型: object

APIコールのステータス情報

ソースを表示

• responseCode: string
  リクエストのステータス・コード
• responseMessage: string
  レスポンス・コードに関連するレスポンス・メッセージ(必要に応じて)。
• sessionId: string
  認証のセッションID。
• status: boolean
  認証更新リクエスト・ステータス
• transactionId: number
  トランザクション・データの場合はtransactionId。
• userData: object SessionUserData
  ユーザー関連データ

{
    "type":"object",
    "description":"Status information for API call",
    "properties":{
        "responseCode":{
            "type":"string",
            "description":"status code of the request"
        },
        "responseMessage":{
            "type":"string",
            "description":"response message related to the response code if needed."
        },
        "status":{
            "type":"boolean",
            "description":"authentication update request status"
        },
        "sessionId":{
            "type":"string",
            "description":"session id of the authentcation."
        },
        "transactionId":{
            "type":"number",
            "description":"transactionId in case of transaction data."
        },
        "userData":{
            "$ref":"#/components/schemas/SessionUserData",
            "description":"user data used in the session."
        }
    }
}

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

型: object

ユーザー関連データ

ソースを表示

• groupName(required): string
  グループ名
• loginName(required): string
  認証に使用されるログイン名
• userId: string
  ユーザー識別子。

{
    "type":"object",
    "description":"user related data",
    "required":[
        "loginName",
        "groupName"
    ],
    "properties":{
        "loginName":{
            "type":"string",
            "description":"Login name used for authentication"
        },
        "groupName":{
            "type":"string",
            "description":"group name"
        },
        "userId":{
            "type":"string",
            "description":"user identifier."
        }
    }
}

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": "testuser",
        "groupName": "default",
        "userId": "testuser"
    },
    "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": "7f3cae97-1e16-4b98-937b-3aa89a0eb721",
        "secureCookie": "2435bb9e-9d91-46ec-a4df-9a168e149cb8",
        "requestId": "96eb744b-b84e-4c13-8b78-06b64ad81d94"
    },
    "statusResponse": {
        "responseCode": "0",
        "responseMessage": "",
        "status": true,
        "sessionId": "96eb744b-b84e-4c13-8b78-06b64ad81d94"
    }
}

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>testuser</loginName>
		<groupName>default</groupName>
		<userId>testuser</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>7f3cae97-1e16-4b98-937b-3aa89a0eb721</digitalCookie>
		<secureCookie>2435bb9e-9d91-46ec-a4df-9a168e149cb8</secureCookie>
		<requestId>96eb744b-b84e-4c13-8b78-06b64ad81d94</requestId>
	</cookieSet>
	<statusResponse>
		<responseCode>0</responseCode>
		<responseMessage></responseMessage>
		<status>true</status>
		<sessionId>96eb744b-b84e-4c13-8b78-06b64ad81d94</sessionId>
	</statusResponse>
</CreateSessionResponse>

先頭に戻る