SET USER STATE IN IDENTITY

USE THIS FUNCTION TO SET USER STATE IN IDENTITY

Set-VPASIdentityUserState -Username <String> -State <String> [-token <Hashtable>] [<CommonParameters>]

Set-VPASIdentityUserState -UserID <String> -State <String> [-token <Hashtable>] [<CommonParameters>]

Set-VPASIdentityUserState -InputParameters <Hashtable> [-token <Hashtable>] [<CommonParameters>]

-Username <String>
Username that will be used to query for the target user in Identity if no UserID is passed

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-UserID <String>
Unique UserID that maps to the target User in Identity
Supply the UserID to skip any querying for the target User

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-State <String>
Specify the state status of the target user in Identity
Possible values: None, Locked, Disabled, Expired

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-InputParameters <Hashtable>
HashTable of values containing the parameters required to make the API call

Required: true
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

-token <Hashtable>
HashTable of data containing various pieces of login information (PVWA, LoginToken, HeaderType, etc).
If -token is not passed, function will use last known hashtable generated by New-VPASToken

Required: false
Position: named
Default value:
Accept pipeline input: true (ByPropertyName)
Accept wildcard characters: false

<CommonParameters>
This cmdlet supports the common parameters: Verbose, Debug
ErrorAction, ErrorVariable, WarningAction, WarningVariable
OutBuffer, PipelineVariable, and OutVariable. For more information, see
about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216)

$SetUserState = Set-VPASIdentityUserState -Username {USERNAME VALUE} -State {STATE VALUE}

$SetUserState = Set-VPASIdentityUserState -UserID {USERID VALUE} -State {STATE VALUE}

$InputParameters = @{
        Username = "vman@cyberark.cloud.1234"
        State = "None"|"Locked"|"Disabled"|"Expired"
}
$SetUserState = Set-VPASIdentityUserState -InputParameters $InputParameters

$InputParameters = @{
        UserID = "12345_abcdefg_67890_hijklmn"
        State = "None"|"Locked"|"Disabled"|"Expired"
}
$SetUserState = Set-VPASIdentityUserState -InputParameters $InputParameters

$true if successful

$false if failed