From dba16fbc2a3ec688587abb75bad541da8055c016 Mon Sep 17 00:00:00 2001 From: joel Date: Wed, 17 Jan 2024 14:20:04 +0800 Subject: [PATCH] feat: add docstring --- gotrue/_async/gotrue_client.py | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/gotrue/_async/gotrue_client.py b/gotrue/_async/gotrue_client.py index c292c350..a195de7a 100644 --- a/gotrue/_async/gotrue_client.py +++ b/gotrue/_async/gotrue_client.py @@ -254,6 +254,19 @@ async def sign_in_with_password( return response async def sign_in_with_sso(self, credentials: SignInWithSSOCredentials): + """ + Attempts a single-sign on using an enterprise Identity Provider. A + successful SSO attempt will redirect the current page to the identity + provider authorization page. The redirect URL is implementation and SSO + protocol specific. + + You can use it by providing a SSO domain. Typically you can extract this + domain by asking users for their email address. If this domain is + registered on the Auth instance the redirect will use that organization's + currently active SSO Identity Provider for the login. + If you have built an organization-specific login page, you can use the + organization's SSO Identity Provider UUID directly instead. + """ await self._remove_session() provider_id = credentials.get("provider_id") domain = credentials.get("domain")