filterDate

Date of the last modification of the user account in the environment. The call will return the accounts modified after that moment. Can be used with filterDate or on its own. The modification date is also updated upon creation. (String type, YYYY-MM-DDTHH:MM:SSZ)

Name

Required

Comments/description

Identifier of the assigned branch in which to place the user. If empty, the user will be placed in the root branch. To change the branch of a user, use the "User/addtobranch" and "User/removefrombranch" calls (String type)

Identifier of the rights profile to assign to the user. If empty, the rights profile assigned by default will be "User". The rights profiles on branches must be modified through the calls of type /branch (String type)

Password of the user. If no password is provided, a random password will be generated. (String type, < = 250 characters)

login

Login of the user. (String type, >=4 and <= 250 characters. It must be a unique identifier on the server)

firstName

First name of the user. (String type, <=50 characters)

lastName

Last name of the user. (String type, <=50 characters)

language

The default display language can be set according to the following list of constants: 

• 1 = French (Canada) 
• 2 = English
• 3 = French (France)
• 4 = Spanish

If this value is empty, the API uses the default language defined for the organization in which the user is created. (Number type)

email

A format validation is performed by the web service in accordance with the RFC2822 standard (<=100 characters and the email address must be valid)

companyName

Company name of the user. (String type, <=100 characters) 

functionTitle

Position of the user in the organization. (String type, <= 100 characters)

phoneHome

Telephone number of the user. (String type, <=40 characters)

phoneMobile

Mobile telephone number of the user. (String type, <=40 characters)

phoneWork

Work telephone number of the user. (String type, <=40 characters)

phonePublic

The phonePublic field indicates which telephone number will be shared with the other Via users, according to the following list of constants: 

• 0 = no telephone number will be made public
• 1 = the mobile number will be made public
• 2 = the home number will be made public
• 3 = the work number will be made public

When this parameter is empty, the value 0 is applied. (Number type)

timeZone

Via users are invited to shared meetings without necessarily being in the same location. Via therefore allows each person to manage their own time zone in order to view the meetings in their local time. 

The complete list of constants (0 to 77) is available in the appendix of the document.
If this value is empty, the API uses the default time zone defined for the organization in which the user is created. 

address

Address of the user. (String type, <=100 characters)

address2

Additional information about the address (apartment, mailbox, floor). (String type, <=100 characters)

postalCode

Postal code of the user. (String type, <=50 characters)

city

City of the user. (String type, <=100 characters)

countryId

Country of the user. (Number type, see Appendix 3: Countries and States/Provinces)

stateId

Number indicating the state of the user. (Number type, see Appendix 3: Countries and States/Provinces)

portalId

Identifier of the default portal of the user. (String type)

enableNotifications

Indicates whether the user can receive by email the notifications related to the operation of the site and the promotional campaigns. Set to "true" by default

(Boolean type)

• 0 = Ask the user
• 1 = Web version
• 2 = Desktop application

(Read only)

Indicates the activation status of the user account.

• 0 = Active
• 1 = Inactive

 (Number type)

Indicates whether an account creation confirmation email will be sent to the user.

Indicates whether the user will have to change their password at their first login. (Boolean type)

customFields

Custom fields linked to the user.

Name

Required

Comments/description

This is the unique identifier of the user in the API. This parameter must be empty when the create method is used, but is required for edit mode.

Password of the user. (String type, < = 250 characters)

login

Login of the user. (String type, >=4 and <= 250 characters. It must be a unique identifier on the server)

firstName

First name of the user. (String type, <=50 characters)

lastName

Last name of the user. (String type, <=50 characters)

language

The default display language can be set according to the following list of constants: 

• 1 = French (Canada) 
• 2 = English
• 3 = French (France)
• 4 = Spanish

If this value is empty, the API uses the default language defined for the organization in which the user is created. (Number type)

email

A format validation is performed by the web service in accordance with the RFC2822 standard (<=100 characters and the email address must be valid)

companyName

Company name of the user. (String type, <=100 characters) 

functionTitle

Position of the user in the organization. (String type, <= 100 characters)

phoneHome

Telephone number of the user. (String type, <=40 characters)

phoneMobile

Mobile telephone number of the user. (String type, <=40 characters)

phoneWork

Work telephone number of the user. (String type, <=40 characters)

phonePublic

The phonePublic field indicates which telephone number will be shared with the other Via users, according to the following list of constants: 

• 0 = no telephone number will be made public
• 1 = the mobile number will be made public
• 2 = the home number will be made public
• 3 = the work number will be made public

When this parameter is empty, the value 0 is applied. (Number type)

timeZone

Via users are invited to shared meetings without necessarily being in the same location. Via therefore allows each person to manage their own time zone in order to view the meetings in their local time. 

The complete list of constants (0 to 77) is available in the appendix of the document.
If this value is empty, the API uses the default time zone defined for the organization in which the user is created. 

address

Address of the user. (String type, <=100 characters)

address2

Additional information about the address (apartment, mailbox, floor). (String type, <=100 characters)

postalCode

Postal code of the user. (String type, <=50 characters)

city

City of the user. (String type, <=100 characters)

countryId

Country of the user. (Number type, see Appendix 3: Countries and States/Provinces)

stateId

Number indicating the state of the user. (Number type, see Appendix 3: Countries and States/Provinces)

portalId

Identifier of the default portal of the user. (String type)

• 0 = Ask the user
• 1 = Web version
• 2 = Desktop application

Indicates whether the user will receive by email the notifications related to the site and the promotional campaigns.

(Read only)

Indicates the activation status of the user account.

• 0 = Active
• 1 = Inactive

 (Number type)

customFields

Custom fields linked to the user.

Name

Required

Comments/description

This is the unique identifier of the user in the API. (String type)

Name

Required

Comments/description

This is the unique identifier of the user in the API. (String type)

Name

Required

Comments/description

This is the unique identifier of the user in the API. (String type)

Name

Required

Comments/description

This is the unique identifier of the user in the API. (String type)

Name

Required

Comments/description

This is the unique identifier of the user in the API. (String type)

Name

Required

Comments/description

This is the unique identifier of the user in the API. (String type)

Name

Required

Comments/description

login

Search field for the login of the user. (String type)

This field is required if the other fields are empty.

email

Search field for the email address of the user. (String type) 

This field is required if the other fields are empty.

includeInactive

Search field used to define whether inactive users are to be included.

(Boolean type)

customFields

Search field for the custom fields.

This field is required if the other fields are empty.

Name

Required

Comments/description

id

This is the unique identifier of the user in the API. (String type)

portalId

Default portal for the customization and the sign out. If the value is empty, the default portal is used. (String type)

refId

Reference ID based on the redirectType, required for modes 3, 4 and 8. (String type)
It is important to retrieve the returnURL placed on the URL of the button that sends the user to the SSO, so that you can return them signed in within the right context. You must re-encode this parameter in URL format so that it is valid.

subRefId

Reference ID based on the redirectType, required for mode 8, recording ID. (String type) 

It is important to retrieve the returnURL placed on the URL of the button that sends the user to the SSO, so that you can return them signed in within the right context. You must re-encode this parameter in URL format so that it is valid.

redirectType

RedirectTypes

• MyDashboard = 1
• MyWorkspaces = 2
• WorkspaceInstance = 3
• Workspace = 4
• MyFolder = 5
• Via HTML5 application = 8

Note that the urlRedirect value is not required if the redirectType value is provided.

urlRedirect

This is the redirect URL once the user is authenticated.

Note that the redirectType value is not required if the urlRedirect value is provided.

forceAccess

Optional parameter that is taken into account only for redirectType 8 (Via HTML5 application).
The value True (1) will allow the user to access the activity as a facilitator without needing to be associated with the activity (Boolean type)

Number

Message

Comments/description

100

Required id

You must provide an identifier for the user. 

101

Invalid id

The identifier provided for the user is invalid.

102

Required branchId

You must provide an identifier for the branch.

103

Invalid branchId

The identifier provided for the branch is invalid.

104

Invalid password length

The password must contain between 3 and 250 characters inclusively.

105

Invalid password character

The password contains one or more forbidden characters.

106

Invalid login length

The login must contain between 3 and 250 characters inclusively.

107

Invalid login character

The login contains one or more forbidden characters.

108

Login already exists

The login you wish to use already exists.

109

Invalid first name length

The first name must contain between 1 and 50 characters inclusively.

110

Required first name

You must provide a first name.

111

Invalid last name length

The last name must contain between 1 and 50 characters inclusively.

112

Required last name

You must provide the last name.

113

Invalid email length

The email address must contain a maximum of 100 characters.

114

Invalid email format

The email address is not in a valid format.

Example: address@domain.com

115

Required email

You must provide an email address.

116

Invalid companyName length

The organization name must contain a maximum of 100 characters inclusively.

117

Invalid functionTitle length

The position in the organization must contain a maximum of 100 characters inclusively.

118

Invalid phoneHome length

The home telephone number must contain a maximum of 40 characters inclusively.

119

Invalid phoneMobile length

The mobile telephone number must contain a maximum of 40 characters inclusively.

120

Invalid phoneWork length

The work telephone number must contain a maximum of 40 characters inclusively.

121

Invalid phonePublic

The public telephone value provided must be between 0 and 3 inclusively.

122

Invalid language

The language provided must be between 0 and 4 inclusively.

123

Required language

The language is required.

124

Invalid timezone

The time zone must be between 0 and 77 inclusively, with the exception of 52.

125

Invalid billToName length

The field must contain a maximum of 250 characters inclusively.

126

Invalid address length

The address must contain a maximum of 100 characters inclusively.

127

Invalid city length

The city name must contain a maximum of 100 characters inclusively.

128

Invalid postalCode length

The postal code must contain a maximum of 50 characters inclusively.

129

Invalid address2 length

The address 2 must contain a maximum of 100 characters inclusively.

130

Search field required

You must provide at least one of the following three fields when searching: Login, Email or customFields.

131

Invalid data

An error occurred while creating the user. Contact support if you get this error.

132

Invalid redirectType

The redirect type must be between 1 and 5, or 8.

133

Invalid portalId

The identifier provided for the portal is invalid.

134

Invalid refId

The reference identifier based on the redirectType is invalid. It is only required for modes 3, 4 and 8.

135

Invalid urlRedirect

The redirect URL is invalid. Use the following template: https://domaine.com

141

Invalid subRefId

The reference identifier based on the redirectType is invalid. It is only required for mode 8.