Get-TfsIdentity
Gets one or more identities that represents either users or groups in Azure DevOps. This cmdlets resolves legacy identity information for use with older APIs such as the Security APIs
Table of Contents
Syntax
Get Identity
Get-TfsIdentity
[-Identity] <object>
[-Collection <object>]
[-QueryMembership <QueryMembership>]
[-Server <object>]
Get current user
Get-TfsIdentity
-Current
[-Collection <object>]
[-Server <object>]
Parameters
-Collection (Aliases: Organization)
Specifies the URL to the Team Project Collection or Azure DevOps Organization to connect to, a TfsTeamProjectCollection object (Windows PowerShell only), or a VssConnection object. You can also connect to an Azure DevOps Services organizations by simply providing its name instead of the full URL. For more details, see the Get-TfsTeamProjectCollection cmdlet. When omitted, it defaults to the connection set by Connect-TfsTeamProjectCollection (if any).
Type | object |
Position | (Named) |
Default Value | (N/A) |
Accept pipeline input | False |
Accept wildcard characters | False |
Returns an identity representing the user currently logged in to the Azure DevOps / TFS instance
Type | SwitchParameter |
Position | (Named) |
Default Value | (N/A) |
Accept pipeline input | False |
Accept wildcard characters | False |
-Identity (Aliases: User, Id, Group)
Specifies the user or group to be retrieved. Supported values are: User/group name, email, or ID
Type | object |
Position | 0 |
Default Value | (N/A) |
Accept pipeline input | True (bypropertyname) |
Accept wildcard characters | False |
Specifies how group membership information should be processed when the returned identity is a group. “Direct” fetches direct members (both users and groups) of the group. “Expanded” expands contained groups recursively and returns their contained users. “None” is the fastest option as it fetches no membership information. When omitted, defaults to Direct. Possible values: None, Direct, Expanded, ExpandedUp, ExpandedDown
Type | QueryMembership |
Position | (Named) |
Default Value | Direct |
Accept pipeline input | False |
Accept wildcard characters | False |
Specifies the URL to the Team Foundation Server to connect to, a TfsConfigurationServer object (Windows PowerShell only), or a VssConnection object. When omitted, it defaults to the connection set by Connect-TfsConfiguration (if any). For more details, see the Get-TfsConfigurationServer cmdlet.
Type | object |
Position | (Named) |
Default Value | (N/A) |
Accept pipeline input | False |
Accept wildcard characters | False |
Inputs
System.Object
Specifies the user or group to be retrieved. Supported values are: User/group name, email, or ID