User.GetItem Method (ConnectionId, SessionId, Int32)

UserGetItem Method (ConnectionId, SessionId, Int32)

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

Returns detailed information about a registered user account.

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

Syntax

public string GetItem(
	ConnectionId connectionId,
	SessionId sessionId,
	int userId
)

Public Function GetItem ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	userId As Integer
) As String

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).
userId: Type: SystemInt32
The Content Studio identifier of the user to get details for. Use zero to obtain the details of the caller.

Return Value

Type: String
XML containing the details of the registered user

Copy

<root>
 <users>
   <user>
     <userid>id</userid>
     <domain>String value</domain>
     <username>String value</username>
     <fullname>String value</fullname>      
     <SID>String value</SID>
     <description>String value</description>
     <insession>Boolean value</insession>
     <disabled>Boolean value</disabled>
     <expires>DateValue</expires>
     <userdata>SrtingValue</userdata>
     <numberoflogins>numericValue</numberoflogins>
     <lastlogin>Datevalue</lastlogin>
     <firstlogin>Datevalue</firstlogin>
     <email>String value</email>
     <isunknown>Boolean value</isunknown>
     <sessionexpires>Boolean value</sessionexpires>
     <userkey>String value</userkey>
   </user>
 </users>
</root>

Exceptions

Exception	Condition
CSException	A business rule was violated in the underlying Content Studio database
SqlException	An error occurred when executing the command against the Content Studio database

Content Studio permissions

All authenticated users can read their own details. In order to read details from other users GlobalGroupAdmin right is needed.

Remarks

This call returns more detailed information about the user than the overloaded version that accepts different sorts of identifiers.

Reference

User Class

GetItem Overload

ContentStudio.Security Namespace