SecurityWebService.QueryPermissions Method

In all cases: this method will query the permissions for the token specified (and those underneath it if recursion is specified and this is a hierarchical namespace). It will return permission information about the identities that are supplied or all identities if null is supplied for the identities parameter. IAccessControlLists objects will be returned only for tokens that we have information about. Note that the order the access control entries are returned in, in an access control list, is non-deterministic.

If includeExtendedInfo is false: All of the ExtendedInfo properties for the returned AccessControlEntry objects will be null.

If includeExtendedInfo is true: All of the ExtendedInfo properties for the returned AccessControlEntry objects will contain references to valid ExtendedPermissionInformation objects. If the identities parameter is null, this function will return permission information for all identities that have explicit OR INHERITED permissions on them.

Namespace:  Microsoft.TeamFoundation.Framework.Server.WebServices
Assembly:  Microsoft.TeamFoundation.Framework.Server (in Microsoft.TeamFoundation.Framework.Server.dll)

Syntax

'Declaration
<WebMethodAttribute> _
Public Function QueryPermissions ( _
    namespaceId As Guid, _
    token As String, _
    identities As List(Of IdentityDescriptor), _
    includeExtendedInfo As Boolean, _
    recurse As Boolean _
) As List(Of AccessControlListDetails)

[WebMethodAttribute]
public List<AccessControlListDetails> QueryPermissions(
    Guid namespaceId,
    string token,
    List<IdentityDescriptor> identities,
    bool includeExtendedInfo,
    bool recurse
)

[WebMethodAttribute]
public:
List<AccessControlListDetails^>^ QueryPermissions(
    Guid namespaceId, 
    String^ token, 
    List<IdentityDescriptor^>^ identities, 
    bool includeExtendedInfo, 
    bool recurse
)

[<WebMethodAttribute>]
member QueryPermissions : 
        namespaceId:Guid * 
        token:string * 
        identities:List<IdentityDescriptor> * 
        includeExtendedInfo:bool * 
        recurse:bool -> List<AccessControlListDetails> 

public function QueryPermissions(
    namespaceId : Guid, 
    token : String, 
    identities : List<IdentityDescriptor>, 
    includeExtendedInfo : boolean, 
    recurse : boolean
) : List<AccessControlListDetails>

Parameters

• namespaceId
  Type: System.Guid

  The namespace to make these changes in.

• token
  Type: System.String

  The token to query permissions for. If this value is null, permissions for all tokens will be returned.

• identities
  Type: System.Collections.Generic.List<IdentityDescriptor>

• includeExtendedInfo
  Type: System.Boolean

  Includes inherited and effective permission information by attaching ExtendedPermissionInformation objects to all of the IPermission objects if true. If this is false, all of the ExtendedInfo properties on the AccessControlEntry objects will be null.

• recurse
  Type: System.Boolean

  If true and this function is being performed on a hierarchical namespace, it will return all ACLs for this resource and the ones underneath it.

Return Value

Type: System.Collections.Generic.List<AccessControlListDetails>
Detail for all of the permissions for all of the relevant identities that can be applied to this token.

.NET Framework Security

• Full trust for the immediate caller. This member cannot be used by partially trusted code. For more information, see Using Libraries from Partially Trusted Code.

See Also

Reference

SecurityWebService Class

Microsoft.TeamFoundation.Framework.Server.WebServices Namespace