Get-VPASIdentityUserSecurityQuestions


Supported Environments:
SelfHosted
SharedServices
PCloudStandard


Synopsis:

RETRIEVE USER SECURITY QUESTIONS IN IDENTITY


Description:

USE THIS FUNCTION TO RETRIEVE A USERS SECURITY QUESTIONS IN IDENTITY


Syntax:

Get-VPASIdentityUserSecurityQuestions -Username <String> [-IncludeAdminQuestions] [-token <Hashtable>] [<CommonParameters>]

Get-VPASIdentityUserSecurityQuestions -UserID <String> [-IncludeAdminQuestions] [-token <Hashtable>] [<CommonParameters>]

Get-VPASIdentityUserSecurityQuestions -InputParameters <Hashtable> [-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: 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

-IncludeAdminQuestions [<SwitchParameter>]
Include admin set security questions in the results

Required: false
Position: named
Default value: False
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)


Examples:

$GetUserSecurityQuestions = Get-VPASIdentityUserSecurityQuestions -Username {USERNAME VALUE}

$GetUserSecurityQuestions = Get-VPASIdentityUserSecurityQuestions -UserID {USERID VALUE} -IncludeAdminQuestions

$InputParameters = @{
        Username = "vadim.melamed@vman.com"
         IncludeAdminQuestions = $true|$false
}
$GetUserSecurityQuestions = Get-VPASIdentityUserSecurityQuestions -InputParameters $InputParameters

$InputParameters = @{
        UserID = "jkadhfkj84793-1234-abcd-9bc1-skldjfkls8974983"
         IncludeAdminQuestions = $true|$false
}
$GetUserSecurityQuestions = Get-VPASIdentityUserSecurityQuestions -InputParameters $InputParameters


Outputs:

If successful:
{
         "AnswerMinLength": 3,
         "MaxQuestions": 20,
         "MinAdminQuestions": 0,
         "MinUserQuestions": 1,
         "Questions": [
                 {
                         "Uuid": "u_adhaskj23498-abcd-9876-1234-asdkjh394857",
                         "QuestionText": "What is my favorite color?"
                 },
                 {
                         "Uuid": "u_asjkdhak24789-abcd-9876-1234-78943ksjhfd",
                         "QuestionText": "What is my favorite color"
                 }
         ]
}

$false if failed