POST /api/v1/users/create_bulk
Create multiple users. Used for migration

Params

Param name Description
users
optional

Users to import

Validations:

  • Must be an Array of nested elements
users[vis_id]
optional

ID in VIS database. In case some of the users you try to create have

already been created before. So the API call is idempotent

Validations:

  • Must be a String
users[invite]
optional

Wether to invite users without any authentication strategy

Validations:

  • Must be one of: true, false, true, false.
users[locale]
optional

Locale for invitation and MFA emails (en, fr, de, hi…)

Validations:

  • Must be a String
users[invited_to_url]
optional

Customize the url to redirect the user afer invitation is accepted. Default to OauthApplication home_page

Validations:

  • Must be a String
users[email]
optional

Validations:

  • Must be a String
users[mobile]
optional

Validations:

  • Must be a String
users[origin_id]
optional

ID in the previous database

Validations:

  • Must be a String
users[username]
optional

username will be mandatory only if multiple users share same email

Validations:

  • Must be a String
users[encrypted_password]
optional

Encrypted password in the previous database

Validations:

  • Must be a String
users[custom_pepper]
optional

The pepper which have been used to encrypt the password

Validations:

  • Must be a String
users[google_id]
optional

UID of a Google account linked to this user

Validations:

  • Must be a String
users[apple_id]
optional

UID of an Apple account linked to this user

Validations:

  • Must be a String
users[email_confirmed]
optional

Wether the user email have already been confirmed or not

Validations:

  • Must be one of: true, false, true, false.
users[given_name]
optional

Validations:

  • Must be a String
users[family_name]
optional

Validations:

  • Must be a String
users[non_latin_given_name]
optional

Validations:

  • Must be a String
users[non_latin_family_name]
optional

Validations:

  • Must be a String
users[male]
optional

Gender: Wether the user is a male or female

Validations:

  • Must be one of: true, false, true, false.
users[birthdate]
optional

Validations:

  • Must be a String
users[primary_country]
optional

Alpha2 code of the country where the user do most of its Vipassana activity just give address country if you are not sure

Validations:

  • Must be a String
users[old_student]
optional

Have the user already completed a 10day course?

Validations:

  • Must be one of: true, false, true, false.
users[is_at]
optional

Is the user an assistant teacher?

Validations:

  • Must be one of: true, false, true, false.
users[at_code]
optional

Assistant teacher code, for example AD5, YNP, NJ

Validations:

  • Must be a String
users[is_cct]
optional

Is the user an children course teacher?

Validations:

  • Must be one of: true, false, true, false.
users[student_account_app]
optional

Which student app should be used. If not provided, it will be automatically detected from primary_country

Validations:

  • Must be one of: mycourses, do_student_account.
users[password_required]
optional

If the user is required to setup a password (otherwise they might only sign in with external providers such as google or office365)

Validations:

  • Must be one of: true, false, true, false.
users[require_mfa_from_date]
optional

Date after which the user will have to set up MFA for her account. Format must be YYYY-MM-DD

Validations:

  • Must be a String
users[office365_id]
optional

UID of an Office365 account linked to this user. Can be updated only if the current value is blank.

Validations:

  • Must be a String
users[office365_email]
optional

Office365 email of this user, something like [email protected]

Validations:

  • Must be a String