Skip to content

Commit

Permalink
Deploying to gh-pages from @ 7d763dd 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
@acupofjose
acupofjose committed Jul 26, 2024
1 parent fcea592 commit 534438e
Show file tree
Hide file tree
Showing 14 changed files with 1,534 additions and 49 deletions.
106 changes: 91 additions & 15 deletions api/Supabase.Gotrue.AdminClient.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5>


<h1 id="Supabase_Gotrue_AdminClient" data-uid="Supabase.Gotrue.AdminClient" class="text-break">
Class AdminClient <a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/AdminClient.cs/#L16"><i class="bi bi-code-slash"></i></a>
Class AdminClient <a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/AdminClient.cs/#L17"><i class="bi bi-code-slash"></i></a>
</h1>

<div class="facts text-secondary">
Expand Down Expand Up @@ -166,7 +166,7 @@ <h2 class="section" id="constructors">Constructors

<h3 id="Supabase_Gotrue_AdminClient__ctor_System_String_Supabase_Gotrue_ClientOptions_" data-uid="Supabase.Gotrue.AdminClient.#ctor(System.String,Supabase.Gotrue.ClientOptions)">
AdminClient(string, ClientOptions?)
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/AdminClient.cs/#L28"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/AdminClient.cs/#L29"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Initialize the client with a service key.</p>
Expand Down Expand Up @@ -205,7 +205,7 @@ <h2 class="section" id="properties">Properties

<h3 id="Supabase_Gotrue_AdminClient_GetHeaders" data-uid="Supabase.Gotrue.AdminClient.GetHeaders">
GetHeaders
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/AdminClient.cs/#L40"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/AdminClient.cs/#L41"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Headers sent to the API on every request.</p>
Expand Down Expand Up @@ -237,7 +237,7 @@ <h4 class="section">Property Value</h4>

<h3 id="Supabase_Gotrue_AdminClient_Options" data-uid="Supabase.Gotrue.AdminClient.Options">
Options
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/AdminClient.cs/#L21"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/AdminClient.cs/#L22"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>The initialized client options.</p>
Expand Down Expand Up @@ -273,7 +273,7 @@ <h2 class="section" id="methods">Methods

<h3 id="Supabase_Gotrue_AdminClient_CreateUser_Supabase_Gotrue_AdminUserAttributes_" data-uid="Supabase.Gotrue.AdminClient.CreateUser(Supabase.Gotrue.AdminUserAttributes)">
CreateUser(AdminUserAttributes)
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/AdminClient.cs/#L89"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/AdminClient.cs/#L90"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Creates a user using the admin key (not the anonymous key).
Expand Down Expand Up @@ -311,7 +311,7 @@ <h4 class="section">Returns</h4>

<h3 id="Supabase_Gotrue_AdminClient_CreateUser_System_String_System_String_Supabase_Gotrue_AdminUserAttributes_" data-uid="Supabase.Gotrue.AdminClient.CreateUser(System.String,System.String,Supabase.Gotrue.AdminUserAttributes)">
CreateUser(string, string, AdminUserAttributes?)
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/AdminClient.cs/#L79"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/AdminClient.cs/#L80"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Creates a user using the admin key (not the anonymous key).
Expand Down Expand Up @@ -349,11 +349,49 @@ <h4 class="section">Returns</h4>



<a id="Supabase_Gotrue_AdminClient_DeleteFactor_" data-uid="Supabase.Gotrue.AdminClient.DeleteFactor*"></a>

<h3 id="Supabase_Gotrue_AdminClient_DeleteFactor_Supabase_Gotrue_Mfa_MfaAdminDeleteFactorParams_" data-uid="Supabase.Gotrue.AdminClient.DeleteFactor(Supabase.Gotrue.Mfa.MfaAdminDeleteFactorParams)">
DeleteFactor(MfaAdminDeleteFactorParams)
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/AdminClient.cs/#L135"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Deletes a factor on a user. This will log the user out of all active sessions if the deleted factor was verified.</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task&lt;MfaAdminDeleteFactorResponse?&gt; DeleteFactor(MfaAdminDeleteFactorParams deleteFactorParams)</code></pre>
</div>

<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>deleteFactorParams</code> <a class="xref" href="Supabase.Gotrue.Mfa.MfaAdminDeleteFactorParams.html">MfaAdminDeleteFactorParams</a></dt>
<dd></dd>
</dl>

<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1">Task</a>&lt;<a class="xref" href="Supabase.Gotrue.Mfa.MfaAdminDeleteFactorResponse.html">MfaAdminDeleteFactorResponse</a>&gt;</dt>
<dd><p>A <a class="xref" href="Supabase.Gotrue.Mfa.MfaAdminDeleteFactorResponse.html">MfaAdminDeleteFactorResponse</a> containing the deleted factor id.</p>
</dd>
</dl>











<a id="Supabase_Gotrue_AdminClient_DeleteUser_" data-uid="Supabase.Gotrue.AdminClient.DeleteUser*"></a>

<h3 id="Supabase_Gotrue_AdminClient_DeleteUser_System_String_" data-uid="Supabase.Gotrue.AdminClient.DeleteUser(System.String)">
DeleteUser(string)
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/AdminClient.cs/#L71"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/AdminClient.cs/#L72"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Creates a user using the admin key (not the anonymous key).
Expand Down Expand Up @@ -391,7 +429,7 @@ <h4 class="section">Returns</h4>

<h3 id="Supabase_Gotrue_AdminClient_GenerateLink_Supabase_Gotrue_GenerateLinkOptions_" data-uid="Supabase.Gotrue.AdminClient.GenerateLink(Supabase.Gotrue.GenerateLinkOptions)">
GenerateLink(GenerateLinkOptions)
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/AdminClient.cs/#L103"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/AdminClient.cs/#L105"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Generates email links and OTPs to be sent via a custom email provider.</p>
Expand Down Expand Up @@ -429,7 +467,7 @@ <h4 class="section">Returns</h4>

<h3 id="Supabase_Gotrue_AdminClient_GetUser_System_String_" data-uid="Supabase.Gotrue.AdminClient.GetUser(System.String)">
GetUser(string)
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/AdminClient.cs/#L60"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/AdminClient.cs/#L61"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Gets a user from a user's JWT. This is using the GoTrue server to validate a user's JWT.</p>
Expand Down Expand Up @@ -466,7 +504,7 @@ <h4 class="section">Returns</h4>

<h3 id="Supabase_Gotrue_AdminClient_GetUserById_System_String_" data-uid="Supabase.Gotrue.AdminClient.GetUserById(System.String)">
GetUserById(string)
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/AdminClient.cs/#L57"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/AdminClient.cs/#L58"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Gets a user by ID from the server using the admin key (not the anonymous key).</p>
Expand Down Expand Up @@ -503,7 +541,7 @@ <h4 class="section">Returns</h4>

<h3 id="Supabase_Gotrue_AdminClient_InviteUserByEmail_System_String_Supabase_Gotrue_InviteUserByEmailOptions_" data-uid="Supabase.Gotrue.AdminClient.InviteUserByEmail(System.String,Supabase.Gotrue.InviteUserByEmailOptions)">
InviteUserByEmail(string, InviteUserByEmailOptions?)
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/AdminClient.cs/#L63"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/AdminClient.cs/#L64"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Sends an email to the user.</p>
Expand Down Expand Up @@ -538,11 +576,49 @@ <h4 class="section">Returns</h4>



<a id="Supabase_Gotrue_AdminClient_ListFactors_" data-uid="Supabase.Gotrue.AdminClient.ListFactors*"></a>

<h3 id="Supabase_Gotrue_AdminClient_ListFactors_Supabase_Gotrue_Mfa_MfaAdminListFactorsParams_" data-uid="Supabase.Gotrue.AdminClient.ListFactors(Supabase.Gotrue.Mfa.MfaAdminListFactorsParams)">
ListFactors(MfaAdminListFactorsParams)
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/AdminClient.cs/#L118"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Lists all factors associated to a specific user.</p>
</div>
<div class="markdown level1 conceptual"></div>

<div class="codewrapper">
<pre><code class="lang-csharp hljs">public Task&lt;MfaAdminListFactorsResponse?&gt; ListFactors(MfaAdminListFactorsParams listFactorsParams)</code></pre>
</div>

<h4 class="section">Parameters</h4>
<dl class="parameters">
<dt><code>listFactorsParams</code> <a class="xref" href="Supabase.Gotrue.Mfa.MfaAdminListFactorsParams.html">MfaAdminListFactorsParams</a></dt>
<dd></dd>
</dl>

<h4 class="section">Returns</h4>
<dl class="parameters">
<dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.threading.tasks.task-1">Task</a>&lt;<a class="xref" href="Supabase.Gotrue.Mfa.MfaAdminListFactorsResponse.html">MfaAdminListFactorsResponse</a>&gt;</dt>
<dd><p>A list of <a class="xref" href="Supabase.Gotrue.Mfa.Factor.html">Factor</a> that this user has enabled.</p>
</dd>
</dl>











<a id="Supabase_Gotrue_AdminClient_ListUsers_" data-uid="Supabase.Gotrue.AdminClient.ListUsers*"></a>

<h3 id="Supabase_Gotrue_AdminClient_ListUsers_System_String_System_String_Supabase_Gotrue_Constants_SortOrder_System_Nullable_System_Int32__System_Nullable_System_Int32__" data-uid="Supabase.Gotrue.AdminClient.ListUsers(System.String,System.String,Supabase.Gotrue.Constants.SortOrder,System.Nullable{System.Int32},System.Nullable{System.Int32})">
ListUsers(string?, string?, SortOrder, int?, int?)
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/AdminClient.cs/#L92"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/AdminClient.cs/#L93"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Lists users</p>
Expand Down Expand Up @@ -592,7 +668,7 @@ <h4 class="section">Returns</h4>

<h3 id="Supabase_Gotrue_AdminClient_Update_Supabase_Gotrue_UserAttributes_" data-uid="Supabase.Gotrue.AdminClient.Update(Supabase.Gotrue.UserAttributes)">
Update(UserAttributes)
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/AdminClient.cs/#L116"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/AdminClient.cs/#L141"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Updates a User using the service key</p>
Expand Down Expand Up @@ -629,7 +705,7 @@ <h4 class="section">Returns</h4>

<h3 id="Supabase_Gotrue_AdminClient_UpdateUserById_System_String_Supabase_Gotrue_AdminUserAttributes_" data-uid="Supabase.Gotrue.AdminClient.UpdateUserById(System.String,Supabase.Gotrue.AdminUserAttributes)">
UpdateUserById(string, AdminUserAttributes)
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/AdminClient.cs/#L98"><i class="bi bi-code-slash"></i></a>
<a class="header-action link-secondary" title="View source" href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/AdminClient.cs/#L99"><i class="bi bi-code-slash"></i></a>
</h3>

<div class="markdown level1 summary"><p>Update user by Id</p>
Expand Down Expand Up @@ -668,7 +744,7 @@ <h4 class="section">Returns</h4>
</article>

<div class="contribution d-print-none">
<a href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/AdminClient.cs/#L16" class="edit-link">Edit this page</a>
<a href="https://github.com/supabase-community/gotrue-csharp/blob/master/Gotrue/AdminClient.cs/#L17" class="edit-link">Edit this page</a>
</div>


Expand Down
Loading

0 comments on commit 534438e

Please sign in to comment.