Add docs for sign_in_with_id_token

supabase-community · Oct 21, 2024 · c99d1df · c99d1df
1 parent bedf571
commit c99d1df
Showing 1 changed file with 12 additions and 1 deletion.
diff --git a/src/client.rs b/src/client.rs
@@ -521,8 +521,19 @@ impl AuthClient {
         Ok(user)
     }
 
-    // TODO: Add test
     /// Allows signing in with an OIDC ID token. The authentication provider used should be enabled and configured.
+    /// # Example
+    /// ```
+    /// let credentials = IdTokenCredentials {
+    ///     provider: Provider::Github,
+    ///     token: "<id-token-from-auth-provider>",
+    /// };
+    ///
+    /// let session = auth_client
+    ///     .sign_in_with_id_token(credentials)
+    ///     .await
+    ///     .unwrap();
+    /// ```
     pub async fn sign_in_with_id_token(
         &self,
         credentials: IdTokenCredentials,