Arcane.users.activate()

This focused page is derived from the mechanically checked full member inventory.

Syntax

Arcane.users.activate(username)

Parameters

Username

Return value

Promise<{user, operation, credentials}>

Description

Activates a staged configured user.

Overview

Arcane.users.activate(username) enables only a newly created, disabled Arcane account whose durable staged identity is in activation-pending. It requires users.manage, the Provisioner type, elevation, and the exclusive Core mutation boundary. Call it only after the operator has safely received the temporary credential returned by users.add().

Activation re-verifies the exact SID or uid and Arcane shell assignment before enabling the account. It does not activate an existing account or a name-only match. The account must change its temporary password at next sign-in.

Result, side effects, and events

The exact result is {user, operation, credentials}; credentials is empty. user contains the native username, stable sid or uid, enabled: true, activated: true, activationRequired: false, and passwordStatus: "temporary-issued", with host-specific profile/shell or reconciliation fields where applicable. Standard operation events are emitted.

Errors and recovery

STAGED_ACCOUNT_NOT_FOUND means no exact disabled staged identity is eligible. SHELL_CHANGED_EXTERNALLY, INVALID_STAGED_ACCOUNT, or a changed SID/uid blocks activation. Platform failures leave or restore the account disabled where possible. Refresh the user inventory and follow the protected recovery record; never enable a same-named account manually based only on its name.

Example

async function activateStagedUserAfterCredentialDelivery(
    username,
    confirmCredentialDelivered
) {
    if (!confirmCredentialDelivered(username)) {
        return null;
    }
    return Arcane.users.activate(username);
}

Reference group

Platform, installation, users, and system