Documentation

IamUtil.PairPasswordInviteAsync()

DESCRIPTION

Perform Password Invite pairing , authenticating with the specified username and password.

In the Password invite pairing mode a user is required in the system to be able to pair: An existing user (or the system autonomously) creates a username and password that is somehow passed to the new user (an invitation).

DECLARATION

System.Threading.Tasks.Task PairPasswordInviteAsync(Nabto.Edge.Client.IConnection, System.String, System.String)

PARAMETERS

  • connection: An established connection to the device this client should be paired with
  • username: Username for the invited user
  • password: Password for the invited user

ERRORS

  • T:Nabto.Edge.ClientIam.IamException: Thrown with Nabto.Edge.ClientIam.IamError if authentication failed using the specified username/password combination for the device.
  • T:Nabto.Edge.ClientIam.IamException: Thrown with Nabto.Edge.ClientIam.IamError if the device configuration does not support local open pairing (the IAM:PairingPasswordInvite action is not set for the Unpaired role or the device does not support the pairing mode at all).
  • T:Nabto.Edge.ClientIam.IamException: Thrown with Nabto.Edge.ClientIam.IamError if the pairing mode is configured on the device but is disabled at runtime.
  • T:Nabto.Edge.ClientIam.IamException: Thrown with Nabto.Edge.ClientIam.IamError if the client has attempted to authenticate too many times with a wrong password (try again after 10 seconds).
  • T:Nabto.Edge.ClientIam.IamException: Thrown with Nabto.Edge.ClientIam.IamError if Nabto Edge IAM is not supported by the device.