POST /api/v1/users
Create new user

Params

Param name Description
email
optional , blank allowed

Validations:

  • Must be a String
mobile
optional , blank allowed

Validations:

  • Must be a String
origin_id
optional , blank allowed

ID in the previous database

Validations:

  • Must be a String
username
optional , blank allowed

username will be mandatory only if multiple users share same email. All characters are allowed, except the reserved string ‘oldstudent’ and its case variations. Can be an empty string but cannot contain only spaces. Can be of any size.

Validations:

  • Must be a String
encrypted_password
optional , blank allowed

Encrypted password in the previous database. VIS does not enforce password format rules, except a minimum of 8 characters when users change their password through the VIS UI.

Validations:

  • Must be a String
custom_pepper
optional , blank allowed

The pepper which have been used to encrypt the password

Validations:

  • Must be a String
google_id
optional , blank allowed

UID of a Google account linked to this user

Validations:

  • Must be a String
apple_id
optional , blank allowed

UID of an Apple account linked to this user

Validations:

  • Must be a String
email_confirmed
optional , blank allowed

Wether the user email have already been confirmed or not

Validations:

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

Validations:

  • Must be a String
family_name
optional , blank allowed

Validations:

  • Must be a String
non_latin_given_name
optional , blank allowed

Validations:

  • Must be a String
non_latin_family_name
optional , blank allowed

Validations:

  • Must be a String
male
optional , blank allowed

Gender: Wether the user is a male or female

Validations:

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

Validations:

  • Must be a String
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
old_student
optional , blank allowed

Has the user already completed a 10-day course?

Validations:

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

Is the user an assistant teacher? DEPRECATED: use teacher_type instead. is_at is ignored when teacher_type is passed

Validations:

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

Assistant teacher code, for example AD5, YNP, NJ

Validations:

  • Must be a String
is_cct
optional , blank allowed

Is the user an children course teacher?

Validations:

  • Must be one of: true, false, true, false.
teacher_type
optional , blank allowed

Type of teacher the user is. Blank if the user is not a teacher. {“unknown” => “teacher or assistant teacher but VIS does not know its exact type.”, “ATT” => “Assistant Teacher Trainee”, “AT” => “Assistant Teacher”, “SAT” => “Senior Assistant Teacher”, “T” => “Teacher”, “CT” => “Center Teacher”, “CAT” => “Coordinating Area Teacher”, “BT” => “Bhikkhu / Bhikkhuni Teacher”}.

Validations:

  • Must be one of: unknown, ATT, AT, SAT, T, CT, CAT, BT.
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.
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.
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
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
office365_email
optional , blank allowed

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

Validations:

  • Must be a String
locale
optional , blank allowed

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

Validations:

  • Must be a String

Returns

Code: 200

Description:

User object in JSON format with the keys: id, email, birthdate, given_name, family_name, non_latin_given_name, non_latin_family_name, primary_country, male, invited_to_url, google_id, apple_id, office365_id, username, old_student, office365_email, duplicates_ids, student_account_app, at_code, is_cct, mobile, teacher_type, confirmed, sign_up_complete, session_info, student_account_url, mfa_set_up, is_at

Param name Description

Code: 422

Description:

Validation errors in format: {error: {field_name: ["error message 1", "error message 2"]}}

Param name Description

Code: 401

Description:

Unauthorized - invalid or missing OAuth token

Param name Description