Skip to content

Commit 66dfc53

Browse files
committed
Add docs
1 parent 60b88f2 commit 66dfc53

File tree

2 files changed

+49
-4
lines changed

2 files changed

+49
-4
lines changed

README.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1052,6 +1052,30 @@ updated_jwt = descope_client.mgmt.jwt.update_jwt(
10521052
)
10531053
```
10541054

1055+
Generate a JWT for a user, simulating a signin request.
1056+
1057+
```python
1058+
jwt_response = descope_client.mgmt.jwt.sign_in(
1059+
login_id="dummy"
1060+
)
1061+
```
1062+
1063+
Generate a JWT for a user, simulating a signup request.
1064+
1065+
```python
1066+
jwt_response = descope_client.mgmt.jwt.sign_up(
1067+
login_id="dummy"
1068+
)
1069+
```
1070+
1071+
Generate a JWT for a user, simulating a signup or in request.
1072+
1073+
```python
1074+
jwt_response = descope_client.mgmt.jwt.sign_up_or_in(
1075+
login_id="dummy"
1076+
)
1077+
```
1078+
10551079
### Impersonate
10561080

10571081
You can impersonate to another user

descope/management/jwt.py

Lines changed: 25 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,14 @@ def impersonate(
8888
def sign_in(
8989
self, login_id: str, login_options: Optional[MgmtLoginOptions] = None
9090
) -> dict:
91-
""" """
91+
"""
92+
Generate a JWT for a user, simulating a signin request.
93+
94+
Args:
95+
login_id (str): login id of the user.
96+
login_options (MgmtLoginOptions): options for the login request.
97+
"""
98+
9299
if not login_id:
93100
raise AuthException(
94101
400, ERROR_TYPE_INVALID_ARGUMENT, "login_id cannot be empty"
@@ -122,7 +129,15 @@ def sign_up(
122129
user: Optional[MgmtUserRequest] = None,
123130
signup_options: Optional[MgmtSignUpOptions] = None,
124131
) -> dict:
125-
""" """
132+
"""
133+
Generate a JWT for a user, simulating a signup request.
134+
135+
Args:
136+
login_id (str): login id of the user.
137+
user (MgmtUserRequest): user details.
138+
signup_options (MgmtSignUpOptions): signup options.
139+
"""
140+
126141
return self._sign_up_internal(
127142
login_id, MgmtV1.mgmt_sign_up, user, signup_options
128143
)
@@ -133,7 +148,14 @@ def sign_up_or_in(
133148
user: Optional[MgmtUserRequest] = None,
134149
signup_options: Optional[MgmtSignUpOptions] = None,
135150
) -> dict:
136-
""" """
151+
"""
152+
Generate a JWT for a user, simulating a signup or in request.
153+
154+
Args:
155+
login_id (str): login id of the user.
156+
user (MgmtUserRequest): user details.
157+
signup_options (MgmtSignUpOptions): signup options.
158+
"""
137159
return self._sign_up_internal(
138160
login_id, MgmtV1.mgmt_sign_up_or_in, user, signup_options
139161
)
@@ -145,7 +167,6 @@ def _sign_up_internal(
145167
user: Optional[MgmtUserRequest] = None,
146168
signup_options: Optional[MgmtSignUpOptions] = None,
147169
) -> dict:
148-
""" """
149170
if user is None:
150171
user = MgmtUserRequest()
151172

0 commit comments

Comments
 (0)