Documentation > CMS Template API Library > User

CrownPeak.CMSAPI.User

Represents a CMS User

NameDescriptionType
GetGroupNames()

Method
GetUsers()

Get a list of all users

Method
GetUsersByGroupName(String)

Gets a List of users that are members of the group specified in the name.

Method
IsInGroup(String)

Used to tell if the user belongs to the specified group name.

Method
Load(Int32)

Returns a new user object populated with the user specified by userId. Returns null, if not found

Method
Load(String)

Returns a new user object populated with the user specified by username. Returns null, if not found

Method
LoadUsers(List[Int32])

Use this to load a list of Users by a list of ids.

Method
Avatar

The path to the user's icon.

Property
Cell

The user's cell phone number.

Property
Department

The user's department.

Property
Description

Gets the user description.

Property
Email

The user's email addres as it appers in the cms.

Property
Fax

The user's Fax number.

Property
Firstname

The user's first name as it appears in the cms.

Property
Id

User Id.

Property
IsEnabled

Indicates if the status of the user account. If IsEnabled is true, the user may log into and use the cms. If IsEnabled is false, user cannot login and use the cms.

Property
LastLoginAddr

The last ip address that the user logged in from.

Property
LastLoginDate

This might not be initialized. Use HasValue to see.

Property
Lastname

The user's last name as it appears in the CMS.

Property
Location

The user's location as it appears in the CMS.

Property
Pager

The user's pager number.

Property
Phone

The user's Phone number.

Property
Title

The user's job title.

Property
Username

The username of the user.

Property

Connect with CrownPeak