Set-VPASIdentityUserState


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

SET USER STATE IN IDENTITY


Description:

USE THIS FUNCTION TO SET USER STATE IN IDENTITY


Syntax:

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


Parameters:

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

Required: false
Position: 1
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: false
Position: 2
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: 3
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: 4
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)


Examples:

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

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


Outputs:

$true if successful

$false if failed