ジャンプ先

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

既存のセッションの詳細のフェッチ

put

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

指定されたリクエストIDのセッションの詳細がフェッチされます。

リクエスト

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

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

• application/xml
• application/json

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

ルート・スキーマ: schema

型: object

リクエスト本文に存在するRequestId。

ソースを表示

• requestId(required): string
  リクエストのリクエストID

{
    "type":"object",
    "description":"RequestId present in the request body.",
    "required":[
        "requestId"
    ],
    "properties":{
        "requestId":{
            "type":"string",
            "description":"requestId for the request"
        }
    }
}

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

ルート・スキーマ: schema

型: object

リクエスト本文に存在するRequestId。

ソースを表示

• requestId(required): string
  リクエストのリクエストID

{
    "type":"object",
    "description":"RequestId present in the request body.",
    "required":[
        "requestId"
    ],
    "properties":{
        "requestId":{
            "type":"string",
            "description":"requestId for the request"
        }
    }
}

先頭に戻る

レスポンス

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

• 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レスポンス

サービス使用不可

先頭に戻る

例

次の例では、特定のリクエストIDのセッション詳細を取得するサンプルのリクエストおよびレスポンスを示します。

JSON形式でセッション詳細をフェッチするcURLコマンド

curl --location --request PUT '<RISK>/risk-analyzer/session/v1/fetchsessionsecurely' \
--header 'Content-Type: application/json' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '{
    "requestId":"c3b0af07-942a-42da-b1f7-3edb52c07dd8"
}'

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

{
    "status": true,
    "sessionId": "c3b0af07-942a-42da-b1f7-3edb52c07dd8",
    "userData": {
        "loginName": "user1",
        "groupName": "financeapp",
        "userId": "22a29071-16f2-4b69-a94c-73be672e34eb"
    }
}

XML形式でセッション詳細をフェッチするcURLコマンド

curl --location --request PUT '<RISK>/risk-analyzer/session/v1/fetchsessionsecurely' \
--header 'Content-Type: application/xml' \
--header 'Accept: application/xml' \
--header 'Authorization: Basic <Base64Encoded(<username>:<password>)>' \
--data '
<?xml version="1.0" encoding="UTF-8" ?>
<RequestData>
	<requestId>c3b0af07-942a-42da-b1f7-3edb52c07dd8</requestId>
</RequestData>'

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<StatusResponse>
    <status>true</status>
    <sessionId>c3b0af07-942a-42da-b1f7-3edb52c07dd8</sessionId>
    <userData>
        <loginName>user1</loginName>
        <groupName>financeapp</groupName>
        <userId>22a29071-16f2-4b69-a94c-73be672e34eb</userId>
    </userData>
</StatusResponse>

先頭に戻る