Skip to content

Commit 1258096

Browse files
authored
update the authorized license list + fix doc for the signin_otp function (#2)
1 parent a76d544 commit 1258096

File tree

2 files changed

+15
-2
lines changed

2 files changed

+15
-2
lines changed

descope/auth.py

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -247,7 +247,19 @@ def sign_up_otp(
247247

248248
def sign_in_otp(self, method: DeliveryMethod, identifier: str) -> None:
249249
"""
250-
DOC
250+
Sign in a user by OTP
251+
252+
Args:
253+
method (DeliveryMethod): The OTP method you would like to verify the code
254+
sent to you (by the same delivery method)
255+
256+
identifier (str): The identifier based on the chosen delivery method,
257+
For email it should be the email address.
258+
For phone it should be the phone number you would like to get the code
259+
For whatsapp it should be the phone number you would like to get the code
260+
261+
Raise:
262+
AuthException: for any case sign up by otp operation failed
251263
"""
252264

253265
if not self._verify_delivery_method(method, identifier):

liccheck.ini

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,12 +17,13 @@ authorized_licenses:
1717
mit license
1818
python software foundation
1919
python software foundation license
20-
zpl 2.1
20+
2121

2222
unauthorized_licenses:
2323
gpl v3
2424
gnu lgpl
2525
lgpl with exceptions or zpl
26+
zpl 2.1
2627

2728
[Authorized Packages]
2829
# Apache-2.0 license

0 commit comments

Comments
 (0)