SDK-Handbuch › Integration › API Reference List › Translation Script Objects › Tools › User Methods › AddUserByMap

AddUserByMap

Description

This method adds a new user and returns the new user ID.

Syntax

AddUserByMap (UserDetails)

Parameters

Return Value

The new user ID.

Remarks

The map must contain the following entries:

• ContractParties - One of:
  • Null
  • One contract party
  • One contract party group
  • Map of contract parties and/or contract parties groups
• Roles - One of:
  • Null
  • One role
  • Map of roles
• UserDefaultPage - Legal values are:
  • ALERTS
  • CONTRACTS
  • FAVORITES
  • TAB_DASHBOARD
• UserDescription
• UserGroups - One of:
  • Null
  • One user group
  • Map of user groups
• UserName - Length 3 to 20 without @
• UserOrganization - Length 1 to 30 without @
• UserPassword - Length 3 to 10 without @
• UserRequirePasswordChange - Legal values are:
  • N
  • Y
• UserPasswordExpirationInterval - In days (1 to 366)

  Required when UserRequirePasswordChange=Y

• UserStatus - Legal values are:
  • ACTIVE
  • INACTIVE
• UserTimeZone