Skip to content

Commit dfe28bc

Browse files
author
LoginRadius
committed
Update README.md
1 parent ef4288c commit dfe28bc

1 file changed

Lines changed: 25 additions & 24 deletions

File tree

‎README.md‎

Lines changed: 25 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -149,7 +149,7 @@ fields = "<fields>" #Optional
149149
null_support = "True" #Optional
150150
sms_template = "<sms_template>" #Optional
151151
verification_url = "<verification_url>" #Optional
152-
is_voice_otp = "True" #Optional
152+
is_voice_otp = "False" #Optional
153153
options = "<options>" #Optional
154154

155155
result = loginradius.authentication.update_profile_by_access_token(access_token, user_profile_update_model, email_template, fields, null_support, sms_template, verification_url, is_voice_otp, options)
@@ -476,7 +476,7 @@ fields = "<fields>" #Optional
476476
options = "<options>" #Optional
477477
verification_url = "<verification_url>" #Optional
478478
welcome_email_template = "<welcome_email_template>" #Optional
479-
is_voice_otp = "True" #Optional
479+
is_voice_otp = "False" #Optional
480480

481481
result = loginradius.authentication.user_registration_by_email(auth_user_registration_model, sott, email_template, fields, options, verification_url, welcome_email_template, is_voice_otp)
482482
```
@@ -506,7 +506,7 @@ options = "<options>" #Optional
506506
sms_template = "<sms_template>" #Optional
507507
verification_url = "<verification_url>" #Optional
508508
welcome_email_template = "<welcome_email_template>" #Optional
509-
is_voice_otp = "True" #Optional
509+
is_voice_otp = "False" #Optional
510510

511511
result = loginradius.authentication.user_registration_by_captcha(auth_user_registration_model_with_captcha, email_template, fields, options, sms_template, verification_url, welcome_email_template, is_voice_otp)
512512
```
@@ -921,7 +921,7 @@ result = loginradius.account.invalidate_account_email_verification(uid, email_te
921921

922922
uid = "<uid>" #Required
923923
sms_template = "<sms_template>" #Optional
924-
is_voice_otp = "True" #Optional
924+
is_voice_otp = "False" #Optional
925925

926926
result = loginradius.account.reset_phone_id_verification_by_uid(uid, sms_template, is_voice_otp)
927927
```
@@ -1607,7 +1607,7 @@ otp = "<otp>" #Required
16071607
phone = "<phone>" #Required
16081608
fields = "<fields>" #Optional
16091609
sms_template = "<sms_template>" #Optional
1610-
is_voice_otp = "True" #Optional
1610+
is_voice_otp = "False" #Optional
16111611

16121612
result = loginradius.phone_authentication.phone_verification_by_otp(otp, phone, fields, sms_template, is_voice_otp)
16131613
```
@@ -1624,7 +1624,7 @@ result = loginradius.phone_authentication.phone_verification_by_otp(otp, phone,
16241624
access_token = "<access_token>" #Required
16251625
otp = "<otp>" #Required
16261626
sms_template = "<sms_template>" #Optional
1627-
is_voice_otp = "True" #Optional
1627+
is_voice_otp = "False" #Optional
16281628

16291629
result = loginradius.phone_authentication.phone_verification_otp_by_access_token(access_token, otp, sms_template, is_voice_otp)
16301630
```
@@ -1641,7 +1641,7 @@ result = loginradius.phone_authentication.phone_verification_otp_by_access_token
16411641
access_token = "<access_token>" #Required
16421642
phone = "<phone>" #Required
16431643
sms_template = "<sms_template>" #Optional
1644-
is_voice_otp = "True" #Optional
1644+
is_voice_otp = "False" #Optional
16451645
result = loginradius.phone_authentication.update_phone_number(access_token, phone, sms_template,is_voice_otp)
16461646
```
16471647

@@ -1676,7 +1676,7 @@ result = loginradius.phone_authentication.login_by_phone(phone_authentication_mo
16761676

16771677
phone = "<phone>" #Required
16781678
sms_template = "<sms_template>" #Optional
1679-
is_voice_otp = "True" #Optional
1679+
is_voice_otp = "False" #Optional
16801680

16811681
result = loginradius.phone_authentication.forgot_password_by_phone_otp(phone, sms_template, is_voice_otp)
16821682
```
@@ -1692,7 +1692,7 @@ result = loginradius.phone_authentication.forgot_password_by_phone_otp(phone, sm
16921692

16931693
phone = "<phone>" #Required
16941694
sms_template = "<sms_template>" #Optional
1695-
is_voice_otp = "True" #Optional
1695+
is_voice_otp = "False" #Optional
16961696

16971697
result = loginradius.phone_authentication.phone_resend_verification_otp(phone, sms_template, is_voice_otp)
16981698
```
@@ -1739,7 +1739,7 @@ sms_template = "<sms_template>" #Optional
17391739
verification_url = "<verification_url>" #Optional
17401740
welcome_email_template = "<welcome_email_template>" #Optional
17411741
email_template = "<email_template>" #Optional
1742-
is_voice_otp = "True" #Optional
1742+
is_voice_otp = "False" #Optional
17431743

17441744
result = loginradius.phone_authentication.user_registration_by_phone(auth_user_registration_model, sott, fields, options, sms_template, verification_url, welcome_email_template,email_template, is_voice_otp)
17451745
```
@@ -1844,7 +1844,7 @@ result = loginradius.mfa.mfa_update_setting(access_token, multi_factor_auth_mode
18441844
access_token = "<access_token>" #Required
18451845
phone_no2_f_a = "<phone_no2_f_a>" #Required
18461846
sms_template2_f_a = "<sms_template2_f_a>" #Optional
1847-
is_voice_otp = "True" #Optional
1847+
is_voice_otp = "False" #Optional
18481848
options = "<options>" #Optional
18491849

18501850
result = loginradius.mfa.mfa_update_phone_number_by_token(access_token, phone_no2_f_a, sms_template2_f_a, is_voice_otp,options)
@@ -1948,7 +1948,7 @@ result = loginradius.mfa.mfa_validate_backup_code(multi_factor_auth_model_by_bac
19481948
phone_no2_f_a = "<phone_no2_f_a>" #Required
19491949
second_factor_authentication_token = "<second_factor_authentication_token>" #Required
19501950
sms_template2_f_a = "<sms_template2_f_a>" #Optional
1951-
is_voice_otp = "True" #Optional
1951+
is_voice_otp = "False" #Optional
19521952
options = "<options>" #Optional
19531953

19541954
result = loginradius.mfa.mfa_update_phone_number(phone_no2_f_a, second_factor_authentication_token, sms_template2_f_a, is_voice_otp, options)
@@ -2048,7 +2048,7 @@ sms_template = "<sms_template>" #Optional
20482048
sms_template2_f_a = "<sms_template2_f_a>" #Optional
20492049
verification_url = "<verification_url>" #Optional
20502050
email_template2_f_a = "<email_template2_f_a>" #Optional
2051-
is_voice_otp = "True" #Optional
2051+
is_voice_otp = "False" #Optional
20522052
options = "<options>" #Optional
20532053

20542054
result = loginradius.mfa.mfa_login_by_email(email, password, email_template, fields, login_url, sms_template, sms_template2_f_a, verification_url,email_template2_f_a, is_voice_otp,options)
@@ -2072,7 +2072,7 @@ sms_template = "<sms_template>" #Optional
20722072
sms_template2_f_a = "<sms_template2_f_a>" #Optional
20732073
verification_url = "<verification_url>" #Optional
20742074
email_template2_f_a = "<email_template2_f_a>" #Optional
2075-
is_voice_otp = "True" #Optional
2075+
is_voice_otp = "False" #Optional
20762076

20772077
result = loginradius.mfa.mfa_login_by_user_name(password, username, email_template, fields, login_url, sms_template, sms_template2_f_a, verification_url,email_template2_f_a, is_voice_otp)
20782078
```
@@ -2095,7 +2095,7 @@ sms_template = "<sms_template>" #Optional
20952095
sms_template2_f_a = "<sms_template2_f_a>" #Optional
20962096
verification_url = "<verification_url>" #Optional
20972097
email_template2_f_a = "<email_template2_f_a>" #Optional
2098-
is_voice_otp = "True" #Optional
2098+
is_voice_otp = "False" #Optional
20992099
options = "<options>" #Optional
21002100

21012101
result = loginradius.mfa.mfa_login_by_phone(password, phone, email_template, fields, login_url, sms_template, sms_template2_f_a, verification_url,email_template2_f_a, is_voice_otp, options)
@@ -2155,7 +2155,7 @@ result = loginradius.mfa.mfa_security_question_answer_verification(security_ques
21552155
```py
21562156

21572157
access_token = "<access_token>" #Required
2158-
is_voice_otp = "True" #Optional
2158+
is_voice_otp = "False" #Optional
21592159

21602160
result = loginradius.mfa.mfa_configure_by_access_token(access_token, is_voice_otp)
21612161
```
@@ -2215,7 +2215,7 @@ result = loginradius.mfa.mfa_email_otp_by_access_token(access_token, email_id, e
22152215

22162216
second_factor_authentication_token = "<second_factor_authentication_token>" #Required
22172217
sms_template2_f_a = "<sms_template2_f_a>" #Optional
2218-
is_voice_otp = "True" #Optional
2218+
is_voice_otp = "False" #Optional
22192219

22202220
result = loginradius.mfa.mfa_resend_otp(second_factor_authentication_token, sms_template2_f_a, is_voice_otp)
22212221
```
@@ -2252,7 +2252,7 @@ result = loginradius.mfa.mfa_reset_backup_code_by_uid(uid)
22522252

22532253
<h6 id="MFAResetAuthenticatorByToken-delete-"> MFA Reset Authenticator by Token (DELETE)</h6>
22542254

2255-
This API Resets the Authenticator configurations on a given account via the access_token. [More Info](/api/v2/customer-identity-api/multi-factor-authentication/google-authenticator/mfa-reset-authenticator-by-token/)
2255+
This API Resets the Authenticator configurations on a given account via the access_token. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/multi-factor-authentication/google-authenticator/mfa-reset-authenticator-by-token/)
22562256

22572257
```py
22582258

@@ -2593,7 +2593,7 @@ forgot_pin_otp_by_phone_model = {
25932593
"phone" : "<phone>"
25942594
} #Required
25952595
sms_template = "<sms_template>" #Optional
2596-
is_voice_otp = "True" #Optional
2596+
is_voice_otp = "False" #Optional
25972597

25982598
result = loginradius.pin_authentication.send_forgot_pin_sms_by_phone(forgot_pin_otp_by_phone_model, sms_template, is_voice_otp)
25992599
```
@@ -2837,7 +2837,7 @@ result = loginradius.re_authentication.re_auth_by_security_question(access_token
28372837

28382838
access_token = "<access_token>" #Required
28392839
sms_template2_f_a = "<sms_template2_f_a>" #Optional
2840-
is_voice_otp = "True" #Optional
2840+
is_voice_otp = "False" #Optional
28412841

28422842
result = loginradius.re_authentication.mfa_re_authenticate(access_token, sms_template2_f_a, is_voice_otp)
28432843
```
@@ -3133,7 +3133,7 @@ one_touch_login_by_phone_model = {
31333133
"phone" : "<phone>"
31343134
} #Required
31353135
sms_template = "<sms_template>" #Optional
3136-
is_voice_otp = "True" #Optional
3136+
is_voice_otp = "False" #Optional
31373137

31383138
result = loginradius.one_touch_login.one_touch_login_by_phone(one_touch_login_by_phone_model, sms_template, is_voice_otp)
31393139
```
@@ -3201,7 +3201,7 @@ password_less_login_otp_model = {
32013201
} #Required
32023202
fields = "<fields>" #Optional
32033203
sms_template = "<sms_template>" #Optional
3204-
is_voice_otp = "True" #Optional
3204+
is_voice_otp = "False" #Optional
32053205

32063206
result = loginradius.password_less_login.passwordless_login_phone_verification(password_less_login_otp_model, fields, sms_template, is_voice_otp)
32073207
```
@@ -3251,7 +3251,7 @@ result = loginradius.password_less_login.passwordless_login_verification_by_user
32513251

32523252
phone = "<phone>" #Required
32533253
sms_template = "<sms_template>" #Optional
3254-
is_voice_otp = "True" #Optional
3254+
is_voice_otp = "False" #Optional
32553255

32563256
result = loginradius.password_less_login.passwordless_login_by_phone(phone, sms_template, is_voice_otp)
32573257
```
@@ -3754,7 +3754,8 @@ List of APIs in this Section:<br>
37543754

37553755

37563756
<h6 id="AccessTokenViaCustomJWTToken-get-"> Get Access Token via Custom JWT Token (GET)</h6>
3757-
This API is used to retrieve a LoginRadius access token by passing in a valid custom JWT token. [More Info](/api/v2/customer-identity-api/social-login/native-social-login-api/access-token-by-custom-jwt-token/)
3757+
3758+
This API is used to retrieve a LoginRadius access token by passing in a valid custom JWT token. [More Info](https://www.loginradius.com/docs/api/v2/customer-identity-api/social-login/native-social-login-api/access-token-by-custom-jwt-token/)
37583759

37593760
```py
37603761

0 commit comments

Comments
 (0)