Kotlin: IamUtil.awaitPairPasswordInvite()

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).

This function is meant to be used in a Kotlin coroutine to suspend execution until the operation has completed.

Read more here: https://docs.nabto.com/developer/guides/iam/pairing.html#invite

DECLARATION

suspend fun IamUtil.awaitPairPasswordInvite(
    connection: Connection,
    username: String,
    password: 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

THROWS EXCEPTIONS

AUTHENTICATION_ERROR:

if authentication failed using the specified username/password combination for the device

BLOCKED_BY_DEVICE_CONFIGURATION:

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)

PAIRING_MODE_DISABLED:

if the pairing mode is configured on the device but is disabled at runtime

IAM_NOT_SUPPORTED:

if Nabto Edge IAM is not supported by the device