Skip to main content

Unlock Account

POST 

/accounts/:id/unlock

This API submits a task to unlock an account and returns the task ID.
To use this endpoint to unlock an account that has the forceProvisioning option set to true, the idn:accounts-provisioning:manage scope is required. A token with ORG_ADMIN authority is required to call this API.

Request

Path Parameters

    id stringrequired

    The account ID.

    Example: ef38f94347e94562b5bb8424a56397d8

Body

required
    externalVerificationId string

    If set, an external process validates that the user wants to proceed with this request.

    unlockIDNAccount boolean

    If set, the IDN account is unlocked after the workflow completes.

    forceProvisioning boolean

    If set, provisioning updates the account attribute at the source. This option is used when the account is not synced to ensure the attribute is updated.

Responses

Async task details

Schema
    id stringrequired

    id of the task

Loading...