GroupGetList Method (ConnectionId, SessionId, String, Int32, Int32, Int32, Int32) Content Studio 5.7 SDK
Content Studio Web Content Management System

[This is preliminary documentation and is subject to change.]

Returns a paged list with detailed information of registered group accounts in Content Studio.

Namespace: ContentStudio.Security
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)

public string GetList(
	ConnectionId connectionId,
	SessionId sessionId,
	string domain,
	int pageSize,
	int pageNumber,
	out int pageCount,
	out int recordCount


Type: ContentStudioConnectionId
A value that identifies the web site
Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId).
Type: SystemString
The name of the Domain to list groups from. Pass null or an empty string to list from all domains
Type: SystemInt32
The size of the pages to read. If this parameter is less than 1 pageSize will be 10.
Type: SystemInt32
The page number to read. Currently this parameter is not used.
Type: SystemInt32
The total pages of data found
Type: SystemInt32
The total entries found

Return Value

Type: String
XML containing the pageable list of groups
      <groupid>Integer value</groupid>
      <isspecialgroup>Bit (0 / 1) value</isspecialgroup>
      <domain>String value</domain>
      <groupname>String value</groupname>
      <fullname>String value</fullname>
      <sid>String value</sid>
      <rights>Integer value (bitmasked)</rights>
      <description>String value</description>
      <localgroup>Bit (0 / 1) value</localgroup>
    <!-- more groups may follow-->
Returned xml element names and their values
NameValue typeDescription
root/groupsNoneGroup list
root/groups/groupNoneGroup item
root/groups/group/groupidIntegerThe internal identifier of the group
root/groups/group/isspecialgroupBit value (0/1) - 1 (True) or 0 (False)1 (True) to indicate that the group is has special meaning to the system or to Content Studio. This kind of group is read.only.
root/groups/group/domainStringThe name of the Domain (Local or AD) of the group
root/groups/group/groupnameStringThe name of the group
root/groups/group/fullnameStringA combination of the Domain and the Group name in the format "DOMAIN\NAME".
root/groups/group/sidStringThe SDDL-format of the group's Security identifier value.
root/groups/group/rightsInteger (bitmasked)The global rights in Content Studio that applies to all members of the group, e.g. "The right to write code" or "The right to fully administer Content Studio" See GlobalRights
root/groups/group/descriptionStringThe description of the group, this value is collected from the operating system.
root/groups/group/localgroupBit value (0/1) - 1 (True) or 0 (False)D

CSInvalidSessionExceptionThe caller is not logged in or the the session has expired
SqlExceptionAn error occurred when executing the command against the Content Studio database
Content Studio permissions

Any non-anonymous user can execute this command.

This call returns all registered groups grouped in pages. It is up to the caller to navigate to the single page to display.
See Also