Access Device Management

Retrieve Access Device list

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/access_devices/

The API is mapped to GroupAccessDeviceGetListRequest

Retrieve Access Device details

GET /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/access_devices/(string: instance_name)/

The API is mapped to GroupAccessDeviceGetRequest

Additional informations

Response JSON Object:

• deviceName (string) – See deviceName from Access Device attributes.

• deviceType (string) – See deviceType from Access Device attributes.

• protocol (string) – See protocol from Access Device attributes.

• netAddress (string) – See netAddress from Access Device attributes.

• netPort (integer) – See netPort from Access Device attributes.

• outboundProxyServerNetAddress (string) – See outboundProxyServerNetAddress from Access Device attributes.

• stunServerNetAddress (string) – See stunServerNetAddress from Access Device attributes.

• macAddress (string) – See macAddress from Access Device attributes.

• serialNumber (string) – See serialNumber from Access Device attributes.

• description (string) – See description from Access Device attributes.

• numberOfPorts (integer) – See numberOfPorts from Access Device attributes.

• numberOfAssignedPorts (integer) – See numberOfAssignedPorts from Access Device attributes.

• status (string) – See status from Access Device attributes.

• physicalLocation (string) – See physicalLocation from Access Device attributes.

• transportProtocol (string) – See transportProtocol from Access Device attributes.

• useCustomUserNamePassword (string) – See useCustomUserNamePassword from Access Device attributes.

• userName (string) – See userName from Access Device attributes.

• version (string) – See version from Access Device attributes.

Create an access device

POST /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/access_devices/

The API is mapped to GroupAccessDeviceAddRequest

Additional restrictions

Request JSON Object:

• deviceName (string) – See deviceName from Access Device attributes.

• deviceType (string) – See deviceType from Access Device attributes.

• protocol (string) – See protocol from Access Device attributes.

• netAddress (string) – See netAddress from Access Device attributes.

• netPort (integer) – See netPort from Access Device attributes.

• outboundProxyServerNetAddress (string) – See outboundProxyServerNetAddress from Access Device attributes.

• stunServerNetAddress (string) – See stunServerNetAddress from Access Device attributes.

• macAddress (string) – See macAddress from Access Device attributes.

• serialNumber (string) – See serialNumber from Access Device attributes.

• description (string) – See description from Access Device attributes.

• physicalLocation (string) – See physicalLocation from Access Device attributes.

• transportProtocol (string) – See transportProtocol from Access Device attributes.

• useCustomUserNamePassword (string) – See useCustomUserNamePassword from Access Device attributes.

• accessDeviceCredentials (string) – See accessDeviceCredentials from Access Device attributes.

Update an access device

PUT /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/access_devices/(string: instance_name)/

The API is mapped to GroupAccessDeviceModifyRequest

Additional restrictions

Request JSON Object:

• protocol (string) – See protocol from Access Device attributes.

• netAddress (string) – See netAddress from Access Device attributes.

• netPort (integer) – See netPort from Access Device attributes.

• outboundProxyServerNetAddress (string) – See outboundProxyServerNetAddress from Access Device attributes.

• stunServerNetAddress (string) – See stunServerNetAddress from Access Device attributes.

• macAddress (string) – See macAddress from Access Device attributes.

• serialNumber (string) – See serialNumber from Access Device attributes.

• description (string) – See description from Access Device attributes.

• physicalLocation (string) – See physicalLocation from Access Device attributes.

• transportProtocol (string) – See transportProtocol from Access Device attributes.

• useCustomUserNamePassword (string) – See useCustomUserNamePassword from Access Device attributes.

• accessDeviceCredentials (string) – See accessDeviceCredentials from Access Device attributes.

Remove an access device

DELETE /api/v1/tenants/(string: tenant_id)/groups/(string: group_id)/access_devices/(string: instance_name)/

The API is mapped to GroupAccessDeviceDeleteRequest