User model

Describes all properties required in a request payload to create a user with the Create user.

These are described in the following two tables:

  • user parameters

  • parameters of other entities

User parameters

Parameter

Type

Access

Required

Description

id

integer

read-only

n/a

User ID. Auto number assigned by server.

username

string

 

yes

User's username.

  • Cannot contain specific symbols (^ + : & = ' " ,) or spaces.

  • Maximum length: 50 characters.

firstname

string

 

yes

User's first name.

Maximum length: 50 characters.

lastname

string

 

yes

User's last name.

Maximum length: 50 characters.

password

string

write-only

yes

User password, as described in the UserPassword model.

  • Cannot be one of the 5 previous passwords.

  • Cannot contain common dictionary words of at least 4 characters.

  • Must be at least 12 characters long and contain at least:

    • 1 special character

    • 1 uppercase character

    • 1 lowercase character

    • 1 number

allAccess

Boolean

Nuance internal only

no

 

lastLogin

string

read-only

n/a

String that contains the last login date.

failedAttempts

integer

read-only

n/a

Number of failed login attempts after last successful login.

locked

Boolean

 

no

If set to true, then disables login for user.

language

string

 

no

User's language in ISO 639-1 code format.

Supported values: EN, DE, ES, FR, and JA.

Default value: EN.

expiredDate

string

  • read-only

  • Nuance internal only

n/a

 

defaultSiteId

integer

 

yes

Site ID of the site where the user lands by default after login to Nuance Portal.

programRulesAccess

Boolean

  • read-only

  • Nuance internal only

 n/a  

customScript

string

  • read-only

  • Nuance internal only

 n/a  

syncAdmin

Boolean

  • read-only

  • Nuance internal only

 n/a  

numPswdHistory

integer

read-only

 n/a

Maximum number of last saved passwords.

pswdDate

string

read-only

 n/a

String containing the date the password was last changed.

version

integer

 

  • required for the Update endpoint

  • not required for the Create endpoint

For the Update endpoint, use the value obtained from the LookUp endpoint or the GET endpoint response. Do not increment or modify.

User object version.

Automatically updated after any change.

Default value: 0.

lastFailedPswdTime

string

  • read-only

  • Nuance internal only

n/a

  

activatedCode

string

  • read-only

  • Nuance internal only

n/a

  

ssoUser

Boolean

 

no

If set to true, then creates SSO for user.

idpId

integer

 

no

Provider ID for SSO login.

allAgentGroup

Boolean

 

no

If set to true, then grants access to all agent groups.

allBusinessUnit

Boolean

 

no

If set to true, then grants access to all business units.

throttling

integer

Nuance internal only

no

 

disabled

Boolean

read-only

 n/a

Indicates whether the user is deleted.

tempLocked

Boolean

read-only

 n/a

Indicates whether the user is locked after last 5 failed logins.

activated

Boolean

  • read-only

  • Nuance internal only

 n/a

 
organizationId integer   no Identifier associating a user account to the public key used in token exchange authentication.

Parameters of other entities

Users can be mapped to other entities, such as roles, sites, agent groups, and business units.

Parameter

Type

Access

Required

Description

roleIds

integer[]

 

yes

List of role IDs.

roles

Role[]

  • read-only

  • Nuance internal only

n/a

 

siteIds

integer[]

 

yes

Site IDs of sites that the user can access.

sites

SimpleSiteReadable[]

  • read-only

  • Nuance internal only

n/a

 

businessUnitIds

integer[]

 

yes

IDs of business units to which the user is assigned.

Tip: User cannot be assigned to more than 100 businessUnitIds. Instead, use the allBusinessUnit property .

businessUnits

SimpleBusinessUnitReadable[]

  • read-only

  • Nuance internal only

n/a

 

agentGroupIds

integer[]

 

no

IDs of agent groups to which the user is assigned.

Tip: User cannot be assigned to more than 200 agentGroupIds. Use the allAgentGroup property instead.

agentGroups

SimpleAgentGroupReadable[]

  • read-only

  • Nuance internal only

n/a

 

agentCoachStatus

integer[]

 

no

List of agent group IDs for disabling configured agent coach settings.

skillIds

integer[]

 

no

IDs of User's agent skills.

skills

SimpleSiteAgentAttributeReadable[]

  • read-only

  • Nuance internal only

n/a

 

agentSetting

UserAgentSetting

 

no

User's agent settings.

agentChatSettings

AgentChatSettings[]

 

no

User's agent-chat settings.

userReportingCategoryIds

integer[]

Nuance internal only

no

  

userReportingCategory

UserReportingCategory[]

  • read-only

  • Nuance internal only

n/a

  

userSites

UserSite[]

Nuance internal only

no