This documentation is archived and is not being maintained.

People.ResolvePrincipals Method

Windows SharePoint Services 3
Resolves an e-mail address or other form of user identification (ID) into a PrincipalInfo object.

Web Service: PeopleWeb Reference: http://<Site>/_vti_bin/People.asmx

[SoapDocumentMethodAttribute("http://schemas.microsoft.com/sharepoint/soap/ResolvePrincipals", RequestNamespace="http://schemas.microsoft.com/sharepoint/soap/", ResponseNamespace="http://schemas.microsoft.com/sharepoint/soap/", Use=SoapBindingUse.Literal, ParameterStyle=SoapParameterStyle.Wrapped)] 
public PrincipalInfo[] ResolvePrincipals (
	string[] principalKeys,
	SPPrincipalType principalType,
	bool addToUserInfoList
)

Parameters

principalKeys

Logon name of the principal.

principalType

SPPrincipalType object that specifies user scope and other information.

addToUserInfoList

Indicates whether to add the principal to a SPUserCollection that is associated with the Web site.

Return Value

A list of PrincipalInfo objects that is indexed and accessed by the logon name in the AccountName field.

A user may have more than one type of authorization access within a Web site. For example, a user may be part of a Windows SharePoint Services group and a distribution list, in addition to having Web site access that is authorized by their logon name. Consequently, there may be multiple copies of a user ID that are associated with a Web site.

Use this field when an implementation does not have an appropriate SPPrincipalInfo object with which to represent a user, and when the implementation needs to check user permissions for the site, grant user permissions for site objects, or perform some other security operation.

User verification is performed against a directory or user list, such as Active Directory Domain Services (AD DS), a Lightweight Directory Access Protocol (LDAP) directory, some other role or membership providers, or another form of user list.

Show: