public/Set-VPASIdentityUserState.ps1
|
<#
.Synopsis SET USER STATE IN IDENTITY CREATED BY: Vadim Melamed, EMAIL: vmelamed5@gmail.com .DESCRIPTION USE THIS FUNCTION TO SET USER STATE IN IDENTITY .PARAMETER NoSSL If the environment is not set up for SSL, API calls will be made via HTTP not HTTPS (Not Recommended!) .PARAMETER token 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 .PARAMETER Username Username that will be used to query for the target user in Identity if no UserID is passed .PARAMETER UserID Unique UserID that maps to the target User in Identity Supply the UserID to skip any querying for the target User .PARAMETER State Specify the state status of the target user in Identity Possible values: None, Locked, Disabled, Expired .EXAMPLE $SetUserState = Set-VPASIdentityUserState -Username {USERNAME VALUE} -State {STATE VALUE} .EXAMPLE $SetUserState = Set-VPASIdentityUserState -UserID {USERID VALUE} -State {STATE VALUE} .OUTPUTS $true if successful $false if failed #> function Set-VPASIdentityUserState{ [OutputType([bool])] [CmdletBinding()] Param( [Parameter(Mandatory=$false,ValueFromPipelineByPropertyName=$true,Position=0)] [String]$Username, [Parameter(Mandatory=$false,ValueFromPipelineByPropertyName=$true,Position=1)] [String]$UserID, [Parameter(Mandatory=$true,ValueFromPipelineByPropertyName=$true,HelpMessage="Enter state status of target user (None, Locked, Disabled, Expired)",Position=2)] [ValidateSet('None','Locked','Disabled','Expired')] [String]$State, [Parameter(Mandatory=$false,ValueFromPipelineByPropertyName=$true,Position=3)] [hashtable]$token, [Parameter(Mandatory=$false,ValueFromPipelineByPropertyName=$true,Position=4)] [Switch]$NoSSL ) Begin{ $tokenval,$sessionval,$PVWA,$Header,$ISPSS,$IdentityURL = Get-VPASSession -token $token } Process{ Write-Verbose "SUCCESSFULLY PARSED PVWA VALUE" Write-Verbose "SUCCESSFULLY PARSED TOKEN VALUE" try{ if(!$IdentityURL){ Write-VPASOutput -str "LOGIN TOKEN WAS NOT GENERATED THROUGH IDENTITY, TERMINATING API CALL" -type E return $false } if([String]::IsNullOrEmpty($UserID)){ Write-Verbose "NO USER ID PASSED" Write-Verbose "INVOKING HELPER FUNCTION TO RETRIEVE USER ID" if($NoSSL){ $UserID = Get-VPASUserIDIdentityHelper -token $token -User $Username -NoSSL } else{ $UserID = Get-VPASUserIDIdentityHelper -token $token -User $Username } if($UserID -eq -1){ Write-VPASOutput -str "MULTIPLE USER ENTRIES WERE RETURNED, ADD MORE TO NAME TO NARROW RESULTS" -type E Write-VPASOutput -str "RETURNING FALSE" -type E return $false } elseif($UserID -eq -2){ Write-VPASOutput -str "NO USER ENTRIES WERE RETURNED" -type E Write-VPASOutput -str "RETURNING FALSE" -type E return $false } else{ Write-Verbose "FOUND UNIQUE USER ID" } } else{ Write-Verbose "USER ID PASSED, SKIPPING HELPER FUNCTION" } Write-Verbose "CONSTRUCTING PARAMS" $params = @{ ID = $UserID state = $State } | ConvertTo-Json Write-Verbose "ADDING USER ID: $UserID TO PARAMS" Write-Verbose "ADDING STATE: $State TO PARAMS" if($NoSSL){ Write-Verbose "NO SSL ENABLED, USING HTTP INSTEAD OF HTTPS" $uri = "http://$IdentityURL/CDirectoryService/SetUserState" } else{ Write-Verbose "SSL ENABLED BY DEFAULT, USING HTTPS" $uri = "https://$IdentityURL/CDirectoryService/SetUserState" } if($sessionval){ $response = Invoke-RestMethod -Headers @{"Authorization"=$Header} -Uri $uri -Method POST -Body $params -ContentType "application/json" -WebSession $sessionval } else{ $response = Invoke-RestMethod -Headers @{"Authorization"=$Header} -Uri $uri -Method POST -Body $params -ContentType "application/json" } if($response.success){ return $true } else{ $err = $response.Message Write-VPASOutput -str $err -type E return $false } }catch{ Write-Verbose "FAILED TO RETRIEVE USERS FROM IDENTITY" Write-VPASOutput -str $_ -type E return $false } } End{ } } |