Skip to content

Latest commit

 

History

History
30 lines (26 loc) · 3.29 KB

KratosUpdateSettingsFlowBody.md

File metadata and controls

30 lines (26 loc) · 3.29 KB
Raw

Ory.Kratos.Client.Model.KratosUpdateSettingsFlowBody

Update Settings Flow Request Body

Properties

Name Type Description Notes
CsrfToken string CSRFToken is the anti-CSRF token [optional]
Method string Method Should be set to "passkey" when trying to add, update, or remove a webAuthn pairing.
Password string Password is the updated password
TransientPayload Object Transient data to pass along to any webhooks [optional]
Traits Object The identity's traits in: body
Flow string Flow ID is the flow's ID. in: query [optional]
Link string Link this provider Either this or `unlink` must be set. type: string in: body [optional]
Unlink string Unlink this provider Either this or `link` must be set. type: string in: body [optional]
UpstreamParameters Object 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): The `login_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): The `hd` parameter limits the login/registration process to a Google Organization, e.g. `mycollege.edu`. `prompt` (string): The `prompt` specifies whether the Authorization Server prompts the End-User for reauthentication and consent, e.g. `select_account`. [optional]
TotpCode string ValidationTOTP must contain a valid TOTP based on the [optional]
TotpUnlink bool UnlinkTOTP if true will remove the TOTP pairing, effectively removing the credential. This can be used to set up a new TOTP device. [optional]
WebauthnRegister string Register a WebAuthn Security Key It is expected that the JSON returned by the WebAuthn registration process is included here. [optional]
WebauthnRegisterDisplayname string Name of the WebAuthn Security Key to be Added A human-readable name for the security key which will be added. [optional]
WebauthnRemove string Remove a WebAuthn Security Key This must contain the ID of the WebAuthN connection. [optional]
LookupSecretConfirm bool If set to true will save the regenerated lookup secrets [optional]
LookupSecretDisable bool Disables this method if true. [optional]
LookupSecretRegenerate bool If set to true will regenerate the lookup secrets [optional]
LookupSecretReveal bool If set to true will reveal the lookup secrets [optional]
PasskeyRemove string Remove a WebAuthn Security Key This must contain the ID of the WebAuthN connection. [optional]
PasskeySettingsRegister string Register a WebAuthn Security Key It is expected that the JSON returned by the WebAuthn registration process is included here. [optional]

[Back to Model list] [Back to API list] [Back to README]