Content Studio Web Content Management System
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
XML containing the pageable list of groupsReturned xml element names and their values
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.
[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)
Syntax
public string GetList( ConnectionId connectionId, SessionId sessionId, string domain, int pageSize, int pageNumber, out int pageCount, out int recordCount )
Parameters
- connectionId
- Type: ContentStudioConnectionId
A value that identifies the web site - sessionId
- Type: ContentStudio.SecuritySessionId
A value that identifies the user's session. This value usually originates from a call to OpenSession(ConnectionId). - domain
- Type: SystemString
The name of the Domain to list groups from. Pass null or an empty string to list from all domains - pageSize
- Type: SystemInt32
The size of the pages to read. If this parameter is less than 1 pageSize will be 10. - pageNumber
- Type: SystemInt32
The page number to read. Currently this parameter is not used. - pageCount
- Type: SystemInt32
The total pages of data found - recordCount
- Type: SystemInt32
The total entries found
Return Value
Type: StringXML containing the pageable list of groups
<root> <groups> <group> <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> </group> <!-- more groups may follow--> </groups> </root>
Name | Value type | Description |
---|---|---|
root/groups | None | Group list |
root/groups/group | None | Group item |
root/groups/group/groupid | Integer | The internal identifier of the group |
root/groups/group/isspecialgroup | Bit 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/domain | String | The name of the Domain (Local or AD) of the group |
root/groups/group/groupname | String | The name of the group |
root/groups/group/fullname | String | A combination of the Domain and the Group name in the format "DOMAIN\NAME". |
root/groups/group/sid | String | The SDDL-format of the group's Security identifier value. |
root/groups/group/rights | Integer (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/description | String | The description of the group, this value is collected from the operating system. |
root/groups/group/localgroup | Bit value (0/1) - 1 (True) or 0 (False) | D |
Exceptions
Exception | Condition |
---|---|
CSInvalidSessionException | The caller is not logged in or the the session has expired |
SqlException | An error occurred when executing the command against the Content Studio database |
Content Studio permissions
Remarks
See Also