You are here: Ektron Namespace > Web Services API > Ektron.Services Namespace > Classes > User Class
Ektron CMS400.NET API Documentation
ContentsIndexHome
PreviousUpNext
User Class

This section describes the Web Service methods used with Users. The Users Web service is a wrapper for the User API: Ektron.Cms.API.User.User. These methods can be accessed through the User.asmx file located in:

~/Workarea/webservices/WebServiceAPI/User/User.asmx

Web Services examples involving content are available in the Developer sample site. You can download this site from: 

http://www.ektron.com/cms400-web-cms.aspx?id=5278 

Once the developer site is installed, example code files are located in your site root. For example:

C:\Inetpub\wwwroot\CMS400Developer\Developer\dotNetAssemblies\WebServicesAPI\UserAPI

 

IMPORTANT: If you are accessing these Web Services remotely, you will need to set the authentication header. For example:

userAPI.AuthenticationHeaderValue = New localhost.AuthenticationHeader()
userAPI.AuthenticationHeaderValue.Username = "admin"
userAPI.AuthenticationHeaderValue.Password = "admin"
userAPI.AuthenticationHeaderValue.Domain = "Domain" '''Only needed if AD/LDAP is being used
C#
[WebService(Namespace = "http://tempuri.org/")]
[WebServiceBinding(ConformsTo = WsiProfiles.None)]
public class User : EktronBaseService;
Visual Basic
<WebService(Namespace = "http://tempuri.org/")>
<WebServiceBinding(ConformsTo = WsiProfiles.None)>
Public Class User
Inherits EktronBaseService

User.cs

Name 
Description 
The methods of the User class are listed here. 
 
Name 
Description 
 
This is the overview for the ActivateUserAccount method overload. 
 
Creates new membership user.
This method can be accessed through the User.asmx file located in:  
 
Adds a new user to the CMS.
This method can be accessed through the User.asmx file located in:  
 
Adds permission for the given role.
This method can be accessed through the User.asmx file located in:  
 
Creates new cms user.
This method can be accessed through the User.asmx file located in:  
 
Creates new user group.
This method can be accessed through the User.asmx file located in:  
 
Adds an existing user to an existing group.
This method can be accessed through the User.asmx file located in:  
 
Login the given user credentials.
This method can be accessed through the User.asmx file located in:  
 
This is the overview for the CreateBlankUserObject method overload. 
 
Removes the user from the system. This will not purge the data, but it disables the user from further accessing the system.
This method can be accessed through the User.asmx file located in:  
 
Removes the user from the system. This will not purge the data, but it disables the user from further accessing the system.
This method can be accessed through the User.asmx file located in:  
 
Removes a user from the designated group.
This method can be accessed through the User.asmx file located in:  
 
Removes the group from the system permanently.
This method can be accessed through the User.asmx file located in:  
 
This method creates the editable fields(UI) for user's custom properties.
This method can be accessed through the User.asmx file located in:  
 
Returns all of the user properties with or without preference.
This method can be accessed through the User.asmx file located in:  
 
Loads the CMS and Active Directory name.
This method can be accessed through the User.asmx file located in:  
 
Loads all the CMS users.
This method can be accessed through the User.asmx file located in:  
 
Returns array of all the custom properties defined in the system.
This method can be accessed through the User.asmx file located in:  
 
Returns all the users based on the given properties.
This method can be accessed through the User.asmx file located in:  
 
This is the overview for the GetAllUserGroups method overload. 
 
This is the overview for the GetAllUsers method overload. 
 
Loads all the groups by user.
This method can be accessed through the User.asmx file located in:  
 
Returns user data based on the user's login name (username).
This method can be accessed through the User.asmx file located in:  
 
Loads the user details for the given user.
This method can be accessed through the User.asmx file located in:  
 
Loads the user details for the given user.
This method can be accessed through the User.asmx file located in:  
 
Returns an array of custom properties for a given user's ID.
This method can be accessed through the User.asmx file located in:  
 
Returns user data for a given user's ID.
This method can be accessed through the User.asmx file located in:  
 
 
 
Loads a given group's details.
This method can be accessed through the User.asmx file located in:  
 
Returns all the groups data for the administrator.
This method can be accessed through the User.asmx file located in:  
 
Loads the user permissions as a array of UserPermissionData.
This method can be accessed through the User.asmx file located in:  
 
Loads the preferences for the given user.
This method can be accessed through the User.asmx file located in:  
 
This is the overview for the GetUsers method overload. 
 
Loads the users that have permissions to the given content.
This method can be accessed through the User.asmx file located in:  
 
Loads all the users that are not in the given group.
This method can be accessed through the User.asmx file located in:  
 
Determines the if the current user is an Administrator.
This method can be accessed through the User.asmx file located in:  
 
This is the overview for the IsARoleMember method overload. 
 
Determines whether a Role Member is allowed to work with a given piece of content as an administrator or not. Administrations privileges are for the given piece of content only. Roles provide the ability to offload/delegate some of the administrator's tasks onto other users, without giving full administration privileges to a user.
This method can be accessed through the User.asmx file located in:  
 
Determines whether a Role Member is allowed to work with a given folder as an administrator or not. Administrations privileges are for the given folder only. Roles provide the ability to offload/delegate some of the administrator's tasks onto other users, without giving full administration privileges to a user.
This method can be accessed through the User.asmx file located in:  
 
Used to log in the user.
This method can be accessed through the User.asmx file located in:  
 
This is the overview for the ResetMembershipUserPassword method overload. 
 
Unsubscribes a user from the system.
This method can be accessed through the User.asmx file located in:  
 
Updates the order of available custom properties.
This method can be accessed through the User.asmx file located in:  
 
Sets the map co-ordinate for the given user property.
This method can be accessed through the User.asmx file located in:  
 
This is the overview for the UpdateUser method overload. 
 
Updates the user group details.
This method can be accessed through the User.asmx file located in:  
 
Updates the given user’s preference data.
This method can be accessed through the User.asmx file located in:  
 
This is the overview for the UserObject method overload. 
Created with a commercial version of Doc-O-Matic. In order to make this message disappear you need to register this software. If you have problems registering this software please contact us at [email protected].
Copyright (c) 2008. All rights reserved.
What do you think about this topic? Send feedback!