Skip to content

Commit 4ced01a

Browse files
committed
Update doc string to be more specific about usage
1 parent ef181c2 commit 4ced01a

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

workos/user_management.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -350,7 +350,9 @@ def get_authorization_url(
350350
state (str): An encoded string passed to WorkOS that'd be preserved through the authentication workflow, passed
351351
back as a query parameter. (Optional)
352352
code_challenge (str): Code challenge is derived from the code verifier used for the PKCE flow. (Optional)
353-
prompt (str): The prompt parameter can be used to specify whether the user should be prompted for credentials or not.
353+
prompt (str): Used to specify whether the upstream provider should prompt the user for credentials or other
354+
consent. Valid values depend on the provider. Currently only applies to provider values of 'GoogleOAuth',
355+
'MicrosoftOAuth', or 'GitHubOAuth'. (Optional)
354356
355357
Returns:
356358
str: URL to redirect a User to to begin the OAuth workflow with WorkOS

0 commit comments

Comments
 (0)