Class LinkIdentityWithIdTokenOptions
Immutable inputs for linking a native OIDC identity to the currently signed-in user with an ID token. Bundles the provider and token with the optional proofs GoTrue may require, so the linking surface stays additive: new optional inputs are added here without changing the method signature.
public class LinkIdentityWithIdTokenOptions
- Inheritance
-
LinkIdentityWithIdTokenOptions
- Inherited Members
Examples
var options = new LinkIdentityWithIdTokenOptions(Constants.Provider.Google, googleIdToken);
var session = await client.LinkIdentityWithIdToken(options);
Constructors
LinkIdentityWithIdTokenOptions(Provider, string, string?, string?, string?)
public LinkIdentityWithIdTokenOptions(Constants.Provider provider, string idToken, string? accessToken = null, string? nonce = null, string? captchaToken = null)
Parameters
providerConstants.ProviderThe native OIDC provider that issued the ID token.
idTokenstringThe OIDC ID token issued by
provider.accessTokenstringAccess token whose hash is checked against the ID token's
at_hashclaim, when present.noncestringNonce whose hash is checked against the ID token's
nonceclaim, when present.captchaTokenstringVerification token from completing the captcha on the site.
Properties
AccessToken
If the ID token contains an at_hash claim, the hash of this value is compared to the value in
the ID token.
public string? AccessToken { get; }
Property Value
CaptchaToken
Verification token received when the user completes the captcha on the site.
public string? CaptchaToken { get; }
Property Value
IdToken
The OIDC ID token issued by Provider. Its iss claim must match the provider.
public string IdToken { get; }
Property Value
Nonce
If the ID token contains a nonce claim, the hash of this value is compared to the value in the
ID token.
public string? Nonce { get; }
Property Value
Provider
The OIDC provider that issued the ID token. Linking with an ID token is only defined for the native providers: Google, Apple, Azure, and Facebook.
public Constants.Provider Provider { get; }