Get-TppIdentityAttribute¶

SYNOPSIS¶

Get attribute values for TPP identity objects

SYNTAX¶

Get-TppIdentityAttribute [-ID] <String[]> [[-Attribute] <String[]>] [[-VenafiSession] <PSObject>]
 [<CommonParameters>]

DESCRIPTION¶

Get attribute values for TPP identity objects.

EXAMPLES¶

EXAMPLE 1¶

Get-TppIdentityAttribute -IdentityId 'AD+blah:{1234567890olikujyhtgrfedwsqa}'

Get basic attributes

EXAMPLE 2¶

Get-TppIdentityAttribute -IdentityId 'AD+blah:{1234567890olikujyhtgrfedwsqa}' -Attribute 'Surname'

Get specific attribute for user

PARAMETERS¶

-ID¶

The id that represents the user or group. Use Find-TppIdentity to get the id.

Type: String[]
Parameter Sets: (All)
Aliases: PrefixedUniversalId, Contact, IdentityId

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

-Attribute¶

Retrieve identity attribute values for the users and groups. Common user attributes include Group Membership, Name, Internet Email Address, Given Name, and Surname.

Type: String[]
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
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 TPP token or VaaS key can also provided. If providing a TPP token, an environment variable named TPP_SERVER must also be set.

Type: PSObject
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: $script:VenafiSession
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.