Public Member Functions | |
| UserInformation (string ActivationAccessCode=default(string), string Company=default(string), List< ConnectUserObject > ConnectConfigurations=default(List< ConnectUserObject >), string CountryCode=default(string), string CreatedDateTime=default(string), List< NameValue > CustomSettings=default(List< NameValue >), string DefaultAccountId=default(string), string Email=default(string), string EnableConnectForUser=default(string), ErrorDetails ErrorDetails=default(ErrorDetails), string FirstName=default(string), ForgottenPasswordInformation ForgottenPasswordInfo=default(ForgottenPasswordInformation), List< Group > GroupList=default(List< Group >), bool? HasRemoteNotary=default(bool?), AddressInformation HomeAddress=default(AddressInformation), string InitialsImageUri=default(string), string IsAdmin=default(string), string IsAlternateAdmin=default(string), string IsNAREnabled=default(string), string JobTitle=default(string), string LastLogin=default(string), string LastName=default(string), string LoginStatus=default(string), string MiddleName=default(string), string Password=default(string), string PasswordExpiration=default(string), string PermissionProfileId=default(string), string PermissionProfileName=default(string), string ProfileImageUri=default(string), string SendActivationEmail=default(string), string SendActivationOnInvalidLogin=default(string), string SignatureImageUri=default(string), string Subscribe=default(string), string SuffixName=default(string), string Title=default(string), string Uri=default(string), string UserAddedToAccountDateTime=default(string), string UserId=default(string), string UserName=default(string), string UserProfileLastModifiedDate=default(string), UserSettingsInformation UserSettings=default(UserSettingsInformation), string UserStatus=default(string), string UserType=default(string), AddressInformation WorkAddress=default(AddressInformation)) | |
| Initializes a new instance of the UserInformation class. More... | |
| override string | ToString () |
| Returns the string presentation of the object More... | |
| string | ToJson () |
| Returns the JSON string presentation of the object More... | |
| override bool | Equals (object obj) |
| Returns true if objects are equal More... | |
| bool | Equals (UserInformation other) |
| Returns true if UserInformation instances are equal More... | |
| override int | GetHashCode () |
| Gets the hash code More... | |
| IEnumerable< ValidationResult > | Validate (ValidationContext validationContext) |
Properties | |
| string | ActivationAccessCode [get, set] |
| The activation code the new user must enter when activating their account. More... | |
| string | Company [get, set] |
| Gets or Sets Company More... | |
| List< ConnectUserObject > | ConnectConfigurations [get, set] |
| Gets or Sets ConnectConfigurations More... | |
| string | CountryCode [get, set] |
| Gets or Sets CountryCode More... | |
| string | CreatedDateTime [get, set] |
| Indicates the date and time the item was created. More... | |
| List< NameValue > | CustomSettings [get, set] |
| The name/value pair information for the user custom setting. More... | |
| string | DefaultAccountId [get, set] |
| Gets or Sets DefaultAccountId More... | |
| string | Email [get, set] |
| Gets or Sets Email More... | |
| string | EnableConnectForUser [get, set] |
| Specifies whether the user is enabled for updates from DocuSign Connect. Valid values: true or false. More... | |
| ErrorDetails | ErrorDetails [get, set] |
| Array or errors. More... | |
| string | FirstName [get, set] |
| The user's first name. Maximum Length: 50 characters. More... | |
| ForgottenPasswordInformation | ForgottenPasswordInfo [get, set] |
| A complex element containing up to four Question/Answer pairs for forgotten password information. More... | |
| List< Group > | GroupList [get, set] |
| 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. More... | |
| bool | HasRemoteNotary [get, set] |
| Gets or Sets HasRemoteNotary More... | |
| AddressInformation | HomeAddress [get, set] |
| Specifies the email for the signing host. It is a Required element for In Person Signers recipient Type. Maximum Length: 100 characters. More... | |
| string | InitialsImageUri [get, set] |
| Contains the URI for an endpoint that you can use to retrieve the initials image. More... | |
| string | IsAdmin [get, set] |
| Determines if the feature set is actively set as part of the plan. More... | |
| string | IsAlternateAdmin [get, set] |
| Gets or Sets IsAlternateAdmin More... | |
| string | IsNAREnabled [get, set] |
| Gets or Sets IsNAREnabled More... | |
| string | JobTitle [get, set] |
| Gets or Sets JobTitle More... | |
| string | LastLogin [get, set] |
| Shows the date-time when the user last logged on to the system. More... | |
| string | LastName [get, set] |
| The user's last name. Maximum Length: 50 characters. More... | |
| string | LoginStatus [get, set] |
| Shows the current status of the user's password. Possible values are: * password_reset * password_active * password_expired * password_locked * password_reset_failed More... | |
| string | MiddleName [get, set] |
| The user's middle name. Maximum Length: 50 characters. More... | |
| string | Password [get, set] |
| Gets or Sets Password More... | |
| string | PasswordExpiration [get, set] |
| Gets or Sets PasswordExpiration More... | |
| string | PermissionProfileId [get, set] |
| Gets or Sets PermissionProfileId More... | |
| string | PermissionProfileName [get, set] |
| Gets or Sets PermissionProfileName More... | |
| string | ProfileImageUri [get, set] |
| Gets or Sets ProfileImageUri More... | |
| string | SendActivationEmail [get, set] |
| Gets or Sets SendActivationEmail More... | |
| string | SendActivationOnInvalidLogin [get, set] |
| 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. More... | |
| string | SignatureImageUri [get, set] |
| Contains the URI for an endpoint that you can use to retrieve the signature image. More... | |
| string | Subscribe [get, set] |
| Gets or Sets Subscribe More... | |
| string | SuffixName [get, set] |
| The suffix for the user's name. Maximum Length: 50 characters. More... | |
| string | Title [get, set] |
| The title of the user. More... | |
| string | Uri [get, set] |
| Gets or Sets Uri More... | |
| string | UserAddedToAccountDateTime [get, set] |
| Gets or Sets UserAddedToAccountDateTime More... | |
| string | UserId [get, set] |
| Gets or Sets UserId More... | |
| string | UserName [get, set] |
| Gets or Sets UserName More... | |
| string | UserProfileLastModifiedDate [get, set] |
| Gets or Sets UserProfileLastModifiedDate More... | |
| UserSettingsInformation | UserSettings [get, set] |
| 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. More... | |
| string | UserStatus [get, set] |
| Gets or Sets UserStatus More... | |
| string | UserType [get, set] |
| Gets or Sets UserType More... | |
| AddressInformation | WorkAddress [get, set] |
| Gets or Sets WorkAddress More... | |
Detailed Description
User information.
Constructor & Destructor Documentation
◆ UserInformation()
|
inline |
Initializes a new instance of the UserInformation class.
- Parameters
-
ActivationAccessCode The activation code the new user must enter when activating their account.. Company Company. ConnectConfigurations ConnectConfigurations. CountryCode CountryCode. CreatedDateTime Indicates the date and time the item was created.. CustomSettings The name/value pair information for the user custom setting.. DefaultAccountId DefaultAccountId. Email Email. EnableConnectForUser Specifies whether the user is enabled for updates from DocuSign Connect. Valid values: true or false.. ErrorDetails Array or errors.. FirstName The user's first name. Maximum Length: 50 characters.. ForgottenPasswordInfo A complex element containing up to four Question/Answer pairs for forgotten password information.. GroupList 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. . HasRemoteNotary HasRemoteNotary. HomeAddress Specifies the email for the signing host. It is a Required element for In Person Signers recipient Type. Maximum Length: 100 characters.. InitialsImageUri Contains the URI for an endpoint that you can use to retrieve the initials image.. IsAdmin Determines if the feature set is actively set as part of the plan.. IsAlternateAdmin IsAlternateAdmin. IsNAREnabled IsNAREnabled. JobTitle JobTitle. LastLogin Shows the date-time when the user last logged on to the system.. LastName The user's last name. Maximum Length: 50 characters.. LoginStatus Shows the current status of the user's password. Possible values are: * password_reset * password_active * password_expired * password_locked * password_reset_failed . MiddleName The user's middle name. Maximum Length: 50 characters.. Password Password. PasswordExpiration PasswordExpiration. PermissionProfileId PermissionProfileId. PermissionProfileName PermissionProfileName. ProfileImageUri ProfileImageUri. SendActivationEmail SendActivationEmail. SendActivationOnInvalidLogin 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. . SignatureImageUri Contains the URI for an endpoint that you can use to retrieve the signature image.. Subscribe Subscribe. SuffixName The suffix for the user's name. Maximum Length: 50 characters. . Title The title of the user.. Uri Uri. UserAddedToAccountDateTime UserAddedToAccountDateTime. UserId UserId. UserName UserName. UserProfileLastModifiedDate UserProfileLastModifiedDate. UserSettings 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.. UserStatus UserStatus. UserType UserType. WorkAddress WorkAddress.
Member Function Documentation
◆ Equals() [1/2]
|
inline |
Returns true if objects are equal
- Parameters
-
obj Object to be compared
- Returns
- Boolean
◆ Equals() [2/2]
|
inline |
Returns true if UserInformation instances are equal
- Parameters
-
other Instance of UserInformation to be compared
- Returns
- Boolean
◆ GetHashCode()
|
inline |
Gets the hash code
- Returns
- Hash code
◆ ToJson()
|
inline |
Returns the JSON string presentation of the object
- Returns
- JSON string presentation of the object
◆ ToString()
|
inline |
Returns the string presentation of the object
- Returns
- String presentation of the object
Property Documentation
◆ ActivationAccessCode
|
getset |
The activation code the new user must enter when activating their account.
The activation code the new user must enter when activating their account.
◆ Company
|
getset |
Gets or Sets Company
◆ ConnectConfigurations
|
getset |
Gets or Sets ConnectConfigurations
◆ CountryCode
|
getset |
Gets or Sets CountryCode
◆ CreatedDateTime
|
getset |
Indicates the date and time the item was created.
Indicates the date and time the item was created.
◆ CustomSettings
The name/value pair information for the user custom setting.
The name/value pair information for the user custom setting.
◆ DefaultAccountId
|
getset |
Gets or Sets DefaultAccountId
|
getset |
Gets or Sets Email
◆ EnableConnectForUser
|
getset |
◆ ErrorDetails
|
getset |
Array or errors.
Array or errors.
◆ FirstName
|
getset |
The user's first name. Maximum Length: 50 characters.
The user's first name. Maximum Length: 50 characters.
◆ ForgottenPasswordInfo
|
getset |
A complex element containing up to four Question/Answer pairs for forgotten password information.
A complex element containing up to four Question/Answer pairs for forgotten password information.
◆ GroupList
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.
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.
◆ HasRemoteNotary
|
getset |
Gets or Sets HasRemoteNotary
◆ HomeAddress
|
getset |
Specifies the email for the signing host. It is a Required element for In Person Signers recipient Type. Maximum Length: 100 characters.
Specifies the email for the signing host. It is a Required element for In Person Signers recipient Type. Maximum Length: 100 characters.
◆ InitialsImageUri
|
getset |
Contains the URI for an endpoint that you can use to retrieve the initials image.
Contains the URI for an endpoint that you can use to retrieve the initials image.
◆ IsAdmin
|
getset |
Determines if the feature set is actively set as part of the plan.
Determines if the feature set is actively set as part of the plan.
◆ IsAlternateAdmin
|
getset |
Gets or Sets IsAlternateAdmin
◆ IsNAREnabled
|
getset |
Gets or Sets IsNAREnabled
◆ JobTitle
|
getset |
Gets or Sets JobTitle
◆ LastLogin
|
getset |
Shows the date-time when the user last logged on to the system.
Shows the date-time when the user last logged on to the system.
◆ LastName
|
getset |
The user's last name. Maximum Length: 50 characters.
The user's last name. Maximum Length: 50 characters.
◆ LoginStatus
|
getset |
Shows the current status of the user's password. Possible values are: * password_reset * password_active * password_expired * password_locked * password_reset_failed
Shows the current status of the user's password. Possible values are: * password_reset * password_active * password_expired * password_locked * password_reset_failed
◆ MiddleName
|
getset |
The user's middle name. Maximum Length: 50 characters.
The user's middle name. Maximum Length: 50 characters.
◆ Password
|
getset |
Gets or Sets Password
◆ PasswordExpiration
|
getset |
Gets or Sets PasswordExpiration
◆ PermissionProfileId
|
getset |
Gets or Sets PermissionProfileId
◆ PermissionProfileName
|
getset |
Gets or Sets PermissionProfileName
◆ ProfileImageUri
|
getset |
Gets or Sets ProfileImageUri
◆ SendActivationEmail
|
getset |
Gets or Sets SendActivationEmail
◆ SendActivationOnInvalidLogin
|
getset |
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.
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.
◆ SignatureImageUri
|
getset |
Contains the URI for an endpoint that you can use to retrieve the signature image.
Contains the URI for an endpoint that you can use to retrieve the signature image.
◆ Subscribe
|
getset |
Gets or Sets Subscribe
◆ SuffixName
|
getset |
The suffix for the user's name. Maximum Length: 50 characters.
The suffix for the user's name. Maximum Length: 50 characters.
◆ Title
|
getset |
The title of the user.
The title of the user.
◆ Uri
|
getset |
Gets or Sets Uri
◆ UserAddedToAccountDateTime
|
getset |
Gets or Sets UserAddedToAccountDateTime
◆ UserId
|
getset |
Gets or Sets UserId
◆ UserName
|
getset |
Gets or Sets UserName
◆ UserProfileLastModifiedDate
|
getset |
Gets or Sets UserProfileLastModifiedDate
◆ UserSettings
|
getset |
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.
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.
◆ UserStatus
|
getset |
Gets or Sets UserStatus
◆ UserType
|
getset |
Gets or Sets UserType
◆ WorkAddress
|
getset |
Gets or Sets WorkAddress
The documentation for this class was generated from the following file:
- sdk/src/DocuSign.eSign/Model/UserInformation.cs
