# Authentication ## POST /auth/login > Login ```json {"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"servers":[{"url":"https://dev-doc-test-ckd2c9h9gad9asa0.centralindia-01.azurewebsites.net","description":"Development API Server"}],"paths":{"/auth/login":{"post":{"tags":["Authentication"],"summary":"Login","operationId":"login_auth_login_post","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/Body_login_auth_login_post"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginOutputWithRedirectDict"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Body_login_auth_login_post":{"properties":{"grant_type":{"anyOf":[{"type":"string","pattern":"^password$"},{"type":"null"}],"title":"Grant Type"},"username":{"type":"string","title":"Username"},"password":{"type":"string","title":"Password"},"scope":{"type":"string","title":"Scope","default":""},"client_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Id"},"client_secret":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Secret"}},"type":"object","required":["username","password"],"title":"Body_login_auth_login_post"},"LoginOutputWithRedirectDict":{"properties":{"message":{"type":"string","title":"Message"},"access_token":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Access Token"},"refresh_token":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Refresh Token"},"token_type":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Token Type"},"data":{"$ref":"#/components/schemas/BaseUserOutput"},"redirect_to":{"type":"string","title":"Redirect To"},"password_change_required":{"type":"boolean","title":"Password Change Required"}},"type":"object","required":["message","data","redirect_to","password_change_required"],"title":"LoginOutputWithRedirectDict"},"BaseUserOutput":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"email":{"type":"string","format":"email","title":"Email"},"name":{"type":"string","title":"Name"},"user_role":{"type":"string","title":"User Role"},"email_verified":{"type":"boolean","title":"Email Verified"},"onboarding_step1_completed":{"type":"boolean","title":"Onboarding Step1 Completed"},"onboarding_step2_completed":{"type":"boolean","title":"Onboarding Step2 Completed"},"onboarding_step3_completed":{"type":"boolean","title":"Onboarding Step3 Completed"},"account_type":{"type":"string","title":"Account Type"},"phone":{"type":"string","title":"Phone"},"timezone":{"type":"string","title":"Timezone"},"job_profile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Job Profile"},"profile_image":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Image"},"tenants":{"anyOf":[{"$ref":"#/components/schemas/TenantOutputDict"},{"type":"null"}]},"is_temp_password":{"type":"boolean","title":"Is Temp Password"},"password_change_required":{"type":"boolean","title":"Password Change Required"}},"type":"object","required":["id","email","name","user_role","email_verified","onboarding_step1_completed","onboarding_step2_completed","onboarding_step3_completed","account_type","phone","timezone","profile_image","is_temp_password","password_change_required"],"title":"BaseUserOutput"},"TenantOutputDict":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"org_id":{"type":"string","title":"Org Id"},"industry":{"type":"string","title":"Industry"},"team_size":{"type":"string","title":"Team Size"},"plans":{"anyOf":[{"$ref":"#/components/schemas/PlanOutputDict"},{"type":"null"}]},"credits":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits"},"used_credits":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Used Credits"}},"type":"object","required":["id","name","org_id","industry","team_size"],"title":"TenantOutputDict"},"PlanOutputDict":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"offerings":{"items":{},"type":"array","title":"Offerings"},"credits":{"type":"integer","title":"Credits"},"price":{"type":"number","title":"Price"},"billing_cycle":{"type":"string","title":"Billing Cycle"}},"type":"object","required":["id","name","offerings","credits","price","billing_cycle"],"title":"PlanOutputDict"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}} ``` ## POST /auth/register/step/1 > Register ```json {"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"servers":[{"url":"https://dev-doc-test-ckd2c9h9gad9asa0.centralindia-01.azurewebsites.net","description":"Development API Server"}],"paths":{"/auth/register/step/1":{"post":{"tags":["Authentication"],"summary":"Register","operationId":"register_auth_register_step_1_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistrationStep1InputDict"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LoginOutputDict"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"RegistrationStep1InputDict":{"properties":{"name":{"type":"string","title":"Name"},"email":{"type":"string","format":"email","title":"Email"},"password":{"type":"string","title":"Password"},"phone":{"type":"string","format":"phone","title":"Phone"}},"type":"object","required":["name","email","password","phone"],"title":"RegistrationStep1InputDict"},"LoginOutputDict":{"properties":{"status":{"type":"integer","title":"Status","default":200},"message":{"type":"string","title":"Message"},"access_token":{"type":"string","title":"Access Token"},"refresh_token":{"type":"string","title":"Refresh Token"},"token_type":{"$ref":"#/components/schemas/TokenType"},"data":{"$ref":"#/components/schemas/BaseUserOutput"}},"type":"object","required":["message","access_token","refresh_token","token_type","data"],"title":"LoginOutputDict"},"TokenType":{"type":"string","enum":["access_token","refresh_token","password_reset_token","bearer"],"title":"TokenType"},"BaseUserOutput":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"email":{"type":"string","format":"email","title":"Email"},"name":{"type":"string","title":"Name"},"user_role":{"type":"string","title":"User Role"},"email_verified":{"type":"boolean","title":"Email Verified"},"onboarding_step1_completed":{"type":"boolean","title":"Onboarding Step1 Completed"},"onboarding_step2_completed":{"type":"boolean","title":"Onboarding Step2 Completed"},"onboarding_step3_completed":{"type":"boolean","title":"Onboarding Step3 Completed"},"account_type":{"type":"string","title":"Account Type"},"phone":{"type":"string","title":"Phone"},"timezone":{"type":"string","title":"Timezone"},"job_profile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Job Profile"},"profile_image":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Image"},"tenants":{"anyOf":[{"$ref":"#/components/schemas/TenantOutputDict"},{"type":"null"}]},"is_temp_password":{"type":"boolean","title":"Is Temp Password"},"password_change_required":{"type":"boolean","title":"Password Change Required"}},"type":"object","required":["id","email","name","user_role","email_verified","onboarding_step1_completed","onboarding_step2_completed","onboarding_step3_completed","account_type","phone","timezone","profile_image","is_temp_password","password_change_required"],"title":"BaseUserOutput"},"TenantOutputDict":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"org_id":{"type":"string","title":"Org Id"},"industry":{"type":"string","title":"Industry"},"team_size":{"type":"string","title":"Team Size"},"plans":{"anyOf":[{"$ref":"#/components/schemas/PlanOutputDict"},{"type":"null"}]},"credits":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits"},"used_credits":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Used Credits"}},"type":"object","required":["id","name","org_id","industry","team_size"],"title":"TenantOutputDict"},"PlanOutputDict":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"offerings":{"items":{},"type":"array","title":"Offerings"},"credits":{"type":"integer","title":"Credits"},"price":{"type":"number","title":"Price"},"billing_cycle":{"type":"string","title":"Billing Cycle"}},"type":"object","required":["id","name","offerings","credits","price","billing_cycle"],"title":"PlanOutputDict"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}} ``` ## POST /auth/register/step/2 > Register ```json {"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"servers":[{"url":"https://dev-doc-test-ckd2c9h9gad9asa0.centralindia-01.azurewebsites.net","description":"Development API Server"}],"security":[{"OAuth2PasswordBearer":[]}],"components":{"securitySchemes":{"OAuth2PasswordBearer":{"type":"oauth2","flows":{"password":{"scopes":{},"tokenUrl":"/auth/login"}}}},"schemas":{"RegistrationStep2InputDict":{"properties":{"organization_name":{"type":"string","title":"Organization Name"},"industry":{"type":"string","title":"Industry"},"team_size":{"type":"string","title":"Team Size"},"org_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Org Code"}},"type":"object","required":["organization_name","industry","team_size"],"title":"RegistrationStep2InputDict"},"BaseUserOutput":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"email":{"type":"string","format":"email","title":"Email"},"name":{"type":"string","title":"Name"},"user_role":{"type":"string","title":"User Role"},"email_verified":{"type":"boolean","title":"Email Verified"},"onboarding_step1_completed":{"type":"boolean","title":"Onboarding Step1 Completed"},"onboarding_step2_completed":{"type":"boolean","title":"Onboarding Step2 Completed"},"onboarding_step3_completed":{"type":"boolean","title":"Onboarding Step3 Completed"},"account_type":{"type":"string","title":"Account Type"},"phone":{"type":"string","title":"Phone"},"timezone":{"type":"string","title":"Timezone"},"job_profile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Job Profile"},"profile_image":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Image"},"tenants":{"anyOf":[{"$ref":"#/components/schemas/TenantOutputDict"},{"type":"null"}]},"is_temp_password":{"type":"boolean","title":"Is Temp Password"},"password_change_required":{"type":"boolean","title":"Password Change Required"}},"type":"object","required":["id","email","name","user_role","email_verified","onboarding_step1_completed","onboarding_step2_completed","onboarding_step3_completed","account_type","phone","timezone","profile_image","is_temp_password","password_change_required"],"title":"BaseUserOutput"},"TenantOutputDict":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"org_id":{"type":"string","title":"Org Id"},"industry":{"type":"string","title":"Industry"},"team_size":{"type":"string","title":"Team Size"},"plans":{"anyOf":[{"$ref":"#/components/schemas/PlanOutputDict"},{"type":"null"}]},"credits":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits"},"used_credits":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Used Credits"}},"type":"object","required":["id","name","org_id","industry","team_size"],"title":"TenantOutputDict"},"PlanOutputDict":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"offerings":{"items":{},"type":"array","title":"Offerings"},"credits":{"type":"integer","title":"Credits"},"price":{"type":"number","title":"Price"},"billing_cycle":{"type":"string","title":"Billing Cycle"}},"type":"object","required":["id","name","offerings","credits","price","billing_cycle"],"title":"PlanOutputDict"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/auth/register/step/2":{"post":{"tags":["Authentication"],"summary":"Register","operationId":"register_auth_register_step_2_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistrationStep2InputDict"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseUserOutput"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}} ``` ## POST /auth/register/step/3 > Register ```json {"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"servers":[{"url":"https://dev-doc-test-ckd2c9h9gad9asa0.centralindia-01.azurewebsites.net","description":"Development API Server"}],"security":[{"OAuth2PasswordBearer":[]}],"components":{"securitySchemes":{"OAuth2PasswordBearer":{"type":"oauth2","flows":{"password":{"scopes":{},"tokenUrl":"/auth/login"}}}},"schemas":{"RegistrationStep3InputDict":{"properties":{"plan_id":{"type":"string","format":"uuid","title":"Plan Id"}},"type":"object","required":["plan_id"],"title":"RegistrationStep3InputDict"},"BaseUserOutput":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"email":{"type":"string","format":"email","title":"Email"},"name":{"type":"string","title":"Name"},"user_role":{"type":"string","title":"User Role"},"email_verified":{"type":"boolean","title":"Email Verified"},"onboarding_step1_completed":{"type":"boolean","title":"Onboarding Step1 Completed"},"onboarding_step2_completed":{"type":"boolean","title":"Onboarding Step2 Completed"},"onboarding_step3_completed":{"type":"boolean","title":"Onboarding Step3 Completed"},"account_type":{"type":"string","title":"Account Type"},"phone":{"type":"string","title":"Phone"},"timezone":{"type":"string","title":"Timezone"},"job_profile":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Job Profile"},"profile_image":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Profile Image"},"tenants":{"anyOf":[{"$ref":"#/components/schemas/TenantOutputDict"},{"type":"null"}]},"is_temp_password":{"type":"boolean","title":"Is Temp Password"},"password_change_required":{"type":"boolean","title":"Password Change Required"}},"type":"object","required":["id","email","name","user_role","email_verified","onboarding_step1_completed","onboarding_step2_completed","onboarding_step3_completed","account_type","phone","timezone","profile_image","is_temp_password","password_change_required"],"title":"BaseUserOutput"},"TenantOutputDict":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"org_id":{"type":"string","title":"Org Id"},"industry":{"type":"string","title":"Industry"},"team_size":{"type":"string","title":"Team Size"},"plans":{"anyOf":[{"$ref":"#/components/schemas/PlanOutputDict"},{"type":"null"}]},"credits":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Credits"},"used_credits":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Used Credits"}},"type":"object","required":["id","name","org_id","industry","team_size"],"title":"TenantOutputDict"},"PlanOutputDict":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"name":{"type":"string","title":"Name"},"offerings":{"items":{},"type":"array","title":"Offerings"},"credits":{"type":"integer","title":"Credits"},"price":{"type":"number","title":"Price"},"billing_cycle":{"type":"string","title":"Billing Cycle"}},"type":"object","required":["id","name","offerings","credits","price","billing_cycle"],"title":"PlanOutputDict"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/auth/register/step/3":{"post":{"tags":["Authentication"],"summary":"Register","operationId":"register_auth_register_step_3_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RegistrationStep3InputDict"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BaseUserOutput"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}} ``` ## GET /auth/logout > Logout ```json {"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"servers":[{"url":"https://dev-doc-test-ckd2c9h9gad9asa0.centralindia-01.azurewebsites.net","description":"Development API Server"}],"paths":{"/auth/logout":{"get":{"tags":["Authentication"],"summary":"Logout","operationId":"logout_auth_logout_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}}}} ``` ## POST /auth/refresh > Refresh ```json {"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"servers":[{"url":"https://dev-doc-test-ckd2c9h9gad9asa0.centralindia-01.azurewebsites.net","description":"Development API Server"}],"paths":{"/auth/refresh":{"post":{"tags":["Authentication"],"summary":"Refresh","operationId":"refresh_auth_refresh_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefreshTokenInputDict"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefreshTokenOutputDict"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"RefreshTokenInputDict":{"properties":{"token":{"type":"string","title":"Token"}},"type":"object","required":["token"],"title":"RefreshTokenInputDict"},"RefreshTokenOutputDict":{"properties":{"access_token":{"type":"string","title":"Access Token"},"refresh_token":{"type":"string","title":"Refresh Token"},"token_type":{"$ref":"#/components/schemas/TokenType"}},"type":"object","required":["access_token","refresh_token","token_type"],"title":"RefreshTokenOutputDict"},"TokenType":{"type":"string","enum":["access_token","refresh_token","password_reset_token","bearer"],"title":"TokenType"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}} ``` ## GET /auth/send\_otp > Send Otp ```json {"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"servers":[{"url":"https://dev-doc-test-ckd2c9h9gad9asa0.centralindia-01.azurewebsites.net","description":"Development API Server"}],"security":[{"OAuth2PasswordBearer":[]}],"components":{"securitySchemes":{"OAuth2PasswordBearer":{"type":"oauth2","flows":{"password":{"scopes":{},"tokenUrl":"/auth/login"}}}},"schemas":{"ResendErrorOut":{"properties":{"status":{"type":"integer","title":"Status","default":200},"message":{"type":"string","title":"Message"},"resend_timer":{"type":"integer","title":"Resend Timer"}},"type":"object","required":["message","resend_timer"],"title":"ResendErrorOut"}}},"paths":{"/auth/send_otp":{"get":{"tags":["Authentication"],"summary":"Send Otp","operationId":"send_otp_auth_send_otp_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ResendErrorOut"}}}}}}}}} ``` ## POST /auth/verify\_otp > Verify Otp ```json {"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"servers":[{"url":"https://dev-doc-test-ckd2c9h9gad9asa0.centralindia-01.azurewebsites.net","description":"Development API Server"}],"security":[{"OAuth2PasswordBearer":[]}],"components":{"securitySchemes":{"OAuth2PasswordBearer":{"type":"oauth2","flows":{"password":{"scopes":{},"tokenUrl":"/auth/login"}}}},"schemas":{"VerifyOtp":{"properties":{"otp":{"type":"string","title":"Otp"}},"type":"object","required":["otp"],"title":"VerifyOtp"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/auth/verify_otp":{"post":{"tags":["Authentication"],"summary":"Verify Otp","operationId":"verify_otp_auth_verify_otp_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/VerifyOtp"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}} ``` ## POST /auth/forgot\_password > Forgot Password ```json {"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"servers":[{"url":"https://dev-doc-test-ckd2c9h9gad9asa0.centralindia-01.azurewebsites.net","description":"Development API Server"}],"paths":{"/auth/forgot_password":{"post":{"tags":["Authentication"],"summary":"Forgot Password","operationId":"forgot_password_auth_forgot_password_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForgotPasswordInputDict"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"ForgotPasswordInputDict":{"properties":{"email":{"type":"string","format":"email","title":"Email"}},"type":"object","required":["email"],"title":"ForgotPasswordInputDict"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}} ``` ## POST /auth/reset\_password > Reset Password ```json {"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"servers":[{"url":"https://dev-doc-test-ckd2c9h9gad9asa0.centralindia-01.azurewebsites.net","description":"Development API Server"}],"paths":{"/auth/reset_password":{"post":{"tags":["Authentication"],"summary":"Reset Password","operationId":"reset_password_auth_reset_password_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForgetPassword"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"ForgetPassword":{"properties":{"token":{"type":"string","title":"Token"},"new_password":{"type":"string","title":"New Password"}},"type":"object","required":["token","new_password"],"title":"ForgetPassword"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}} ``` ## POST /auth/change\_email > Change Email ```json {"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"servers":[{"url":"https://dev-doc-test-ckd2c9h9gad9asa0.centralindia-01.azurewebsites.net","description":"Development API Server"}],"security":[{"OAuth2PasswordBearer":[]}],"components":{"securitySchemes":{"OAuth2PasswordBearer":{"type":"oauth2","flows":{"password":{"scopes":{},"tokenUrl":"/auth/login"}}}},"schemas":{"ChangeEmail":{"properties":{"email":{"type":"string","format":"email","title":"Email"}},"type":"object","required":["email"],"title":"ChangeEmail"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/auth/change_email":{"post":{"tags":["Authentication"],"summary":"Change Email","operationId":"change_email_auth_change_email_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeEmail"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}} ``` ## POST /auth/set-password > Set Password ```json {"openapi":"3.1.0","info":{"title":"FastAPI","version":"0.1.0"},"servers":[{"url":"https://dev-doc-test-ckd2c9h9gad9asa0.centralindia-01.azurewebsites.net","description":"Development API Server"}],"security":[{"OAuth2PasswordBearer":[]}],"components":{"securitySchemes":{"OAuth2PasswordBearer":{"type":"oauth2","flows":{"password":{"scopes":{},"tokenUrl":"/auth/login"}}}},"schemas":{"SetPasswordInputDict":{"properties":{"new_password":{"type":"string","title":"New Password"},"confirm_password":{"type":"string","title":"Confirm Password"}},"type":"object","required":["new_password","confirm_password"],"title":"SetPasswordInputDict"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}},"paths":{"/auth/set-password":{"post":{"tags":["Authentication"],"summary":"Set Password","operationId":"set_password_auth_set_password_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetPasswordInputDict"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://motionmodexys.gitbook.io/hello/authentication.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.