User.GetItem Method (ConnectionId, SessionId, String, Trustee.UserIdentifiers)

UserGetItem Method (ConnectionId, SessionId, String, TrusteeUserIdentifiers)

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

Returns limited information about a registered user account, given one of several user identifiers.

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,
	string identifier,
	TrusteeUserIdentifiers identifierType
)

Public Function GetItem ( 
	connectionId As ConnectionId,
	sessionId As SessionId,
	identifier As String,
	identifierType As TrusteeUserIdentifiers
) 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).
identifier: Type: SystemString
Data that identifies the user. The Identifier parameter is the actual identifier data in the format that is specified in the IdentifierType parameter. This value can consist of up to 255 characters. For UserIdentifiers.None this parameter is ignored and can be omitted. For all other types the identifier must match exactly.
identifierType: Type: ContentStudio.SecurityTrusteeUserIdentifiers
The type of identifier that identifies a user.

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>
      <insession>Boolean value</insession>
      <disabled>Boolean value</disabled>
      <email>String value</email>
      <isunknown>Boolean value</isunknown>
      <userkey>String value</userkey>
      <logindate>Boolean value</logindate>
      <previouslogin>Boolean value</previouslogin>
    </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 the limited user information.

Reference

User Class

GetItem Overload

ContentStudio.Security Namespace