Skip to main content

HelloID

Account scripts (PowerShell target systems)

Executed during the Grant step of Enforcement, when an Account entitlement is granted to a person.

In the Account Create script, you build $account from fields in $person.

In the if block, use $account to make the necessary API calls to create a target account for the current person.

In subsequent account lifecycle scripts, HelloID passes the AccountReference property of $result back to you as $accountReference.

Executed during the Grant stage of Enforcement, when an Account Access entitlement is granted to a person.

In the Account Enable script, HelloID passes you $accountReference.

In the if block, use $accountReference to make the necessary API calls to enable the target account.

Executed during the Update step of Enforcement, as well as during Force update accounts.

In the Account Update script, you get an opportunity to build a new $account object using $personDifferences and related variables.

In the if block, use the new $account object to make the necessary API calls to update the corresponding fields.

Executed during the Revoke stage of Enforcement, when an Account Access entitlement is revoked from a person.

In the Account Disable script, HelloID passes you $accountReference.

In the if block, use $accountReference to make the necessary API calls to disable the target account.

Executed during the Revoke stage of Enforcement, when an Account entitlement is revoked from a person.

In the Account Delete script, HelloID passes you $accountReference.

In the if block, use $accountReference to make the necessary API calls to delete the target account.