UpdateRegistrationFlowWithOidcMethod class abstract
Update Registration Flow with OpenID Connect Method
Properties:
- csrfToken - The CSRF Token
- idToken - IDToken is an optional id token provided by an OIDC provider If submitted, it is verified using the OIDC provider's public key set and the claims are used to populate the OIDC credentials of the identity. If the OIDC provider does not store additional claims (such as name, etc.) in the IDToken itself, you can use the
traits
field to populate the identity's traits. Note, that Apple only includes the users email in the IDToken. Supported providers are Apple - idTokenNonce - IDTokenNonce is the nonce, used when generating the IDToken. If the provider supports nonce validation, the nonce will be validated against this value and is required.
- method - Method to use This field must be set to
oidc
when using the oidc method. - provider - The provider to register with
- traits - The identity traits
- transientPayload - Transient data to pass along to any webhooks
- upstreamParameters - UpstreamParameters are the parameters that are passed to the upstream identity provider. These parameters are optional and depend on what the upstream identity provider supports. Supported parameters are:
login_hint
(string): Thelogin_hint
parameter suppresses the account chooser and either pre-fills the email box on the sign-in form, or selects the proper session.hd
(string): Thehd
parameter limits the login/registration process to a Google Organization, e.g.mycollege.edu
.prompt
(string): Theprompt
specifies whether the Authorization Server prompts the End-User for reauthentication and consent, e.g.select_account
.
- Annotations
-
- @BuiltValue()
Constructors
- UpdateRegistrationFlowWithOidcMethod([void updates(UpdateRegistrationFlowWithOidcMethodBuilder b)])
-
factory
Properties
- csrfToken → String?
-
The CSRF Token
no setter
- hashCode → int
-
The hash code for this object.
no setterinherited
- idToken → String?
-
IDToken is an optional id token provided by an OIDC provider If submitted, it is verified using the OIDC provider's public key set and the claims are used to populate the OIDC credentials of the identity. If the OIDC provider does not store additional claims (such as name, etc.) in the IDToken itself, you can use the
traits
field to populate the identity's traits. Note, that Apple only includes the users email in the IDToken. Supported providers are Appleno setter - idTokenNonce → String?
-
IDTokenNonce is the nonce, used when generating the IDToken. If the provider supports nonce validation, the nonce will be validated against this value and is required.
no setter
- method → String
-
Method to use This field must be set to
oidc
when using the oidc method.no setter - provider → String
-
The provider to register with
no setter
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- traits → JsonObject?
-
The identity traits
no setter
- transientPayload → JsonObject?
-
Transient data to pass along to any webhooks
no setter
- upstreamParameters → JsonObject?
-
UpstreamParameters are the parameters that are passed to the upstream identity provider. These parameters are optional and depend on what the upstream identity provider supports. Supported parameters are:
login_hint
(string): Thelogin_hint
parameter suppresses the account chooser and either pre-fills the email box on the sign-in form, or selects the proper session.hd
(string): Thehd
parameter limits the login/registration process to a Google Organization, e.g.mycollege.edu
.prompt
(string): Theprompt
specifies whether the Authorization Server prompts the End-User for reauthentication and consent, e.g.select_account
.no setter
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
rebuild(
dynamic updates(UpdateRegistrationFlowWithOidcMethodBuilder)) → UpdateRegistrationFlowWithOidcMethod -
Rebuilds the instance.
inherited
-
toBuilder(
) → UpdateRegistrationFlowWithOidcMethodBuilder -
Converts the instance to a builder
B
.inherited -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Properties
-
serializer
→ Serializer<
UpdateRegistrationFlowWithOidcMethod> -
no setter