Devices

Use these methods to obtain and manage information about the devices from which clients were signed in to the B2Core UI.

GET[host]/api/v2/clients/{clientId}/devices

Get a list of devices

GET[host]/api/v2/clients/{clientId}/devices/{deviceId}

Get device details

DELETE[host]/api/v2/clients/{clientId}/devices/{deviceId}

Delete a device

Get a list of devices

Use this method to obtain a list of devices from which a client was signed in to the B2Core UI.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Query parameters:

The following filter parameter is available for this method:

ipAddress

The client IP address.

The following sorting parameter is available for this method:

createTime

The date and time when a device was added to a list of client devices.

Refer to the Query parameters section of the API Overview for details on applying filter and sorting parameters.

Path parameters:

clientId required

The client identifier.

GET[host]/api/v2/clients/{clientId}/devices

curl --location -g --request GET 'https://host.name/api/v2/clients/1/devices?limit=10&offset=0&sort_order=desc&sort_by=createTime&filter[ipAddress]=127.0.0.1' \
--header 'Authorization: Bearer <token>'

Response

A response contains an array of Device objects providing information about the devices that correspond to the query parameters included in the request.

Get device details

Use this method to obtain detailed information about a specified client device.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Path parameters:

clientId required

The client identifier.

deviceId required

The device identifier.

GET[host]/api/v2/clients/{clientId}/devices/{deviceId}

curl --location --request GET 'https://host.name/api/v2/clients/1/devices/1' \
--header 'Authorization: Bearer <token>'

Response

A response contains a Device object providing information about the specified client device.

Delete a device

Use this method to delete a specified device from a list of client devices.

Request

Header parameters:

  • Authorization: Bearer <access_token>

Path parameters:

clientId required

The client identifier.

deviceId required

The device identifier.

DELETE[host]/api/v2/clients/{clientId}/devices/{deviceId}

curl --location --request DELETE 'https://host.name/api/v2/clients/1/devices/1' \
--header 'Authorization: Bearer <token>'

Response

In case of success, no response body is returned.