AuthenticationBase.RegisterUser Method

AuthenticationBaseRegisterUser Method

Content Studio 5.7 SDK

Content Studio Web Content Management System

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

Registers a user in Content Studio. Inheriting classes call this method as a part of the authentication process.

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

Syntax

protected void RegisterUser(
	ConnectionId connectionId,
	SecurityIdentifier sid,
	string domainName,
	string userName,
	string fullName,
	string description,
	string email,
	DateTime expires,
	out int userId
)

Protected Sub RegisterUser ( 
	connectionId As ConnectionId,
	sid As SecurityIdentifier,
	domainName As String,
	userName As String,
	fullName As String,
	description As String,
	email As String,
	expires As DateTime,
	<OutAttribute> ByRef userId As Integer
)

Parameters

connectionId: Type: ContentStudioConnectionId
A value that identifies the web site.
sid: Type: System.Security.PrincipalSecurityIdentifier
A SecurityIdentifier representing the user to register.
domainName: Type: SystemString
The name of the user's domain. With Windows authentication this is the NTLM domain. Max length of this parameter is MAX_TRUSTEENAME_LENGTH characters. This parameter cannot be Empty or null (Nothing in Visual Basic).
Important
The combination of the domainName and userName parameters must be unique within a given Web site.
userName: Type: SystemString
The user's login name. Max length of this parameter is MAX_DOMAINNAME_LENGTH characters. This parameter cannot be Empty or null (Nothing in Visual Basic).
Important
The combination of the domainName and userName parameters must be unique within a given Web site.
fullName: Type: SystemString
The user's full name. Max length of this parameter is MAX_FULLNAME_LENGTH characters. This parameter can be null (Nothing in Visual Basic) or Empty if not applicable.
description: Type: SystemString
A brief description of the user. Max length of this parameter is MAX_DESCRIPTION_LENGTH characters. This parameter can be null (Nothing in Visual Basic) or Empty if not applicable.
email: Type: SystemString
The user's email address, if available. If this parameter is null (Nothing in Visual Basic) the email address is left unchanged. Max length of this parameter is MAX_EMAIL_LENGTH characters.
expires: Type: SystemDateTime
A date that indicates when the account will expire in the authenticating system.
userId: Type: SystemInt32
After the call this parameter will contain the user's internal identifier. This parameter is passed uninitialized

Remarks

If the user already exists and is valid only the user's session timeout value will be updated, however if the session exists and is invalid basic information will be updated and all group mappings besides the default will be lost. If the user entry does not exist in Content Studio it will be created with only the default group mappings.
By default all users are mapped to the Everyone (World) well-known group sid.
External inheriting classes that implement authentication providers call this methods as a part of the authentication process. After this call, a call to the SaveUserGroupMapping(ConnectionId, Int32, Int32, SecurityIdentifier, SecurityIdentifier, SecurityIdentifier, SecurityIdentifier, SecurityIdentifier, SecurityIdentifier, SecurityIdentifier, SecurityIdentifier, SecurityIdentifier, SecurityIdentifier) method must be performed to assign group memberships to the user.

Reference

AuthenticationBase Class

ContentStudio.Security Namespace