Skip to content

Commit eee7b99

Browse files
authored
Add documentation about sync-only methods. (#357)
1 parent 04038c3 commit eee7b99

File tree

2 files changed

+8
-0
lines changed

2 files changed

+8
-0
lines changed

workos/sso.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,8 @@ def get_authorization_url(
6161
The URL generated will redirect a User to the Identity Provider configured through
6262
WorkOS.
6363
64+
This method is purposefully designed as synchronous as it does not make any HTTP requests.
65+
6466
Kwargs:
6567
redirect_uri (str) : A valid redirect URI, as specified on WorkOS
6668
state (str) : An encoded string passed to WorkOS that'd be preserved through the authentication workflow, passed

workos/user_management.py

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -331,6 +331,8 @@ def get_authorization_url(
331331
The URL generated will redirect a User to the Identity Provider configured through
332332
WorkOS.
333333
334+
This method is purposefully designed as synchronous as it does not make any HTTP requests.
335+
334336
Kwargs:
335337
redirect_uri (str): A Redirect URI to return an authorized user to.
336338
connection_id (str): The connection_id connection selector is used to initiate SSO for a Connection.
@@ -546,6 +548,8 @@ def authenticate_with_refresh_token(
546548
def get_jwks_url(self) -> str:
547549
"""Get the public key that is used for verifying access tokens.
548550
551+
This method is purposefully designed as synchronous as it does not make any HTTP requests.
552+
549553
Returns:
550554
(str): The public JWKS URL.
551555
"""
@@ -555,6 +559,8 @@ def get_jwks_url(self) -> str:
555559
def get_logout_url(self, session_id: str) -> str:
556560
"""Get the URL for ending the session and redirecting the user
557561
562+
This method is purposefully designed as synchronous as it does not make any HTTP requests.
563+
558564
Args:
559565
session_id (str): The ID of the user's session
560566

0 commit comments

Comments
 (0)