Skip to content

Commit e91d91e

Browse files
dorshaclaude
andauthored
docs: remove_recovery_codes accepts login ID or user ID (#1649)
Co-authored-by: Claude Fable 5 <noreply@anthropic.com>
1 parent f1816a7 commit e91d91e

3 files changed

Lines changed: 5 additions & 5 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -306,7 +306,7 @@ response = descope_client.mgmt.user.remove_totp_seed(login_id=login_id)
306306

307307
#### Deleting Recovery Codes
308308

309-
Pass the loginId to the function to revoke all of the user's recovery codes.
309+
Pass the user's login ID or user ID to the function to revoke all of the user's recovery codes.
310310

311311
```python
312312
response = descope_client.mgmt.user.remove_recovery_codes(login_id=login_id)

descope/management/user.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1585,10 +1585,10 @@ def remove_recovery_codes(
15851585
login_id: str,
15861586
) -> None:
15871587
"""
1588-
Removes all recovery codes for the user with the given login ID.
1588+
Removes all recovery codes for the user with the given login ID or user ID.
15891589
15901590
Args:
1591-
login_id (str): The login ID of the user to remove recovery codes for.
1591+
login_id (str): The login ID or user ID of the user to remove recovery codes for.
15921592
15931593
Raise:
15941594
AuthException: raised if the operation fails

descope/management/user_async.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1591,10 +1591,10 @@ async def remove_recovery_codes(
15911591
login_id: str,
15921592
) -> None:
15931593
"""
1594-
Removes all recovery codes for the user with the given login ID.
1594+
Removes all recovery codes for the user with the given login ID or user ID.
15951595
15961596
Args:
1597-
login_id (str): The login ID of the user to remove recovery codes for.
1597+
login_id (str): The login ID or user ID of the user to remove recovery codes for.
15981598
15991599
Raise:
16001600
AuthException: raised if the operation fails

0 commit comments

Comments
 (0)