Skip to main content

device_service.proto

path agntcy/identity/service/v1alpha1/device_service.proto

package agntcy.identity.service.v1alpha1


Messages​

AddDeviceRequest​

NameTypeDescription
deviceDeviceThe device information to register.

DeleteDeviceRequest​

NameTypeDescription
device_idstringThe device id.

ListDevicesRequest​

NameTypeDescription
pageoptional int32The current page of the pagination
sizeoptional int32The page size of the pagination
queryoptional stringThe search query

ListDevicesResponse​

NameTypeDescription
devicesrepeated DeviceA list of Apps.
paginationoptional PagedResponsePagination response.

RegisterDeviceRequest​

NameTypeDescription
device_idstringThe unique identifier for the device to register.
deviceDeviceThe device information to register.

TestDeviceRequest​

NameTypeDescription
device_idstringThe device id.

Services​

DeviceService​

DeviceService manages device.

AddDevice​

MethodAddDevice
RequestAddDeviceRequest
ResponseDevice
DescriptionAdd new device for approval flow

RegisterDevice​

MethodRegisterDevice
RequestRegisterDeviceRequest
ResponseEmpty
DescriptionAdd new device for approval flow

ListDevices​

MethodListDevices
RequestListDevicesRequest
ResponseListDevicesResponse
DescriptionList all registered devices

DeleteDevice​

MethodDeleteDevice
RequestDeleteDeviceRequest
ResponseEmpty
DescriptionDelete a registered Device.

TestDevice​

MethodTestDevice
RequestTestDeviceRequest
ResponseEmpty
DescriptionSend a test notification to a registered device to see if it's well configured.