Documentation

CoAP POST /iam/pairing/local-initial

DESCRIPTION

This endpoint pairs the current user with the target device that hosts the endpoint as the initial Pairing user.

Using this endpoint requires the connection to be local and that the initial user has not already been paired with a client. Hence, this endpoint is used for Local initial pairing.

DECLARATION

POST /iam/pairing/local-initial

REQUEST

The Username for the new user created on the device upon succesful pairing is defined through the initial pairing user as specified in the device settings. So the username is not included in the body of this request. The fingerprint set on the user during pairing can be named with the body field FingerprintName:

{
  "FingerprintName": "my phone"
}

By naming the fingerprint using FingerprintName, you ensure easy identification of user fingerprints, especially if multiple devices are paired later (e.g. “my tablet” or “my laptop”).

RESPONSE

CoAP status codes:

  • 201: Pairing completed successfully.
  • 403: Blocked by IAM configuration.
  • 404: Pairing mode disabled.
  • 409: Initial user already paired.

IAM PARAMETERS

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

  • IAM:PairingLocalInitial

No special attributes are provided.