CoAP GET /iam/pairing

DESCRIPTION

This endpoint provides general information about the device as well as listing the pairing modes available for the particular connection. It is used to determine which pairing flow to start. It can also be used to get general device information after pairing.

DECLARATION

GET /iam/pairing

REQUEST

Request body is empty.

RESPONSE

CoAP status codes:

  • 205: On success.
  • 403: Blocked by IAM configuration.

Response body:

{
    "Modes": ["LocalInitial", "PasswordOpen", "LocalOpen", "PasswordInvite"],
    "NabtoVersion": "<semver string>",
    "AppVersion": "<semver string>",
    "AppName": "application name",
    "ProductId": "<product id>",
    "DeviceId": "<device id>"
}
Modes:
List of the pairing modes available on the connection.
NabtoVersion:
The version of the Nabto Embedded SDK used by the device.
AppVersion:
The version of the application running the device (set by [nabto_device_set_app_version()](/developer/api-reference/embedded-device-sdk/context/nabto_device_set_app_version.html)).
AppName:
The name of the application running the device (set by [nabto_device_set_app_name()](/developer/api-reference/embedded-device-sdk/context/nabto_device_set_app_name.html)).
ProductId:
The product ID of the device.
DeviceId:
The unique ID of the device.

IAM PARAMETERS

A user must have access to the following IAM Action to use this endpoint:

  • IAM:GetPairing

No special attributes are provided.