{"docs":{"name":"Vipassana Identity Server API","info":"\n\u003cp\u003eAll the API endpoints are protected. You need to implement the Oauth Client Credential Flow to access them. Look for online resources or get help from AI assistants. You can also see how it is implemented in the \u003ca href=\"https://github.com/dhammaorg/omniauth-vis\"\u003egithub.com/dhammaorg/omniauth-vis\u003c/a\u003e ruby gem or use directly this gem if your application is written in ruby.\u003c/p\u003e\n","copyright":null,"doc_url":"/en/doc/api/1.0","api_url":"/api/v1","resources":{"users":{"doc_url":"/en/doc/api/1.0/users","id":"users","api_url":"/api/v1","name":"Users","short_description":null,"full_description":"","version":"1.0","formats":null,"metadata":null,"methods":[{"doc_url":"/en/doc/api/1.0/users/show","name":"show","apis":[{"api_url":"/api/v1/users/:id","http_method":"GET","short_description":"Find a user from its id","deprecated":null}],"formats":null,"full_description":"\n\u003cp\u003eUsers are scoped to those associated with the calling application. Generic user records are       an exception and can be read by id whether or not they are associated with the calling app.\u003c/p\u003e\n","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the user to return\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[{"code":200,"description":"User object in JSON format with the keys: id, duplicates_ids, office365_id, apple_id, google_id, apple_email, at_code, birthdate, email, family_name, given_name, google_email, is_cct, male, mobile, non_latin_family_name, non_latin_given_name, office365_email, old_student, primary_country, student_account_app, teacher_type, username, confirmed, sign_up_complete, session_info, student_account_url, mfa_set_up, is_at","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]},{"code":401,"description":"Unauthorized - invalid or missing OAuth token","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]},{"code":404,"description":"User not found","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/en/doc/api/1.0/users/create","name":"create","apis":[{"api_url":"/api/v1/users","http_method":"POST","short_description":"Create new user","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"email","full_name":"email","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mobile","full_name":"mobile","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"origin_id","full_name":"origin_id","description":"\n\u003cp\u003eID in the previous database\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"username","full_name":"username","description":"\n\u003cp\u003eusername 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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"encrypted_password","full_name":"encrypted_password","description":"\n\u003cp\u003eEncrypted 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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"custom_pepper","full_name":"custom_pepper","description":"\n\u003cp\u003eThe pepper which have been used to encrypt the password\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"google_id","full_name":"google_id","description":"\n\u003cp\u003eUID of a Google account linked to this user\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apple_id","full_name":"apple_id","description":"\n\u003cp\u003eUID of an Apple account linked to this user\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email_confirmed","full_name":"email_confirmed","description":"\n\u003cp\u003eWether the user email have already been confirmed or not\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"given_name","full_name":"given_name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"family_name","full_name":"family_name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"non_latin_given_name","full_name":"non_latin_given_name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"non_latin_family_name","full_name":"non_latin_family_name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"male","full_name":"male","description":"\n\u003cp\u003eGender: Wether the user is a male or female\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"birthdate","full_name":"birthdate","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"primary_country","full_name":"primary_country","description":"\n\u003cp\u003eAlpha2 code of the country where the user do most of its Vipassana activity               just give address country if you are not sure\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"old_student","full_name":"old_student","description":"\n\u003cp\u003eHas the user already completed a 10-day course?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"at_code","full_name":"at_code","description":"\n\u003cp\u003eAssistant teacher code, for example AD5, YNP, NJ\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"is_cct","full_name":"is_cct","description":"\n\u003cp\u003eIs the user an children course teacher?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"teacher_type","full_name":"teacher_type","description":"\n\u003cp\u003eType of teacher the user is. Blank if the user is not a teacher. {“unknown” =\u0026gt; “teacher or assistant teacher but VIS does not know its exact type.”, “ATT” =\u0026gt; “Assistant Teacher Trainee”, “AT” =\u0026gt; “Assistant Teacher”, “SAT” =\u0026gt; “Senior Assistant Teacher”, “T” =\u0026gt; “Teacher”, “CT” =\u0026gt; “Center Teacher”, “CAT” =\u0026gt; “Coordinating Area Teacher”, “BT” =\u0026gt; “Bhikkhu / Bhikkhuni Teacher”}.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eunknown\u003c/code\u003e, \u003ccode\u003eATT\u003c/code\u003e, \u003ccode\u003eAT\u003c/code\u003e, \u003ccode\u003eSAT\u003c/code\u003e, \u003ccode\u003eT\u003c/code\u003e, \u003ccode\u003eCT\u003c/code\u003e, \u003ccode\u003eCAT\u003c/code\u003e, \u003ccode\u003eBT\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"student_account_app","full_name":"student_account_app","description":"\n\u003cp\u003eWhich student app should be used. If not provided, it will be automatically detected               from primary_country\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003emycourses\u003c/code\u003e, \u003ccode\u003edo_student_account\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"password_required","full_name":"password_required","description":"\n\u003cp\u003eIf the user is required to setup a password (otherwise they might only sign in with               external providers such as google or office365)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"require_mfa_from_date","full_name":"require_mfa_from_date","description":"\n\u003cp\u003eDate 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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"office365_id","full_name":"office365_id","description":"\n\u003cp\u003eUID of an Office365 account linked to this user. Can be updated only if the current value is blank.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"office365_email","full_name":"office365_email","description":"\n\u003cp\u003eOffice365 email of this user, something like given_name.family_name@dhamma.org\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"google_email","full_name":"google_email","description":"\n\u003cp\u003eGoogle email of this user\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apple_email","full_name":"apple_email","description":"\n\u003cp\u003eApple email of this user\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"locale","full_name":"locale","description":"\n\u003cp\u003eLocale for confirmation and MFA emails (en, fr, de, hi…)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[{"code":200,"description":"User object in JSON format with the keys: id, duplicates_ids, office365_id, apple_id, google_id, apple_email, at_code, birthdate, email, family_name, given_name, google_email, is_cct, male, mobile, non_latin_family_name, non_latin_given_name, office365_email, old_student, primary_country, student_account_app, teacher_type, username, confirmed, sign_up_complete, session_info, student_account_url, mfa_set_up, is_at","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]},{"code":422,"description":"Validation errors in format: {error: {field_name: [\"error message 1\", \"error message 2\"]}}","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]},{"code":401,"description":"Unauthorized - invalid or missing OAuth token","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/en/doc/api/1.0/users/create_bulk","name":"create_bulk","apis":[{"api_url":"/api/v1/users/create_bulk","http_method":"POST","short_description":"Create multiple users. Used for migration","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"users","full_name":"users","description":"\n\u003cp\u003eUsers to import\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":false,"validator":"Must be an Array of nested elements","expected_type":"array","metadata":null,"show":true,"validations":[],"deprecated":false,"params":[{"name":"vis_id","full_name":"users[vis_id]","description":"\n\u003cp\u003eID in VIS database. In case some of the users you try to create have               already been created before. So the API call is idempotent\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"invite","full_name":"users[invite]","description":"\n\u003cp\u003eWether to invite users without any authentication strategy\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"locale","full_name":"users[locale]","description":"\n\u003cp\u003eLocale for invitation and MFA emails (en, fr, de, hi…)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"invited_to_url","full_name":"users[invited_to_url]","description":"\n\u003cp\u003eCustomize the url to redirect the user afer invitation is accepted. Default to OauthApplication home_page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email","full_name":"users[email]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mobile","full_name":"users[mobile]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"origin_id","full_name":"users[origin_id]","description":"\n\u003cp\u003eID in the previous database\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"username","full_name":"users[username]","description":"\n\u003cp\u003eusername 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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"encrypted_password","full_name":"users[encrypted_password]","description":"\n\u003cp\u003eEncrypted 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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"custom_pepper","full_name":"users[custom_pepper]","description":"\n\u003cp\u003eThe pepper which have been used to encrypt the password\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"google_id","full_name":"users[google_id]","description":"\n\u003cp\u003eUID of a Google account linked to this user\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apple_id","full_name":"users[apple_id]","description":"\n\u003cp\u003eUID of an Apple account linked to this user\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email_confirmed","full_name":"users[email_confirmed]","description":"\n\u003cp\u003eWether the user email have already been confirmed or not\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"given_name","full_name":"users[given_name]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"family_name","full_name":"users[family_name]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"non_latin_given_name","full_name":"users[non_latin_given_name]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"non_latin_family_name","full_name":"users[non_latin_family_name]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"male","full_name":"users[male]","description":"\n\u003cp\u003eGender: Wether the user is a male or female\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"birthdate","full_name":"users[birthdate]","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"primary_country","full_name":"users[primary_country]","description":"\n\u003cp\u003eAlpha2 code of the country where the user do most of its Vipassana activity               just give address country if you are not sure\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"old_student","full_name":"users[old_student]","description":"\n\u003cp\u003eHas the user already completed a 10-day course?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"at_code","full_name":"users[at_code]","description":"\n\u003cp\u003eAssistant teacher code, for example AD5, YNP, NJ\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"is_cct","full_name":"users[is_cct]","description":"\n\u003cp\u003eIs the user an children course teacher?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"teacher_type","full_name":"users[teacher_type]","description":"\n\u003cp\u003eType of teacher the user is. Blank if the user is not a teacher. {“unknown” =\u0026gt; “teacher or assistant teacher but VIS does not know its exact type.”, “ATT” =\u0026gt; “Assistant Teacher Trainee”, “AT” =\u0026gt; “Assistant Teacher”, “SAT” =\u0026gt; “Senior Assistant Teacher”, “T” =\u0026gt; “Teacher”, “CT” =\u0026gt; “Center Teacher”, “CAT” =\u0026gt; “Coordinating Area Teacher”, “BT” =\u0026gt; “Bhikkhu / Bhikkhuni Teacher”}.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eunknown\u003c/code\u003e, \u003ccode\u003eATT\u003c/code\u003e, \u003ccode\u003eAT\u003c/code\u003e, \u003ccode\u003eSAT\u003c/code\u003e, \u003ccode\u003eT\u003c/code\u003e, \u003ccode\u003eCT\u003c/code\u003e, \u003ccode\u003eCAT\u003c/code\u003e, \u003ccode\u003eBT\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"student_account_app","full_name":"users[student_account_app]","description":"\n\u003cp\u003eWhich student app should be used. If not provided, it will be automatically detected               from primary_country\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003emycourses\u003c/code\u003e, \u003ccode\u003edo_student_account\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"password_required","full_name":"users[password_required]","description":"\n\u003cp\u003eIf the user is required to setup a password (otherwise they might only sign in with               external providers such as google or office365)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"require_mfa_from_date","full_name":"users[require_mfa_from_date]","description":"\n\u003cp\u003eDate 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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"office365_id","full_name":"users[office365_id]","description":"\n\u003cp\u003eUID of an Office365 account linked to this user. Can be updated only if the current value is blank.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"office365_email","full_name":"users[office365_email]","description":"\n\u003cp\u003eOffice365 email of this user, something like given_name.family_name@dhamma.org\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"google_email","full_name":"users[google_email]","description":"\n\u003cp\u003eGoogle email of this user\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apple_email","full_name":"users[apple_email]","description":"\n\u003cp\u003eApple email of this user\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}]}],"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]}","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]},{"code":422,"description":"Error message in format: {error: error message}","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]},{"code":401,"description":"Unauthorized - invalid or missing OAuth token","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/en/doc/api/1.0/users/update","name":"update","apis":[{"api_url":"/api/v1/users/:id/update","http_method":"POST","short_description":"Update existing user. Non-blank string fields cannot be set to blank values - such       attempts will be silently ignored and the original value will be retained.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the user to update\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"given_name","full_name":"given_name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"family_name","full_name":"family_name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"non_latin_given_name","full_name":"non_latin_given_name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"non_latin_family_name","full_name":"non_latin_family_name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"male","full_name":"male","description":"\n\u003cp\u003eGender: Wether the user is a male or female\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"birthdate","full_name":"birthdate","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"primary_country","full_name":"primary_country","description":"\n\u003cp\u003eAlpha2 code of the country where the user do most of its Vipassana activity               just give address country if you are not sure\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"old_student","full_name":"old_student","description":"\n\u003cp\u003eHas the user already completed a 10-day course?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"at_code","full_name":"at_code","description":"\n\u003cp\u003eAssistant teacher code, for example AD5, YNP, NJ\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"is_cct","full_name":"is_cct","description":"\n\u003cp\u003eIs the user an children course teacher?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"teacher_type","full_name":"teacher_type","description":"\n\u003cp\u003eType of teacher the user is. Blank if the user is not a teacher. {“unknown” =\u0026gt; “teacher or assistant teacher but VIS does not know its exact type.”, “ATT” =\u0026gt; “Assistant Teacher Trainee”, “AT” =\u0026gt; “Assistant Teacher”, “SAT” =\u0026gt; “Senior Assistant Teacher”, “T” =\u0026gt; “Teacher”, “CT” =\u0026gt; “Center Teacher”, “CAT” =\u0026gt; “Coordinating Area Teacher”, “BT” =\u0026gt; “Bhikkhu / Bhikkhuni Teacher”}.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eunknown\u003c/code\u003e, \u003ccode\u003eATT\u003c/code\u003e, \u003ccode\u003eAT\u003c/code\u003e, \u003ccode\u003eSAT\u003c/code\u003e, \u003ccode\u003eT\u003c/code\u003e, \u003ccode\u003eCT\u003c/code\u003e, \u003ccode\u003eCAT\u003c/code\u003e, \u003ccode\u003eBT\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"student_account_app","full_name":"student_account_app","description":"\n\u003cp\u003eWhich student app should be used. If not provided, it will be automatically detected               from primary_country\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003emycourses\u003c/code\u003e, \u003ccode\u003edo_student_account\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"password_required","full_name":"password_required","description":"\n\u003cp\u003eIf the user is required to setup a password (otherwise they might only sign in with               external providers such as google or office365)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"require_mfa_from_date","full_name":"require_mfa_from_date","description":"\n\u003cp\u003eDate 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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"office365_id","full_name":"office365_id","description":"\n\u003cp\u003eUID of an Office365 account linked to this user. Can be updated only if the current value is blank.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"office365_email","full_name":"office365_email","description":"\n\u003cp\u003eOffice365 email of this user, something like given_name.family_name@dhamma.org\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"google_email","full_name":"google_email","description":"\n\u003cp\u003eGoogle email of this user\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apple_email","full_name":"apple_email","description":"\n\u003cp\u003eApple email of this user\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[{"code":200,"description":"Updated user object in JSON format with the keys: id, duplicates_ids, office365_id, apple_id, google_id, apple_email, at_code, birthdate, email, family_name, given_name, google_email, is_cct, male, mobile, non_latin_family_name, non_latin_given_name, office365_email, old_student, primary_country, student_account_app, teacher_type, username, confirmed, sign_up_complete, session_info, student_account_url, mfa_set_up, is_at","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]},{"code":400,"description":"Validation error, invalid operation (e.g. a generic user record),       or an unknown / out-of-scope user id, in format: {error: error message}","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]},{"code":422,"description":"Unexpected error (e.g. repeated updates to the same user within a few seconds),       in format: {error: error message}","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]},{"code":401,"description":"Unauthorized - invalid or missing OAuth token","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/en/doc/api/1.0/users/invite","name":"invite","apis":[{"api_url":"/api/v1/users/invite","http_method":"POST","short_description":"Invite by email a user to create an account, or to join an other app if they already have an account","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"email","full_name":"email","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"username","full_name":"username","description":"\n\u003cp\u003eRequired if the email is shared accross multiple users\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"id","full_name":"id","description":"\n\u003cp\u003eVIS ID of an existing user, in case you just want to invite an existing user to a new app\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"locale","full_name":"locale","description":"\n\u003cp\u003eLocale for invitation and MFA emails (en, fr, de, hi…)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"app_name","full_name":"app_name","description":"\n\u003cp\u003eCustomize APP_NAME in following email. Default to OauthApplication name              Hello, you have been invited to APP_NAME, click link below to accept\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"invited_to_url","full_name":"invited_to_url","description":"\n\u003cp\u003eCustomize the url to redirect the user afer invitation is accepted. Default to OauthApplication home_page\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"try_to_find_existing_user","full_name":"try_to_find_existing_user","description":"\n\u003cp\u003eWhen true, the system attempts to match an existing active user before creating a new one.\u003c/p\u003e\n\n\u003cp\u003eMatching is only attempted if the request includes one of the following parameter sets:\u003c/p\u003e\n\u003cul\u003e\u003cli\u003e\n\u003cp\u003eid\u003c/p\u003e\n\u003c/li\u003e\u003cli\u003e\n\u003cp\u003eemail and username\u003c/p\u003e\n\u003c/li\u003e\u003cli\u003e\n\u003cp\u003eemail, given_name, family_name, birthdate, and male\u003c/p\u003e\n\u003c/li\u003e\u003c/ul\u003e\n\n\u003cp\u003eIf matching is attempted, all provided fields from the following list are used to search for a user: id, username, email, given_name, family_name, birthdate, male.\u003c/p\u003e\n\n\u003cp\u003eIf exactly one active user matches, that user is invited; otherwise a new user is created.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"given_name","full_name":"given_name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"family_name","full_name":"family_name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"non_latin_given_name","full_name":"non_latin_given_name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"non_latin_family_name","full_name":"non_latin_family_name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"male","full_name":"male","description":"\n\u003cp\u003eGender: Wether the user is a male or female\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"birthdate","full_name":"birthdate","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"primary_country","full_name":"primary_country","description":"\n\u003cp\u003eAlpha2 code of the country where the user do most of its Vipassana activity               just give address country if you are not sure\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"old_student","full_name":"old_student","description":"\n\u003cp\u003eHas the user already completed a 10-day course?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"at_code","full_name":"at_code","description":"\n\u003cp\u003eAssistant teacher code, for example AD5, YNP, NJ\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"is_cct","full_name":"is_cct","description":"\n\u003cp\u003eIs the user an children course teacher?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"teacher_type","full_name":"teacher_type","description":"\n\u003cp\u003eType of teacher the user is. Blank if the user is not a teacher. {“unknown” =\u0026gt; “teacher or assistant teacher but VIS does not know its exact type.”, “ATT” =\u0026gt; “Assistant Teacher Trainee”, “AT” =\u0026gt; “Assistant Teacher”, “SAT” =\u0026gt; “Senior Assistant Teacher”, “T” =\u0026gt; “Teacher”, “CT” =\u0026gt; “Center Teacher”, “CAT” =\u0026gt; “Coordinating Area Teacher”, “BT” =\u0026gt; “Bhikkhu / Bhikkhuni Teacher”}.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eunknown\u003c/code\u003e, \u003ccode\u003eATT\u003c/code\u003e, \u003ccode\u003eAT\u003c/code\u003e, \u003ccode\u003eSAT\u003c/code\u003e, \u003ccode\u003eT\u003c/code\u003e, \u003ccode\u003eCT\u003c/code\u003e, \u003ccode\u003eCAT\u003c/code\u003e, \u003ccode\u003eBT\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"student_account_app","full_name":"student_account_app","description":"\n\u003cp\u003eWhich student app should be used. If not provided, it will be automatically detected               from primary_country\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003emycourses\u003c/code\u003e, \u003ccode\u003edo_student_account\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"password_required","full_name":"password_required","description":"\n\u003cp\u003eIf the user is required to setup a password (otherwise they might only sign in with               external providers such as google or office365)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"require_mfa_from_date","full_name":"require_mfa_from_date","description":"\n\u003cp\u003eDate 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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"office365_id","full_name":"office365_id","description":"\n\u003cp\u003eUID of an Office365 account linked to this user. Can be updated only if the current value is blank.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"office365_email","full_name":"office365_email","description":"\n\u003cp\u003eOffice365 email of this user, something like given_name.family_name@dhamma.org\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"google_email","full_name":"google_email","description":"\n\u003cp\u003eGoogle email of this user\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apple_email","full_name":"apple_email","description":"\n\u003cp\u003eApple email of this user\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[{"code":200,"description":"Invitation result with success code and user object. Response format:       {invite_success_code: 'invited'|'existing_user_invited', user: user_object}","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]},{"code":422,"description":"Validation errors in format: {error: error_message}","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]},{"code":400,"description":"Error message for invalid operations (e.g., trying to invite a generic user record),       in format: {error: error_message}","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]},{"code":401,"description":"Unauthorized - invalid or missing OAuth token","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/en/doc/api/1.0/users/resend_invite","name":"resend_invite","apis":[{"api_url":"/api/v1/users/:id/resend_invite","http_method":"GET","short_description":"Resend invitation email","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"locale","full_name":"locale","description":"\n\u003cp\u003eLocale for invitation email (en, fr, de, hi…)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[{"code":200,"description":"User object in JSON format after resending invitation, with the keys: id, duplicates_ids, office365_id, apple_id, google_id, apple_email, at_code, birthdate, email, family_name, given_name, google_email, is_cct, male, mobile, non_latin_family_name, non_latin_given_name, office365_email, old_student, primary_country, student_account_app, teacher_type, username, confirmed, sign_up_complete, session_info, student_account_url, mfa_set_up, is_at","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]},{"code":422,"description":"User not found","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]},{"code":400,"description":"Error message for invalid operations (e.g., trying to resend invite to a generic user record),       in format: {error: error_message}","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]},{"code":401,"description":"Unauthorized - invalid or missing OAuth token","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/en/doc/api/1.0/users/destroy","name":"destroy","apis":[{"api_url":"/api/v1/users/:id","http_method":"DELETE","short_description":"Delete user mapping with the calling app. Delete the user entirely if it is not mapped to any other app.","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the user\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[{"code":200,"description":"Success confirmation in format: {success: true}","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]},{"code":400,"description":"Error message for invalid operations (e.g., trying to destroy a generic user record),      in format: {error: error_message}","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]},{"code":401,"description":"Unauthorized - invalid or missing OAuth token","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/en/doc/api/1.0/users/reset_totp","name":"reset_totp","apis":[{"api_url":"/api/v1/users/:id/reset_totp","http_method":"DELETE","short_description":"Reset the user's TOTP secret","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"id","full_name":"id","description":"\n\u003cp\u003eID of the user whose TOTP secret should be cleared\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[{"code":200,"description":"Updated user object in JSON format with the keys: id, duplicates_ids, office365_id, apple_id, google_id, apple_email, at_code, birthdate, email, family_name, given_name, google_email, is_cct, male, mobile, non_latin_family_name, non_latin_given_name, office365_email, old_student, primary_country, student_account_app, teacher_type, username, confirmed, sign_up_complete, session_info, student_account_url, mfa_set_up, is_at","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]},{"code":400,"description":"Error message when the TOTP secret cannot be reset,       in format: {error: error_message}","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]},{"code":401,"description":"Unauthorized - invalid or missing OAuth token","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/en/doc/api/1.0/users/me","name":"me","apis":[{"api_url":"/api/v1/me","http_method":"GET","short_description":"Get current user information","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[],"returns":[{"code":200,"description":"Current user object in JSON format with the keys: id, duplicates_ids, office365_id, apple_id, google_id, apple_email, at_code, birthdate, email, family_name, given_name, google_email, is_cct, male, mobile, non_latin_family_name, non_latin_given_name, office365_email, old_student, primary_country, student_account_app, teacher_type, username, confirmed, sign_up_complete, session_info, student_account_url, mfa_set_up, is_at","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]},{"code":401,"description":"Unauthorized - invalid or missing OAuth token","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/en/doc/api/1.0/users/find_by_credentials","name":"find_by_credentials","apis":[{"api_url":"/api/v1/users/find_by_credentials","http_method":"GET","short_description":"Find a user from its login and password","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"login","full_name":"login","description":"\n\u003cp\u003eEmail or username\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"password","full_name":"password","description":"\n\u003cp\u003eNon encrypted password\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"locale","full_name":"locale","description":"\n\u003cp\u003eLocale for email (en, fr, de, hi…)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[{"code":200,"description":"User object in JSON format when credentials are valid, with the keys: id, duplicates_ids, office365_id, apple_id, google_id, apple_email, at_code, birthdate, email, family_name, given_name, google_email, is_cct, male, mobile, non_latin_family_name, non_latin_given_name, office365_email, old_student, primary_country, student_account_app, teacher_type, username, confirmed, sign_up_complete, session_info, student_account_url, mfa_set_up, is_at","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]},{"code":400,"description":"Error message for various authentication failures (not_found, non_uniq_login, unconfirmed,       invalid_password), in format: {error: error_code}","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]},{"code":401,"description":"Unauthorized - invalid or missing OAuth token","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/en/doc/api/1.0/users/find_or_create_by_provider","name":"find_or_create_by_provider","apis":[{"api_url":"/api/v1/users/find_or_create_by_provider","http_method":"POST","short_description":"Find a user from external provider id","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"provider","full_name":"provider","description":"\n\u003cp\u003eProvider name (google, apple, office365)\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"uid","full_name":"uid","description":"\n\u003cp\u003eID of the user given by provider\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"locale","full_name":"locale","description":"\n\u003cp\u003eLocale for email (en, fr, de, hi…)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email","full_name":"email","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"mobile","full_name":"mobile","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"origin_id","full_name":"origin_id","description":"\n\u003cp\u003eID in the previous database\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"username","full_name":"username","description":"\n\u003cp\u003eusername 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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"encrypted_password","full_name":"encrypted_password","description":"\n\u003cp\u003eEncrypted 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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"custom_pepper","full_name":"custom_pepper","description":"\n\u003cp\u003eThe pepper which have been used to encrypt the password\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"google_id","full_name":"google_id","description":"\n\u003cp\u003eUID of a Google account linked to this user\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apple_id","full_name":"apple_id","description":"\n\u003cp\u003eUID of an Apple account linked to this user\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"email_confirmed","full_name":"email_confirmed","description":"\n\u003cp\u003eWether the user email have already been confirmed or not\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"given_name","full_name":"given_name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"family_name","full_name":"family_name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"non_latin_given_name","full_name":"non_latin_given_name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"non_latin_family_name","full_name":"non_latin_family_name","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"male","full_name":"male","description":"\n\u003cp\u003eGender: Wether the user is a male or female\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"birthdate","full_name":"birthdate","description":"","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"primary_country","full_name":"primary_country","description":"\n\u003cp\u003eAlpha2 code of the country where the user do most of its Vipassana activity               just give address country if you are not sure\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"old_student","full_name":"old_student","description":"\n\u003cp\u003eHas the user already completed a 10-day course?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"at_code","full_name":"at_code","description":"\n\u003cp\u003eAssistant teacher code, for example AD5, YNP, NJ\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"is_cct","full_name":"is_cct","description":"\n\u003cp\u003eIs the user an children course teacher?\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"teacher_type","full_name":"teacher_type","description":"\n\u003cp\u003eType of teacher the user is. Blank if the user is not a teacher. {“unknown” =\u0026gt; “teacher or assistant teacher but VIS does not know its exact type.”, “ATT” =\u0026gt; “Assistant Teacher Trainee”, “AT” =\u0026gt; “Assistant Teacher”, “SAT” =\u0026gt; “Senior Assistant Teacher”, “T” =\u0026gt; “Teacher”, “CT” =\u0026gt; “Center Teacher”, “CAT” =\u0026gt; “Coordinating Area Teacher”, “BT” =\u0026gt; “Bhikkhu / Bhikkhuni Teacher”}.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003eunknown\u003c/code\u003e, \u003ccode\u003eATT\u003c/code\u003e, \u003ccode\u003eAT\u003c/code\u003e, \u003ccode\u003eSAT\u003c/code\u003e, \u003ccode\u003eT\u003c/code\u003e, \u003ccode\u003eCT\u003c/code\u003e, \u003ccode\u003eCAT\u003c/code\u003e, \u003ccode\u003eBT\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"student_account_app","full_name":"student_account_app","description":"\n\u003cp\u003eWhich student app should be used. If not provided, it will be automatically detected               from primary_country\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003emycourses\u003c/code\u003e, \u003ccode\u003edo_student_account\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"password_required","full_name":"password_required","description":"\n\u003cp\u003eIf the user is required to setup a password (otherwise they might only sign in with               external providers such as google or office365)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be one of: \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e, \u003ccode\u003etrue\u003c/code\u003e, \u003ccode\u003efalse\u003c/code\u003e.","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"require_mfa_from_date","full_name":"require_mfa_from_date","description":"\n\u003cp\u003eDate 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.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"office365_id","full_name":"office365_id","description":"\n\u003cp\u003eUID of an Office365 account linked to this user. Can be updated only if the current value is blank.\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"office365_email","full_name":"office365_email","description":"\n\u003cp\u003eOffice365 email of this user, something like given_name.family_name@dhamma.org\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"google_email","full_name":"google_email","description":"\n\u003cp\u003eGoogle email of this user\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"apple_email","full_name":"apple_email","description":"\n\u003cp\u003eApple email of this user\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[{"code":200,"description":"User object in JSON format (existing or newly created), with the keys: id, duplicates_ids, office365_id, apple_id, google_id, apple_email, at_code, birthdate, email, family_name, given_name, google_email, is_cct, male, mobile, non_latin_family_name, non_latin_given_name, office365_email, old_student, primary_country, student_account_app, teacher_type, username, confirmed, sign_up_complete, session_info, student_account_url, mfa_set_up, is_at","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]},{"code":422,"description":"Validation errors when creating new user, in format:       {error: {field_name: [\"error message 1\", \"error message 2\"]}}","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]},{"code":401,"description":"Unauthorized - invalid or missing OAuth token","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/en/doc/api/1.0/users/send_password_instructions","name":"send_password_instructions","apis":[{"api_url":"/api/v1/users/send_password_instructions","http_method":"POST","short_description":"Send password reset instructions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"login","full_name":"login","description":"\n\u003cp\u003eEmail or username\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"locale","full_name":"locale","description":"\n\u003cp\u003eLocale for email (en, fr, de, hi…)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[{"code":200,"description":"Success confirmation in format: {success: true}","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]},{"code":400,"description":"Error message for various failures (not_found, non_uniq_login, or generic user),\n      in format: {error: error_message}","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]},{"code":401,"description":"Unauthorized - invalid or missing OAuth token","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true},{"doc_url":"/en/doc/api/1.0/users/send_confirmation_instructions","name":"send_confirmation_instructions","apis":[{"api_url":"/api/v1/users/send_confirmation_instructions","http_method":"POST","short_description":"Send email confirmation instructions","deprecated":null}],"formats":null,"full_description":"","errors":[],"params":[{"name":"login","full_name":"login","description":"\n\u003cp\u003eEmail or username\u003c/p\u003e\n","required":true,"allow_nil":false,"allow_blank":false,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false},{"name":"locale","full_name":"locale","description":"\n\u003cp\u003eLocale for email (en, fr, de, hi…)\u003c/p\u003e\n","required":false,"allow_nil":false,"allow_blank":true,"validator":"Must be a String","expected_type":"string","metadata":null,"show":true,"validations":[],"deprecated":false}],"returns":[{"code":200,"description":"Success confirmation in format: {success: true}","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]},{"code":400,"description":"Error message for various failures (not_found, non_uniq_login, or generic user),       in format: {error: error_message}","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]},{"code":401,"description":"Unauthorized - invalid or missing OAuth token","is_array":false,"returns_object":[],"additional_properties":false,"headers":[]}],"examples":[],"metadata":null,"see":[],"headers":[],"show":true}],"headers":null,"deprecated":null}}}}