Jump to

• Request
• Response

Fetch user device

get

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

Fetch user device for the given request id

Request

Path Parameters

• requestId(required): string

There's no request body for this operation.

Back to Top

Response

Supported Media Types

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

200 Response

User device is fetched

Body ()

Root Schema : UserDevice

Type: object

Device information for the given user.

Show Source

• deviceMapId: number
  Unique identifier for this UserDevice.
• friendlyName: string
  The user friendly name for this device.
• isSecure: boolean
  True if this device is secure / has been registered by the user.
• userId: string
  The extUserId of the VTUser associated with this device.

{
    "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 Response

Unauthorized

405 Response

Invalid input

Body ()

Root Schema : UserDeviceApiResponse

Type: object

User device API response for status of the rest call

Show Source

• responseCode: string
  status code of the request
• responseMessage: string
  response message related to the response code if needed.
• success: boolean
  status of the operation.

{
    "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 Response

Internal server error

503 Response

Service Unavailable

Back to Top