SharePoint2007Provider::GetGroupsFromRole

  • Article

This procedure returns information about the collection of groups assigned to the specified role.

Arguments

Input Arguments Required Description

<target>

Yes

The URL of the Windows SharePoint Services administration site.

<siteGUID>

Yes

The globally unique identifier (GUID) of Windows SharePoint Services site collection.

<subSiteGUID>

Yes

The GUID of the subsite.

<roleName>

Yes

A string that contains the name of the role.
Output Arguments Description

<group/@id>

The member ID for the group.

<group/@name>

The name of the group.

<group/@description>

The description for the group.

<group/@ownerId>

The owner for the group, which can be a user or another group.

<user/@id>

The member ID for the user.

<user/@sid>

The unique security ID for the network account of the user.

<user/@name>

The display name of the user.

<user/@loginName>

The login name of the user.

<user/@email>

The e-mail address of the user.

<user/@notes>

The notes for the user.

<user/@isSiteAdmin>

A Boolean value that specifies whether the user is a site collection administrator.

<user/@isDomainGroup>

A Boolean value that indicates whether the user is a domain group.

Remarks

This procedure does not need rollback.

Sample Code

Example XML Request for Hosted Messaging and Collaboration version 4.5

<request> 
   <procedure> 
      <execute namespace="SharePoint2007Provider" procedure="GetGroupsFromRole" impersonate="1"> 
         <executeData> 
            <target>https://WSSFE:8080</target> 
            <siteGUID>c35af229-6bf4-4fc9-abbd-057ccd4801cc</siteGUID> 
            <subSiteGUID>dbba7392-1937-4f07-9e71-09b3bd50ac06</subSiteGUID> 
            <roleName>Full Control</roleName> 
         </executeData> 
         <after source="executeData" destination="data" mode="merge" /> 
      </execute> 
   </procedure> 
</request>

Example XML Response

<response> 
  <data> 
    <groups> 
      <group id="3" name="SPNSTestGroup" description="Add Group Test." ownerId="1"> 
        <users> 
          <user id="3" 
                sid="S-1-5-21-3511655109-3096873398-1435752672-500" 
                name="Administrator" 
                loginName="FABRIKAM\administrator" 
                email="" 
                notes="" 
                isSiteAdmin="false" 
                isDomainGroup="false"/> 
          <user id="1" 
                sid="S-1-5-21-1630865545-1885683816-3691740238-500" 
                name="WSSFE\administrator" 
                loginName="WSSFE\administrator" 
                email="admin@somecompany.com" 
                notes="" 
                isSiteAdmin="true" 
                isDomainGroup="false"/> 
        </users> 
      </group> 
    </groups> 
  </data> 
</response>

Applies To

SharePoint 2007 Provider for:

  • Hosted Messaging and Collaboration version 4.5

  • Hosted Messaging and Collaboration version 4.0

See also

Tasks

SharePoint2007Provider::AddGroupToRole
SharePoint2007Provider::RemoveGroupFromRole