ジャンプ先

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

セッションの認証ステータスの更新

put

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

ユーザー・ログインの場合、認証ステータスはステータスを反映します。

リクエスト

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

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

• application/xml
• application/json

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

ルート・スキーマ: schema

型: 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"
        }
    }
}

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

ルート・スキーマ: schema

型: 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"
        }
    }
}

先頭に戻る

レスポンス

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

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

200レスポンス

ユーザー認証セッション・ステータスが更新されました

本文()

ルート・スキーマ: 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レスポンス

サービス使用不可

先頭に戻る

例

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

JSON形式のセッション・ステータスを更新するcURLコマンド

curl --location --request PUT '<RISK>/risk-analyzer/session/v1/updatesessionsecurely' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '{
        "requestId":"96eb744b-b84e-4c13-8b78-06b64ad81d94",
        "authenticationStatus": "999",
        "registerDevice": "true",
        "clientApplication": "OAA Update",
        "clientType": "0",
        "clientVersion": "12.2.1.4.2",
        "analyzePatterns": "true"
}'

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

{
    "responseCode": "0",
    "responseMessage": "",
    "status": true,
    "sessionId": "96eb744b-b84e-4c13-8b78-06b64ad81d94"
}

XML形式のセッション・ステータスを更新するcURLコマンド

curl --location --request PUT '<RISK>/risk-analyzer/session/v1/updatesessionsecurely' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '
<?xml version="1.0" encoding="UTF-8" ?>
<SessionData>
	<requestId>96eb744b-b84e-4c13-8b78-06b64ad81d94</requestId>
	<authenticationStatus>999</authenticationStatus>
	<registerDevice>true</registerDevice>
	<clientApplication>OAA Update</clientApplication>
	<clientType>0</clientType>
	<clientVersion>12.2.1.4.2</clientVersion>
	<analyzePatterns>true</analyzePatterns>
</SessionData>
'

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<StatusResponse>
	<responseCode>0</responseCode>
	<responseMessage></responseMessage>
	<status>true</status>
	<sessionId>96eb744b-b84e-4c13-8b78-06b64ad81d94</sessionId>
</StatusResponse>

先頭に戻る