You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This endpoint implements the W3C \"change password URL\" well-known location by redirecting the browser to the configured settings UI. Password managers follow this redirect to take users straight to the page where they can change their password.
1403
+
1404
+
### Example
1405
+
1406
+
```php
1407
+
<?php
1408
+
require_once(__DIR__ . '/vendor/autoload.php');
1409
+
1410
+
1411
+
1412
+
$apiInstance = new Ory\Client\Api\FrontendApi(
1413
+
// If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
1414
+
// This is optional, `GuzzleHttp\Client` will be used as default.
Copy file name to clipboardExpand all lines: docs/Model/UpdateLoginFlowBody.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,7 +14,7 @@ Name | Type | Description | Notes
14
14
**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 required. | [optional]
15
15
**provider** | **string** | The provider to register with |
16
16
**traits** | **object** | The identity traits. This is a placeholder for the registration flow. | [optional]
17
-
**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`. `acr_values` (string): The `acr_values` specifies the Authentication Context Class Reference values for the authorization request. | [optional]
17
+
**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: `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`. `acr_values` (string): The `acr_values` specifies the Authentication Context Class Reference values for the authorization request. | [optional]
18
18
**totpCode** | **string** | The TOTP code. |
19
19
**webauthnLogin** | **string** | Login a WebAuthn Security Key This must contain the ID of the WebAuthN connection. | [optional]
20
20
**lookupSecret** | **string** | The lookup secret. |
Copy file name to clipboardExpand all lines: docs/Model/UpdateLoginFlowWithOidcMethod.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,6 +11,6 @@ Name | Type | Description | Notes
11
11
**provider** | **string** | The provider to register with |
12
12
**traits** | **object** | The identity traits. This is a placeholder for the registration flow. | [optional]
13
13
**transientPayload** | **object** | Transient data to pass along to any webhooks | [optional]
14
-
**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`. `acr_values` (string): The `acr_values` specifies the Authentication Context Class Reference values for the authorization request. | [optional]
14
+
**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: `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`. `acr_values` (string): The `acr_values` specifies the Authentication Context Class Reference values for the authorization request. | [optional]
15
15
16
16
[[Back to Model list]](../../README.md#models)[[Back to API list]](../../README.md#endpoints)[[Back to README]](../../README.md)
Copy file name to clipboardExpand all lines: docs/Model/UpdateRegistrationFlowBody.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
12
12
**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 Apple Google | [optional]
13
13
**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. | [optional]
14
14
**provider** | **string** | The provider to register with |
15
-
**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`. `acr_values` (string): The `acr_values` specifies the Authentication Context Class Reference values for the authorization request. | [optional]
15
+
**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: `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`. `acr_values` (string): The `acr_values` specifies the Authentication Context Class Reference values for the authorization request. | [optional]
16
16
**webauthnRegister** | **string** | Register a WebAuthn Security Key It is expected that the JSON returned by the WebAuthn registration process is included here. | [optional]
17
17
**webauthnRegisterDisplayname** | **string** | Name of the WebAuthn Security Key to be Added A human-readable name for the security key which will be added. | [optional]
18
18
**code** | **string** | The OTP Code sent to the user | [optional]
Copy file name to clipboardExpand all lines: docs/Model/UpdateRegistrationFlowWithOidcMethod.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,6 +11,6 @@ Name | Type | Description | Notes
11
11
**provider** | **string** | The provider to register with |
12
12
**traits** | **object** | The identity traits | [optional]
13
13
**transientPayload** | **object** | Transient data to pass along to any webhooks | [optional]
14
-
**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`. `acr_values` (string): The `acr_values` specifies the Authentication Context Class Reference values for the authorization request. | [optional]
14
+
**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: `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`. `acr_values` (string): The `acr_values` specifies the Authentication Context Class Reference values for the authorization request. | [optional]
15
15
16
16
[[Back to Model list]](../../README.md#models)[[Back to API list]](../../README.md#endpoints)[[Back to README]](../../README.md)
Copy file name to clipboardExpand all lines: docs/Model/UpdateSettingsFlowBody.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,7 +12,7 @@ Name | Type | Description | Notes
12
12
**flow** | **string** | Flow ID is the flow's ID. in: query | [optional]
13
13
**link** | **string** | Link this provider Either this or `unlink` must be set. type: string in: body | [optional]
14
14
**unlink** | **string** | Unlink this provider Either this or `link` must be set. type: string in: body | [optional]
15
-
**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`. `acr_values` (string): The `acr_values` specifies the Authentication Context Class Reference values for the authorization request. | [optional]
15
+
**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: `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`. `acr_values` (string): The `acr_values` specifies the Authentication Context Class Reference values for the authorization request. | [optional]
16
16
**totpCode** | **string** | ValidationTOTP must contain a valid TOTP based on the | [optional]
17
17
**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]
18
18
**webauthnRegister** | **string** | Register a WebAuthn Security Key It is expected that the JSON returned by the WebAuthn registration process is included here. | [optional]
0 commit comments