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
Copy file name to clipboardExpand all lines: docs/FrontendApi.md
+8-4Lines changed: 8 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -407,7 +407,7 @@ No authorization required
407
407
[[Back to top]](#)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to Model list]](../README.md#documentation-for-models)[[Back to README]](../README.md)
@@ -460,10 +460,11 @@ with ory_client.ApiClient(configuration) as api_client:
460
460
api_instance = ory_client.FrontendApi(api_client)
461
461
return_to ='return_to_example'# str | The URL to return the browser to after the flow was completed. (optional)
462
462
cookie ='cookie_example'# str | HTTP Cookies When using the SDK in a browser app, on the server side you must include the HTTP Cookie Header sent by the client to your server here. This ensures that CSRF and session cookies are respected. (optional)
463
+
organization ='organization_example'# str | An optional organization ID that scopes the settings flow to providers of that organization. This parameter is only effective in the Ory Network. (optional)
**return_to** | **str**| The URL to return the browser to after the flow was completed. | [optional]
481
482
**cookie** | **str**| HTTP Cookies When using the SDK in a browser app, on the server side you must include the HTTP Cookie Header sent by the client to your server here. This ensures that CSRF and session cookies are respected. | [optional]
483
+
**organization** | **str**| An optional organization ID that scopes the settings flow to providers of that organization. This parameter is only effective in the Ory Network. | [optional]
482
484
483
485
### Return type
484
486
@@ -925,7 +927,7 @@ No authorization required
925
927
[[Back to top]](#)[[Back to API list]](../README.md#documentation-for-api-endpoints)[[Back to Model list]](../README.md#documentation-for-models)[[Back to README]](../README.md)
@@ -973,10 +975,11 @@ with ory_client.ApiClient(configuration) as api_client:
973
975
# Create an instance of the API class
974
976
api_instance = ory_client.FrontendApi(api_client)
975
977
x_session_token ='x_session_token_example'# str | The Session Token of the Identity performing the settings flow. (optional)
978
+
organization ='organization_example'# str | An optional organization ID that scopes the settings flow to providers of that organization. This parameter is only effective in the Ory Network. (optional)
**x_session_token** | **str**| The Session Token of the Identity performing the settings flow. | [optional]
997
+
**organization** | **str**| An optional organization ID that scopes the settings flow to providers of that organization. This parameter is only effective in the Ory Network. | [optional]
Copy file name to clipboardExpand all lines: docs/SettingsFlow.md
+1Lines changed: 1 addition & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -12,6 +12,7 @@ Name | Type | Description | Notes
12
12
**id** | **str** | ID represents the flow's unique ID. When performing the settings flow, this represents the id in the settings ui's query parameter: http://<selfservice.flows.settings.ui_url>?flow=<id> |
13
13
**identity** | [**Identity**](Identity.md) | |
14
14
**issued_at** | **datetime** | IssuedAt is the time (UTC) when the flow occurred. |
15
+
**organization_id** | **str** | | [optional]
15
16
**request_url** | **str** | RequestURL is the initial URL that was requested from Ory Kratos. It can be used to forward information contained in the URL's path or query for example. |
**state** | **object** | State represents the state of this flow. It knows two states: show_form: No user data has been collected, or it is invalid, and thus the form should be shown. success: Indicates that the settings flow has been updated successfully with the provided data. Done will stay true when repeatedly checking. If set to true, done will revert back to false only when a flow with invalid (e.g. \"please use a valid phone number\") data was sent. |
0 commit comments