ジャンプ先

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

ユーザー・デバイスのフェッチ

get

https://oaainstall-host/risk-analyzer/device/v1/{requestId}

指定されたリクエストIDのユーザー・デバイスをフェッチします

リクエスト

パス・パラメータ

• requestId(required): string

この操作にはリクエスト本文はありません。

先頭に戻る

レスポンス

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

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

200レスポンス

ユーザー・デバイスがフェッチされます

本文()

ルート・スキーマ: UserDevice

型: object

指定されたユーザーのデバイス情報。

ソースを表示

• deviceMapId: number
  このUserDeviceの一意の識別子。
• friendlyName: string
  このデバイスのわかりやすい名前。
• isSecure: boolean
  このデバイスがセキュアであるか、ユーザーによって登録されている場合はTrue。
• userId: string
  このデバイスに関連付けられているVTUserのextUserId。

{
    "type":"object",
    "description":"Device information for the given user.",
    "properties":{
        "deviceMapId":{
            "type":"number",
            "description":"Unique identifier for this UserDevice."
        },
        "userId":{
            "type":"string",
            "description":"The extUserId of the VTUser associated with this device."
        },
        "isSecure":{
            "type":"boolean",
            "description":"True if this device is secure / has been registered by the user."
        },
        "friendlyName":{
            "type":"string",
            "description":"The user friendly name for this device."
        }
    }
}

401レスポンス

未認可

405レスポンス

無効な入力

本文()

ルート・スキーマ: UserDeviceApiResponse

型: object

RESTコールのステータスに対するユーザー・デバイスAPIレスポンス

ソースを表示

• responseCode: string
  リクエストのステータス・コード
• responseMessage: string
  レスポンス・コードに関連するレスポンス・メッセージ(必要に応じて)。
• success: boolean
  操作のステータス

{
    "type":"object",
    "description":"User device API response for status of the rest call",
    "properties":{
        "success":{
            "type":"boolean",
            "description":"status of the operation."
        },
        "responseCode":{
            "type":"string",
            "description":"status code of the request"
        },
        "responseMessage":{
            "type":"string",
            "description":"response message related to the response code if needed."
        }
    }
}

500レスポンス

内部サーバー・エラー

503レスポンス

サービス使用不可

先頭に戻る