Test-VdcIdentity¶
SYNOPSIS¶
Test if an identity exists
SYNTAX¶
Test-VdcIdentity [-ID] <String[]> [-ExistOnly] [[-VenafiSession] <PSObject>]
[-ProgressAction <ActionPreference>] [<CommonParameters>]
DESCRIPTION¶
Provided with a prefixed universal id, find out if an identity exists.
EXAMPLES¶
EXAMPLE 1¶
Test multiple identities
EXAMPLE 2¶
Retrieve existence for only one identity, returns boolean
PARAMETERS¶
-ID¶
{{ Fill ID Description }}
Type: String[]
Parameter Sets: (All)
Aliases: PrefixedUniversal, Contact, IdentityId, FullName
Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False
-ExistOnly¶
Only return boolean instead of ID and Exists list. Helpful when validating just 1 identity.
Type: SwitchParameter
Parameter Sets: (All)
Aliases:
Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False
-VenafiSession¶
Authentication for the function. The value defaults to the script session object $VenafiSession created by New-VenafiSession. A TLSPDC token can also be provided. If providing a TLSPDC token, an environment variable named VDC_SERVER must also be set.
Type: PSObject
Parameter Sets: (All)
Aliases:
Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
-ProgressAction¶
{{ Fill ProgressAction Description }}
Type: ActionPreference
Parameter Sets: (All)
Aliases: proga
Required: False
Position: Named
Default value: None
Accept pipeline input: False
Accept wildcard characters: False
CommonParameters¶
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
INPUTS¶
Identity¶
OUTPUTS¶
PSCustomObject will be returned with properties 'ID', a System.String, and 'Exists', a System.Boolean.¶
NOTES¶
RELATED LINKS¶
http://VenafiPS.readthedocs.io/en/latest/functions/Test-VdcIdentity/
https://github.com/Venafi/VenafiPS/blob/main/VenafiPS/Public/Test-VdcIdentity.ps1
https://docs.venafi.com/Docs/current/TopNav/Content/SDK/WebSDK/r-SDK-POST-Identity-Validate.php