Get-TppIdentity

SYNOPSIS

Get identity details

SYNTAX

Id (Default)

Get-TppIdentity -ID <String[]> [-TppSession <TppSession>] [<CommonParameters>]

Me

Get-TppIdentity [-Me] [-TppSession <TppSession>] [<CommonParameters>]

DESCRIPTION

Returns information about individual identity, group identity, or distribution groups from a local or non-local provider such as Active Directory.

EXAMPLES

EXAMPLE 1

Get-TppIdentity -ID 'AD+myprov:asdfgadsf9g87df98g7d9f8g7'

Get identity details from an id

EXAMPLE 2

Get-TppIdentity -Me

Get identity details for user in the current session

PARAMETERS

-ID

The individual identity, group identity, or distribution group prefixed universal id

Type: String[]
Parameter Sets: Id
Aliases:

Required: True
Position: Named
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-Me

Returns the identity of the authenticated user

Type: SwitchParameter
Parameter Sets: Me
Aliases:

Required: True
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-TppSession

Session object created from New-TppSession method. The value defaults to the script session object $TppSession.

Type: TppSession
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: $Script:TppSession
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

ID

OUTPUTS

PSCustomObject with the following properties:

Name

ID

Path

NOTES

http://venafitppps.readthedocs.io/en/latest/functions/Get-TppIdentity/

https://github.com/gdbarron/VenafiTppPS/blob/main/VenafiTppPS/Code/Public/Get-TppIdentity.ps1

https://docs.venafi.com/Docs/20.4SDK/TopNav/Content/SDK/WebSDK/r-SDK-POST-Identity-Validate.php?tocpath=Web%20SDK%7CIdentity%20programming%20interface%7C_____15

https://docs.venafi.com/Docs/20.4SDK/TopNav/Content/SDK/WebSDK/r-SDK-GET-Identity-Self.php?tocpath=Web%20SDK%7CIdentity%20programming%20interface%7C_____13