IamUtil.renameUserAsync() Overload 1

DESCRIPTION

Asynchronously update an IAM user’s username on device.

The specified AsyncIamResultReceiver closure is invoked with IamError.OK upon successful completion or with an error if an error occurs. See the renameUser() function for details about possible error codes and known issues.

DECLARATION

static public func renameUserAsync(connection: Connection,
                                       username: String,
                                       newUsername: String,
                                       closure: @escaping AsyncIamResultReceiver)

PARAMETERS

connection:
An established connection to the device
username:
Username for the user that should have username updated
newUsername:
New username for the user
closure:
Invoked when the user is deleted or an error occurs

Overload 2

DESCRIPTION

Asynchronously an IAM user’s username on device.

Uses Swift concurrency and is therefore only available on iOS 13 and above.

DECLARATION

static public func renameUserAsync(connection: Connection,
                                       username: String,
                                       newUsername: String) async throws

PARAMETERS

connection:
An established connection to the device
username:
Username for the user that should have username updated
newUsername:
New username for the user

THROWS ERRORS

USER_DOES_NOT_EXIST:
if the specified user does not exist on the device.
BLOCKED_BY_DEVICE_CONFIGURATION:
if the device configuration does not allow the current user to update the specified user's display name (the IAM:SetUserUsername action is not allowed for the requesting role for the IAM:Username user)
IAM_NOT_SUPPORTED:
if Nabto Edge IAM is not supported by the device