Files
developer.sailpoint.com/docs/connectivity/saas-connectivity/connector-commands/account-unlock.md
2024-07-01 12:56:17 -05:00

1.9 KiB

id, title, pagination_label, sidebar_label, keywords, description, slug, tags
id title pagination_label sidebar_label keywords description slug tags
account-unlock Account Unlock Account Unlock Account Unlock
connectivity
connectors
account unlock
Lock and unlock an account on the source. /connectivity/saas-connectivity/commands/account-unlock
Connectivity
Connector Command
Input/Output Data Type
Input StdAccountUnlockInput
Output StdAccountUnlockOutput

Example StdAccountUnlockInput

"identity": "john.doe",
"key": {
    "simple": {
        "id": "john.doe"
    }
}

Example StdAccountUnlockOutput

{
    "key": {
        "simple": {
            "id": "john.doe"
        }
    },
    "disabled": false,
    "locked": false,
    "attributes": {
        "id": "john.doe",
        "displayName": "John Doe",
        "email": "example@sailpoint.com",
        "entitlements": [
            "administrator",
            "sailpoint"
        ]
    }
}

Description

The account lock and account unlock commands provide ways to temporarily prevent access to an account. ISC only supports the unlock command, so accounts must be locked on the source level, but they can be unlocked through ISC, and ISC can store the account's status.

To use this command, you must specify this value in the commands array: std:account:unlock

Implementing account unlock is similar to the other commands that update attributes on an account. The following code unlocks an account:

.stdAccountUnlock(async (context: Context, input: StdAccountUnlockInput, res: Response<StdAccountUnlockOutput>) => {
    let account = await airtable.getAccount(input.key)
    const change: AttributeChange = {
        op: AttributeChangeOp.Set,
        attribute: 'locked',
        value: 'false'
    }
    account = await airtable.changeAccount(account, change)
    res.send(account.toStdAccountUnlockOutput())
})