module:model/UserInformation

module:model/UserInformation

new module:model/UserInformation()

Source:

Constructs a new UserInformation.
User information.

Members

(inner) activationAccessCode :String

Source:

The activation code the new user must enter when activating their account.

Type:
  • String

(inner) company :String

Source:
Type:
  • String

(inner) connectConfigurations :Array.<module:model/ConnectUserObject>

Source:
Type:

(inner) countryCode :String

Source:
Type:
  • String

(inner) createdDateTime :String

Source:

Indicates the date and time the item was created.

Type:
  • String

(inner) customSettings :Array.<module:model/NameValue>

Source:

The name/value pair information for the user custom setting.

Type:

(inner) defaultAccountId :String

Source:
Type:
  • String

(inner) email :String

Source:
Type:
  • String

(inner) enableConnectForUser :String

Source:

Specifies whether the user is enabled for updates from DocuSign Connect. Valid values: true or false.

Type:
  • String

(inner) errorDetails :module:model/ErrorDetails

Source:

Array or errors.

Type:

(inner) firstName :String

Source:

The user's first name. Maximum Length: 50 characters.

Type:
  • String

(inner) forgottenPasswordInfo :module:model/ForgottenPasswordInformation

Source:

A complex element containing up to four Question/Answer pairs for forgotten password information.

Type:

(inner) groupList :Array.<module:model/Group>

Source:

A list of the group information for groups to add the user to. Group information can be found by calling [ML:GET group information]. The only required parameter is groupId. The parameters are: * groupId - The DocuSign group ID for the group. * groupName - The name of the group * permissionProfileId - The ID of the permission profile associated with the group. * groupType - The group type.

Type:

(inner) hasRemoteNotary :Boolean

Source:
Type:
  • Boolean

(inner) homeAddress :module:model/AddressInformation

Source:

Specifies the email for the signing host. It is a Required element for In Person Signers recipient Type. Maximum Length: 100 characters.

Type:

(inner) initialsImageUri :String

Source:

Contains the URI for an endpoint that you can use to retrieve the initials image.

Type:
  • String

(inner) isAdmin :String

Source:

Determines if the feature set is actively set as part of the plan.

Type:
  • String

(inner) isAlternateAdmin :String

Source:
Type:
  • String

(inner) isNAREnabled :String

Source:
Type:
  • String

(inner) jobTitle :String

Source:
Type:
  • String

(inner) lastLogin :String

Source:

Shows the date-time when the user last logged on to the system.

Type:
  • String

(inner) lastName :String

Source:

The user's last name. Maximum Length: 50 characters.

Type:
  • String

(inner) loginStatus :String

Source:

Shows the current status of the user's password. Possible values are: * password_reset * password_active * password_expired * password_locked * password_reset_failed

Type:
  • String

(inner) middleName :String

Source:

The user's middle name. Maximum Length: 50 characters.

Type:
  • String

(inner) password :String

Source:
Type:
  • String

(inner) passwordExpiration :String

Source:
Type:
  • String

(inner) permissionProfileId :String

Source:
Type:
  • String

(inner) permissionProfileName :String

Source:
Type:
  • String

(inner) profileImageUri :String

Source:
Type:
  • String

(inner) sendActivationEmail :String

Source:
Type:
  • String

(inner) sendActivationOnInvalidLogin :String

Source:

When set to true, specifies that an additional activation email is sent to the user if they fail a log on before activating their account.

Type:
  • String

(inner) signatureImageUri :String

Source:

Contains the URI for an endpoint that you can use to retrieve the signature image.

Type:
  • String

(inner) subscribe :String

Source:
Type:
  • String

(inner) suffixName :String

Source:

The suffix for the user's name. Maximum Length: 50 characters.

Type:
  • String

(inner) title :String

Source:

The title of the user.

Type:
  • String

(inner) uri :String

Source:
Type:
  • String

(inner) userAddedToAccountDateTime :String

Source:
Type:
  • String

(inner) userId :String

Source:
Type:
  • String

(inner) userName :String

Source:
Type:
  • String

(inner) userProfileLastModifiedDate :String

Source:
Type:
  • String

(inner) userSettings :module:model/UserSettingsInformation

Source:

The name/value pair information for user settings. These determine the actions that a user can take in the account. The [ML:userSettings] are listed and described below.

Type:

(inner) userStatus :String

Source:
Type:
  • String

(inner) userType :String

Source:
Type:
  • String

(inner) workAddress :module:model/AddressInformation

Source:
Type:

Methods

(static) constructFromObject(data, obj) → {module:model/UserInformation}

Source:

Constructs a UserInformation from a plain JavaScript object, optionally creating a new instance.
Copies all relevant properties from data to obj if supplied or a new instance if not.

Parameters:
Name Type Description
data Object

The plain JavaScript object bearing properties of interest.
obj module:model/UserInformation

Optional instance to populate.
Returns:

The populated UserInformation instance.

Type
module:model/UserInformation