Content Studio Web Content Management System
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
XML
Syntax when the account was registered
Syntax when the account was updated
Inheriting classes can use this method to register any user account whether it exists in the network or not as long it has been given a unique and valid SID.
Normally there is no reason to register a user account in Content Studio since the authentication process does this automatically.
[This is preliminary documentation and is subject to change.]
Registers or updates a user account in Content Studio.
Namespace: ContentStudio.Security
Assembly: CSServer5 (in CSServer5.dll) Version: 5.7.5016.0 (5.7.5016.0)
Syntax
protected static string RegisterUser( ConnectionId connectionId, SessionId sessionId, SecurityIdentifier sid, string domain, string userName, string fullName, string description, DateTime expires, out int userId )
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). - sid
- Type: System.Security.PrincipalSecurityIdentifier
The user's security identifier - domain
- Type: SystemString
The name of the domain that the user belongs to. The Domain and UserName parameter must be unique in combination. This value cannot exceed MAX_DOMAINNAME_LENGTH characters. - userName
- Type: SystemString
The user's login name. The Domain and UserName parameter must be unique in combination. This value cannot exceed MAX_TRUSTEENAME_LENGTH characters. - fullName
- Type: SystemString
The user's full name (display name). This value cannot exceed MAX_FULLNAME_LENGTH characters. - description
- Type: SystemString
A short description of the user. This value cannot exceed MAX_DESCRIPTION_LENGTH characters. - expires
- Type: SystemDateTime
This value indicates when the user account expires. Use DateTime.MinValue to indicate that the account does not expire. - userId
- Type: SystemInt32
Returns the internal id of the user verified or registered.
Return Value
Type: StringXML
Syntax when the account was registered
<root> <status>0</status> <statustext>Success</statustext> <user id="Integer value" action="I" /> </root>
<root> <status>0</status> <statustext>Success</statustext> <user id="Integer value" action="U" /> </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 |
Remarks
Remarks
See Also