authenticationType

The type of authentication the user undergoes at runtime to gain access to the system.

Mandatory

The options are:

• BASIC

• ENTERPRISE

description

A description of the user. A human readable description of this user instance.

Optional

displayName

The localized name of the user to be used when displaying. Typically, the value is the localized full name. This value might be provisioned from the enterprise directory entry of the user. If the value does not exist, you can use synchronization rules to populate the value for other fields. For example: Surname, GivenName, or LoginName.

Optional

displayNameAscii

The name that corresponds to the console attribute Endpoint Display Name. The full text name of the user represented in ASCII. The attribute used for displaying (e.g. endpoints) the unsupported localized text.

Optional

dn

The distinguished name (DN) of the user. DN is a sequence of relative distinguished names (RDN) connected by commas. RDN is an attribute with an associated value in the form of attribute=value, typically expressed in a UTF-8 string format. Use DN for identifying the user and for authentication subject mapping. You can change DN.

Optional

isDuplicatedLoginAllowed

A boolean that indicates whether this user is allowed a duplicate concurrent logins. true indicates that the user can have duplicate logins.

Optional

Default value is true.

isEnabled

A boolean that indicates whether or not the user is active. Users with AuthenticationType=Basic fails if the value is false. This attribute can be used to disable access between login attempts. You cannot revoke login for a running session. Alternatively, the administrator can always modify the password to disable the user from logging in. A true stipulates this is an active user, a false used for a disabled user.

Optional

Default value is false.

isVirtualUser

A boolean that indicates whether or not the record is being used for a non-human entity such as an application, service, and software agent. You require this attribute where the entity behaves as a user and needs to have subset of the user profile populated. If the entity does not behave as a user and has a different trust relationship, for example, a trust certificate must not be treated as a virtual user. A virtual user can represent an Avaya or an external non-human entity. This attribute is provided as a convenience to track such accounts. A true stipulates this is a virtual users, a false is used for human users.

Optional

Default value is false.

givenName

The first name of the user.

Mandatory

honorific

The personal title used to address a user. This is typically a social title and not the work title which is contained in the title attribute. This attribute can map to PersonalTitle.

Optional

loginName

The unique login name that you provide for the user. The format for the login name is username@domain. The login name is an alphanumeric value and supports the ASCII characters “_”, “.”, and “-“.

Mandatory

middleName

The middle name of the user.

Optional

managerName

The name of the manager of the user. This is a free formed field and does not require the user’s manager to be a user of the solution. The attribute supports the reporting needs.

Optional

preferredGivenName

The preferred first name of the user.

Optional

preferredLanguage

The preferred written or spoken language. The format uses the ISO standard Language (ISO-639) and region (ISO-3166) codes If a preferred language is not available, the locale of the client must be used. If the value is blank, en_US must be used as default.

Optional

The options are:

• English (United States) - en_US

• Chinese (Simplified) - zh_CN

• Japanese (Japan) - ja_JP

• Korean (Korea) - ko_KR

• French (France) - fr_FR

• German (Germany) - de_DE

• Italian (Italy) - it_IT

• Russian (Russia) - ru_RU

• English (United Kingdom) - en_GB

• Spanish (Mexico) - es_MX

• Portugese (Brazil) - pt_BR

• French (Canada) - fr_CA

• English (Canada) - en_CA

source

A free format text field that identifies the entity that created this user record. The format of this field must be a IP Address/Port or a name representing an enterprise LDAP or Avaya.

Optional

User Management populates the source field with the name of the file.

sourceUserKey

The key of the user from the source system. If the source is an Enterprise Active Directory server, the key is objectGUID.

Optional

By default, the value is none.

status

The information that helps provisioning activities such as correcting or completing the provisioning of a user. It can also signify that approval is needed (PENDINGAUTHZ) before a user account is sufficiently configured to be a valid user (PROVISIONED).

Optional

The options are: AUTHPENDING; PENDINGAUTHZ; PROVISIONED

suffix

The text appended to a name. For example, Jr., III.

Optional

surname

The last name or the family name of the user.

Mandatory

timeZone

The preferred time zone of the user. For example: America/New_York, Europe/Dublin. The application consuming this information must know how to translate e.g. in Java it is TimeZone.getTimeZone("Europe/Moscow"); In the absence of a value, the system uses the local services timezone.

Optional

(-12:0)International Date Line West

(-11:0)Midway Island, Samoa

(-10:0)Hawaii

(-9:0)Alaska

(-8:0)Pacific Time (US & Canada); Tijuana

(-7:0)Mountain Time (US & Canada); Chihuahua, La Paz

(-7:0)Arizona

(-6:0)Central Time (US & Canada); Guadalajara, Mexico City

(-6:0)Central America; Saskatchewan

(-5:0)Indiana (East); Bogota, Lima, Quito

(-5:0)Eastern Time (US & Canada)

(-4:0)Caracas, La Paz

(-4:0)Atlantic Time (Canada); Santiago, Manaus

(-3:30)Newfoundland

(-3:0)Georgetown

(-3:0)Brasilia, Greenland, Buenos Aires, Montevideo

(-2:0)Mid-Atlantic

(-1:0)Azores

(-1:0)Cape Verde Is.

(0:0)Monrovia, Reykjavik

(0:0)GMT : Dublin, Edinburgh, Lisbon, London, Casablanca

(+1:0)West Central Africa

(+1:0)Amsterdam, Berlin, Rome, Belgrade, Prague, Brussels, Sarajevo

(+2:0)Harare, Pretoria

(+2:0)Amman, Athens, Minsk, Beirut, Cairo, Jerusalem, Helsinki, Windhoek

(+3:0)Baghdad, Kuwait, Riyadh, Nairobi, Tbilisi

(+3:0)Moscow, St. Petersburg, Volgograd

(+3:30)Tehran

(+4:0)Abu Dhabi, Muscat, Caucasus Standard Time

(+4:0)Baku, Tbilisi, Yerevan

(+4:30)Kabul

(+5:0)Islamabad, Karachi, Tashkent, Ekaterinburg

(+5:30)Chennai, Kolkata, Mumbai, New Delhi, Sri Jayawardenepura

(+5:45)Kathmandu

(+6:0)Astana, Dhaka, Almaty, Novosibirsk

(+6:30)Rangoon

(+7:0)Bangkok, Hanoi, Jakarta, Krasnoyarsk

(+8:0)Beijing, Hong Kong, Singapore; Taipei

(+8:0)Perth; Irkutsk, Ulaan Bataar

(+9:0)Seoul, Osaka, Sapporo, Tokyo

(+9:0)Yakutsk

(+9:30)Darwin, Adelaide

(+10:0)Brisbane, Guam, Port Moresby

(+10:0)Canberra, Melbourne, Sydney, Hobart, Vladivostok

(+11:0)Magadan, Solomon Is., New Caledonia

(+12:0)Auckland, Wellington

(+12:0)Fiji, Kamchatka, Marshall Is.

(+13:0)Nuku'alofa

title

The job function of a person in their organizational context.

Optional

userName

The username portion of the loginName field. An alphanumeric value that must comply with the userinfo related portion of a URI as described in rfc2396. However, it is further restricted as ASCII characters with only the _, -, and . special characters supported. This is the rfc2798 "uid" attribute.

Mandatory

userPassword

The encrypted password for this user account. A null password is used when the user is authenticated by the enterprise such as with a separate source such as the enterprise LDAP.

Optional

Need not specified value for Enterprise User. If the value is not specified for the Basic user, the user will be disabled.

commPassword

The encrypted “subscriber” or communication password with which the user logs can use to authentication with on to any CommProfile SIP and non SIP. This attribute is shared across different communication profiles and thus different communication services.

Optional

userType

The possible primary user application types. A User can be associated with multiple user types.

Optional

The options are administrator, communication_user, agent, supervisor, resident_expert, service_technician, lobby_phone

roles

The text name of a role. This value must be available in the System Manager database.

Optional

address

The address of the user.

Optional

securityIdentity

The SecurityIdentity is used to hold any additional identities for a user that can be used for authentication such as loginName, Kerberos account name, or X509 certificate name.

Optional

ownedContactLists

It is a collection of internal or external contacts. ContactList is owned by a specific user and has a name that a unique name within the context of its owner.

Optional

The system creates a default contactlist per user.

ownedContacts

A non-Avaya application user (external) contact. Contacts can be collected together along with User entities into a contact list. Contacts can be created by an administrator or an end user.

Optional

presenceUserDefault

The personal rules that are set by presentities to define how much presence information can be shown to watchers that are not explicitly mentioned in an ACL. There can be one User Default rule per presentity (User), or none.

Optional

presenceUserACL

The personal rules defined by presentities themselves on who can monitor their presence information. There might be several entries in the list for a given presentity, each entry corresponding to one watcher.

Optional

presenceUserCLDefault

The personal rule that is set by presentities to define how much presence information can be shown to watchers that belong to the contact list of the user. There can be one User Contact List Default rule per presentity (Person) or none.

Optional

commProfileSet

The default Commprofile set of the user. A commprofile set can exist without any handles or commprofiles referencing it. That is, you can create a commprofile set without creating a handle or a commprofile. A commprofile set can contain multiple commprofiles, but only one of each specific type. This is enforced by having the CommProfile uniqueness constraint include type, commprofile_set_id.

Optional

A user has a default commprofile set.

employeeNo

The employee number of the user.

Optional

department

The department which the employee belongs to.

Optional

organization

The organization which the employee belongs to.

Optional

localizedNames

The localized name of the user.

Optional