Skip to main content

Get-VSTeamAccessControlList

SYNOPSIS​

Return a list of access control lists for the specified security namespace and token. All ACLs in the security namespace will be retrieved if no optional parameters are provided.

SYNTAX​

ByNamespace (Default)​

Get-VSTeamAccessControlList -SecurityNamespace <SecurityNamespace> [-Token <String>] [-Descriptors <String[]>]
 [-IncludeExtendedInfo] [-Recurse] [<CommonParameters>]

ByNamespaceId​

Get-VSTeamAccessControlList -SecurityNamespaceId <Guid> [-Token <String>] [-Descriptors <String[]>]
 [-IncludeExtendedInfo] [-Recurse] [<CommonParameters>]

DESCRIPTION​

Return a list of access control lists for the specified security namespace and token. All ACLs in the security namespace will be retrieved if no optional parameters are provided.

EXAMPLES​

Example 1​

Get-VSTeamSecurityNamespace | Select-Object -First 1 | Get-VSTeamAccessControlList

PARAMETERS​

-SecurityNamespace​

Security namespace object.

Type: SecurityNamespace
Parameter Sets: ByNamespace
Aliases:

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

-SecurityNamespaceId​

Security namespace identifier.

Type: Guid
Parameter Sets: ByNamespaceId
Aliases: ID

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

-Token​

Security token

Type: String
Parameter Sets: (All)
Aliases:

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

-Descriptors​

An optional filter string containing a list of identity descriptors whose ACEs should be retrieved. If this is not set entire ACLs will be returned.

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

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

-IncludeExtendedInfo​

If set, populate the extended information properties for the access control entries contained in the returned lists.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

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

-Recurse​

If true and this is a hierarchical namespace, return child ACLs of the specified token.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
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​

OUTPUTS​

vsteam_lib.AccessControlList​

NOTES​

Prerequisites:

Set the account and version that all calls will use with Set-VSTeamAccount. Default version sets to API version 3.0 (TFS2017) if not manually set.

tips:

  • check called version of the API with Get-VSTeamAPIVersion or Get-VSTeamInfo
  • use Set-VSTeamDefaultProject to set default project for every call
  • use Set-VSTeamDefaultAPITimeout to change the default timeout of 60 seconds for all calls.
  • use Profiles to load an account and the correct version