Get-XenAuthProperty

Last published : Nov 12, 2026
Gets a property of an Auth object.
Related information
Auth cmdlets

Syntax

Get-XenAuthProperty [-Auth] <Auth>
    -XenProperty {SubjectIdentifier | SubjectInformationFromIdentifier | GroupMembership}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenAuthProperty [-Ref] <XenRef[Auth]>
    -XenProperty {SubjectIdentifier | SubjectInformationFromIdentifier | GroupMembership}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]

Description

Gets a specified property of an Auth object. Use the -XenProperty parameter to select which property to retrieve.
SubjectIdentifier: This call queries the external directory service to obtain the subject\_identifier as a string from the human-readable subject\_name.
SubjectInformationFromIdentifier: This call queries the external directory service to obtain the user information (for example, username, organization etc.) from the specified subject\_identifier.
GroupMembership: This call queries the external directory service to obtain the transitively-closed set of groups that the subject\_identifier is a member of.

Parameters

-Auth

The Auth object to operate on.
Attribute Value
Type Auth
Required True
Position 0
Accepts pipeline input True (ByValue)

-BestEffort

If set, the cmdlet continues processing further objects instead of throwing a terminating error when an operation fails for one object.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False

-Ref

The Auth object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[Auth]
Required True
Position 0
Accepts pipeline input True (ByPropertyName)
Aliases opaque_ref

-SessionOpaqueRef

The session object on which to run the cmdlet. This overrides the default session and lets you target a specific open XenServer connection.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-SubjectIdentifier

A string containing the subject\_identifier, unique in the external directory service. Accepted when -XenProperty is SubjectInformationFromIdentifier, GroupMembership.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-SubjectName

The human-readable subject\_name, such as a username or a groupname. Accepted when -XenProperty is SubjectIdentifier.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-XenProperty

Selects which property to use.
Attribute Value
Type XenAuthProperty
Required True
Position Named
Accepts pipeline input False
Accepted values SubjectIdentifier, SubjectInformationFromIdentifier, GroupMembership

Inputs

  • Auth
  • XenRef[Auth]

Outputs

  • System.Object

Examples

Example 1: Get the SubjectIdentifier property

PS> Get-XenAuthProperty -XenProperty SubjectIdentifier -Ref OpaqueRef:f433bf7b-2b0c-5f53-7018-7d195addb3ca
Gets the SubjectIdentifier property of an Auth.

Example 2: Get the SubjectInformationFromIdentifier property

PS> Get-XenAuthProperty -XenProperty SubjectInformationFromIdentifier -Ref OpaqueRef:f433bf7b-2b0c-5f53-7018-7d195addb3ca
Gets the SubjectInformationFromIdentifier property of an Auth.

Example 3: Get the GroupMembership property

PS> Get-XenAuthProperty -XenProperty GroupMembership -Ref OpaqueRef:f433bf7b-2b0c-5f53-7018-7d195addb3ca
Gets the GroupMembership property of an Auth.
  • Auth cmdlets
  • Class: Auth
  • Using the XenServer PowerShell module