非推奨 - セッションの認証ステータスの更新
put
https://oaainstall-host/risk-analyzer/session/v1/{requestId}
非推奨: updatesessionsecurely APIを使用してください。このAPIは、ユーザーのセッションの認証ステータスを更新します
リクエスト
パス・パラメータ
サポートされているメディア・タイプ
- application/xml
- 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
ルート・スキーマ: 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
レスポンス
サポートされているメディア・タイプ
- 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
ユーザー関連データ
ネストされたスキーマ: SessionUserData
型:
object
ユーザー関連データ
ソースを表示
-
groupName(required): string
グループ名
-
loginName(required): string
認証に使用されるログイン名
-
userId: string
ユーザー識別子。
401レスポンス
未認可
405レスポンス
無効な入力
ルート・スキーマ: StatusResponse
型:
object
APIコールのステータス情報
ソースを表示
-
responseCode: string
リクエストのステータス・コード
-
responseMessage: string
レスポンス・コードに関連するレスポンス・メッセージ(必要に応じて)。
-
sessionId: string
認証のセッションID。
-
status: boolean
認証更新リクエスト・ステータス
-
transactionId: number
トランザクション・データの場合はtransactionId。
-
userData: object SessionUserData
ユーザー関連データ
ネストされたスキーマ: SessionUserData
型:
object
ユーザー関連データ
ソースを表示
-
groupName(required): string
グループ名
-
loginName(required): string
認証に使用されるログイン名
-
userId: string
ユーザー識別子。
500レスポンス
内部サーバー・エラー
503レスポンス
サービス使用不可