UserPrincipal.GetAuthorizationGroups Method

Definition

Namespace:

System.DirectoryServices.AccountManagement

Assembly:

System.DirectoryServices.AccountManagement.dll

Package:

System.DirectoryServices.AccountManagement v8.0.0

Source:

User.cs

Returns a collection of principal objects that contains all the authorization groups of which this user is a member. This function only returns groups that are security groups; distribution groups are not returned.

public:
 System::DirectoryServices::AccountManagement::PrincipalSearchResult<System::DirectoryServices::AccountManagement::Principal ^> ^ GetAuthorizationGroups();

public System.DirectoryServices.AccountManagement.PrincipalSearchResult<System.DirectoryServices.AccountManagement.Principal> GetAuthorizationGroups ();

member this.GetAuthorizationGroups : unit -> System.DirectoryServices.AccountManagement.PrincipalSearchResult<System.DirectoryServices.AccountManagement.Principal>

Public Function GetAuthorizationGroups () As PrincipalSearchResult(Of Principal)

Returns

PrincipalSearchResult<Principal>

A collection of Principal objects that contain the groups of which the user is a member, or null if the user does not belong to any security groups.

Exceptions

PrincipalOperationException

The attempt to retrieve authorization groups failed.

NotSupportedException

The retrieval of authorization groups is not supported by this operating system.

Remarks

This method searches all groups recursively and returns the groups in which the user is a member. The returned set may also include additional groups that system would consider the user a member of for authorization purposes.

The groups that are returned by this method may include groups from a different scope and store than the principal. For example, if the principal is an AD DS object that has a DN of "CN=SpecialGroups,DC=Fabrikam,DC=com, the returned set can contain groups that belong to the "CN=NormalGroups,DC=Fabrikam,DC=com.