public/Add-VPASIdentityUserSecurityQuestions.ps1
|
<#
.Synopsis ADD USER SECURITY QUESTIONS IN IDENTITY CREATED BY: Vadim Melamed, EMAIL: vpasmodule@gmail.com .DESCRIPTION USE THIS FUNCTION TO ADD A USERS SECURITY QUESTIONS IN IDENTITY .LINK https://vpasmodule.com/commands/Add-VPASIdentityUserSecurityQuestions .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 QuestionText Security question that will be added to the users profile .PARAMETER AnswerText Security question answer that will be added to the users profile .PARAMETER InputParameters HashTable of values containing the parameters required to make the API call .EXAMPLE $AddUserSecurityQuestions = Add-VPASIdentityUserSecurityQuestions -Username {USERNAME VALUE} -QuestionText {SECURITY QUESTION VALUE} -AnswerText {SECURITY QUESTION ANSWER VALUE} .EXAMPLE $AddUserSecurityQuestions = Add-VPASIdentityUserSecurityQuestions -UserID {USERID VALUE} -QuestionText {SECURITY QUESTION VALUE} -AnswerText {SECURITY QUESTION ANSWER VALUE} .EXAMPLE $InputParameters = @{ Username = "TargetUser@vman.com" QuestionText = "What kind of question should I put here" AnswerText = "A good question" } $AddUserSecurityQuestions = Add-VPASIdentityUserSecurityQuestions -InputParameters $InputParameters .EXAMPLE $InputParameters = @{ UserID = "ghUYRTfghj567HG5465754123" QuestionText = "What kind of question should I put here" AnswerText = "A good question" } $AddUserSecurityQuestions = Add-VPASIdentityUserSecurityQuestions -InputParameters $InputParameters .OUTPUTS $true if successful --- $false if failed #> function Add-VPASIdentityUserSecurityQuestions{ [OutputType('System.Object',[bool])] [CmdletBinding(DefaultParameterSetName='Set1')] Param( [Parameter(Mandatory=$true,ParameterSetName='Set1',ValueFromPipelineByPropertyName=$true,HelpMessage="Enter username for the target identity (for example: vman@cyberark.cloud.1234)")] [String]$Username, [Parameter(Mandatory=$true,ParameterSetName='Set2',ValueFromPipelineByPropertyName=$true,HelpMessage="Enter unique ID for the target identity (for example: ghUYRTfghj567HG5465754123)")] [String]$UserID, [Parameter(Mandatory=$true,ParameterSetName='Set1',ValueFromPipelineByPropertyName=$true,HelpMessage="Enter security question (for example: What is my favorite color?)")] [Parameter(Mandatory=$true,ParameterSetName='Set2',ValueFromPipelineByPropertyName=$true,HelpMessage="Enter security question (for example: What is my favorite color?)")] [String]$QuestionText, [Parameter(Mandatory=$true,ParameterSetName='Set1',ValueFromPipelineByPropertyName=$true,HelpMessage="Enter security question answer (for example: My favorite color is Blue!)")] [Parameter(Mandatory=$true,ParameterSetName='Set2',ValueFromPipelineByPropertyName=$true,HelpMessage="Enter security question answer (for example: My favorite color is Blue!)")] [String]$AnswerText, [Parameter(Mandatory=$true,ParameterSetName='InputParameters',ValueFromPipelineByPropertyName=$true,HelpMessage="Hashtable of parameters required to make API call, refer to get-help -examples for valid inputs")] [hashtable]$InputParameters, [Parameter(Mandatory=$false,ValueFromPipelineByPropertyName=$true)] [hashtable]$token ) Begin{ $tokenval,$sessionval,$PVWA,$Header,$ISPSS,$IdentityURL,$EnableTextRecorder,$AuditTimeStamp,$NoSSL,$VaultVersion,$HideWarnings,$AuthenticatedAs,$SubDomain,$EnableTroubleshooting = Get-VPASSession -token $token $CommandName = $MyInvocation.MyCommand.Name $log = Write-VPASTextRecorder -inputval $CommandName -token $token -LogType COMMAND } Process{ try{ if($PSCmdlet.ParameterSetName -eq "InputParameters"){ $KeyHash = @{ set1 = @{ AcceptableKeys = @("Username","QuestionText","AnswerText") MandatoryKeys = @("Username","QuestionText","AnswerText") } set2 = @{ AcceptableKeys = @("UserID","QuestionText","AnswerText") MandatoryKeys = @("UserID","QuestionText","AnswerText") } } $CheckSet = Test-VPASHashtableKeysHelper -InputHash $InputParameters -KeyHash $KeyHash if(!$CheckSet){ $log = Write-VPASTextRecorder -inputval "FAILED TO FIND TARGET PARAMETER SET" -token $token -LogType MISC Write-Verbose "FAILED TO FIND TARGET PARAMETER SET" Write-VPASOutput -str "FAILED TO FIND TARGET PARAMETER SET...VIEW EXAMPLES BELOW:" -type E $examples = Write-VPASExampleHelper -CommandName $CommandName return $false } else{ foreach($key in $InputParameters.Keys){ Set-Variable -Name $key -Value $InputParameters.$key } } } }catch{ $log = Write-VPASTextRecorder -inputval $_ -token $token -LogType ERROR $log = Write-VPASTextRecorder -inputval "REST API COMMAND RETURNED: FALSE" -token $token -LogType MISC Write-Verbose "FAILED TO CREATE SECURITY QUESTION IN IDENTITY" Write-VPASOutput -str $_ -type E return $false } try{ if(!$IdentityURL){ Write-VPASOutput -str "LOGIN TOKEN WAS NOT GENERATED THROUGH IDENTITY, TERMINATING API CALL" -type E $log = Write-VPASTextRecorder -inputval "LOGIN TOKEN WAS NOT GENERATED THROUGH IDENTITY, TERMINATING API CALL" -token $token -LogType MISC $log = Write-VPASTextRecorder -inputval "REST API COMMAND RETURNED: FALSE" -token $token -LogType MISC return $false } if([String]::IsNullOrEmpty($UserID)){ Write-Verbose "NO USER ID PASSED" Write-Verbose "INVOKING HELPER FUNCTION TO RETRIEVE USER ID" $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 $log = Write-VPASTextRecorder -inputval "REST API COMMAND RETURNED: FALSE" -token $token -LogType MISC return $false } elseif($UserID -eq -2){ Write-VPASOutput -str "NO USER ENTRIES WERE RETURNED" -type E Write-VPASOutput -str "RETURNING FALSE" -type E $log = Write-VPASTextRecorder -inputval "REST API COMMAND RETURNED: FALSE" -token $token -LogType MISC return $false } else{ Write-Verbose "FOUND UNIQUE USER ID" } } else{ Write-Verbose "USER ID PASSED, SKIPPING HELPER FUNCTION" } Write-Verbose "CONSTRUCTING PARAMS" [psobject]$questionparam = @{ QuestionText = $QuestionText Answer = $AnswerText Type = "User" } $params = @{ ID = $UserID Replace = $false Added = @( $questionparam ) } $log = Write-VPASTextRecorder -inputval $params -token $token -LogType PARAMS $params = $params | ConvertTo-Json Write-Verbose "ADDING USER ID: $UserID TO PARAMS" Write-Verbose "ADDING QUESTION TEXT: $QuestionText TO PARAMS" Write-Verbose "ADDING ANSWER TEXT: $AnswerText TO PARAMS" if($NoSSL){ Write-Verbose "NO SSL ENABLED, USING HTTP INSTEAD OF HTTPS" $uri = "http://$IdentityURL/UserMgmt/UpdateSecurityQuestions" } else{ Write-Verbose "SSL ENABLED BY DEFAULT, USING HTTPS" $uri = "https://$IdentityURL/UserMgmt/UpdateSecurityQuestions" } $log = Write-VPASTextRecorder -inputval $uri -token $token -LogType URI $log = Write-VPASTextRecorder -inputval "POST" -token $token -LogType METHOD 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){ $log = Write-VPASTextRecorder -inputval "REST API COMMAND RETURNED: TRUE" -token $token -LogType MISC return $true } else{ $err = $response.Message Write-VPASOutput -str $err -type E $log = Write-VPASTextRecorder -inputval $err -token $token -LogType ERROR $log = Write-VPASTextRecorder -inputval "REST API COMMAND RETURNED: FALSE" -token $token -LogType MISC return $false } }catch{ $log = Write-VPASTextRecorder -inputval $_ -token $token -LogType ERROR $log = Write-VPASTextRecorder -inputval "REST API COMMAND RETURNED: FALSE" -token $token -LogType MISC Write-Verbose "FAILED TO RETRIEVE USERS FROM IDENTITY" Write-VPASOutput -str $_ -type E return $false } } End{ $log = Write-VPASTextRecorder -inputval $CommandName -token $token -LogType DIVIDER } } |