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 , blank allowed

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 , blank allowed

Wether to invite users without any authentication strategy

Validations:

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

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

Validations:

  • Must be a String
users[invited_to_url]
optional , blank allowed

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

Validations:

  • Must be a String
users[email]
optional , blank allowed

Validations:

  • Must be a String
users[mobile]
optional , blank allowed

Validations:

  • Must be a String
users[origin_id]
optional , blank allowed

ID in the previous database

Validations:

  • Must be a String
users[username]
optional , blank allowed

username will be mandatory only if multiple users share same email

Validations:

  • Must be a String
users[encrypted_password]
optional , blank allowed

Encrypted password in the previous database

Validations:

  • Must be a String
users[custom_pepper]
optional , blank allowed

The pepper which have been used to encrypt the password

Validations:

  • Must be a String
users[google_id]
optional , blank allowed

UID of a Google account linked to this user

Validations:

  • Must be a String
users[apple_id]
optional , blank allowed

UID of an Apple account linked to this user

Validations:

  • Must be a String
users[email_confirmed]
optional , blank allowed

Wether the user email have already been confirmed or not

Validations:

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

Validations:

  • Must be a String
users[family_name]
optional , blank allowed

Validations:

  • Must be a String
users[non_latin_given_name]
optional , blank allowed

Validations:

  • Must be a String
users[non_latin_family_name]
optional , blank allowed

Validations:

  • Must be a String
users[male]
optional , blank allowed

Gender: Wether the user is a male or female

Validations:

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

Validations:

  • Must be a String
users[primary_country]
optional , blank allowed

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 , blank allowed

Have the user already completed a 10day course?

Validations:

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

Is the user an assistant teacher?

Validations:

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

Assistant teacher code, for example AD5, YNP, NJ

Validations:

  • Must be a String
users[is_cct]
optional , blank allowed

Is the user an children course teacher?

Validations:

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

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 , blank allowed

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 , blank allowed

Date after which the user will have to set up MFA for her account. Format must be YYYY-MM-DD. Users are automatically emailed when a date is set and reminded one week before the date.

Validations:

  • Must be a String
users[office365_id]
optional , blank allowed

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 , blank allowed

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

Validations:

  • Must be a String

Returns

Code: 200

Description:

Bulk import result with summary statistics, imported users array, errors array, and ignored users array. Response format: {summary: {message: string, created_count: number, failure_count: number, invited_count: number, ignored_count: number}, users: [user objects], errors: [{error: string, data: object}], ignored: [user objects]}

Param name Description

Code: 422

Description:

Error message in format: {error: error message}

Param name Description

Code: 401

Description:

Unauthorized - invalid or missing OAuth token

Param name Description