ory-client 1.22.78 → 1.22.80

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c6401f0492360ed0705b183f24bae0b2865a4561068b176f4b37a64ff7d0d1f6
-  data.tar.gz: 8a9f2a380d17838a5826abf3cea447c8b25018a41c8d88a98579aced4e48021b
+  metadata.gz: 00b621c23a0d63de613e019c70d61a5e4d29f2f74c51bb105f1c936a77e6da97
+  data.tar.gz: 4835001b90b42dadd9edba45b6de56baf5a48cebda4749d606c0bb79df362d82
 SHA512:
-  metadata.gz: bb037e45316531de57b4b3df7e06f38c84844d4a1790fb8c05fdc2b1b56d6843a6f916d8e9dd176cdc0d6397acc8618680d0e0195fe48e1fd02f27099ec2d142
-  data.tar.gz: 39331b15cff1c991e2f72b0380b14b542aa9c1edc62733639f33dd73ce3bffa3603e8040442d87c202a48ce86664e36947b066417954396a578c5c68cd7e03ee
+  metadata.gz: '0528f114ce4aa76d750a6717b6087563237b1cea981d6b1f833801a45ac627b8428de1a3dc519fac9996281bb319b80f9a831226e9090a0280bbc7fc89b3fe1e'
+  data.tar.gz: 65a18c1cf5a938bd3e07ec39bdb24d44f35b597164b6fb74c70e59682fb9365f26f27f1372d1f680bac79db4f9d05432c7b61403c241ba37e2f8f8c02fc61014

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    ory-client (1.22.78)
+    ory-client (1.22.80)
       typhoeus (~> 1.0, >= 1.0.1)
 
 GEM

data/README.md

@@ -26,8 +26,8 @@ This document describes the APIs available in the Ory Network. The APIs are avai
 
 This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
 
-- API version: v1.22.78
-- Package version: v1.22.78
+- API version: v1.22.80
+- Package version: v1.22.80
 - Generator version: 7.17.0
 - Build package: org.openapitools.codegen.languages.RubyClientCodegen
 
@@ -44,16 +44,16 @@ gem build ory-client.gemspec
 Then either install the gem locally:
 
 ```shell
-gem install ./ory-client-v1.22.78.gem
+gem install ./ory-client-v1.22.80.gem
 ```
 
-(for development, run `gem install --dev ./ory-client-v1.22.78.gem` to install the development dependencies)
+(for development, run `gem install --dev ./ory-client-v1.22.80.gem` to install the development dependencies)
 
 or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
 
 Finally add this to the Gemfile:
 
-    gem 'ory-client', '~> v1.22.78'
+    gem 'ory-client', '~> v1.22.80'
 
 ### Install from Git
 
@@ -150,13 +150,18 @@ Class | Method | HTTP request | Description
 *OryClient::FrontendApi* | [**get_login_flow**](docs/FrontendApi.md#get_login_flow) | **GET** /self-service/login/flows | Get Login Flow
 *OryClient::FrontendApi* | [**get_recovery_flow**](docs/FrontendApi.md#get_recovery_flow) | **GET** /self-service/recovery/flows | Get Recovery Flow
 *OryClient::FrontendApi* | [**get_registration_flow**](docs/FrontendApi.md#get_registration_flow) | **GET** /self-service/registration/flows | Get Registration Flow
+*OryClient::FrontendApi* | [**get_saml_metadata**](docs/FrontendApi.md#get_saml_metadata) | **GET** /self-service/methods/saml/metadata | Get SAML SP Metadata
+*OryClient::FrontendApi* | [**get_saml_provider_metadata**](docs/FrontendApi.md#get_saml_provider_metadata) | **GET** /self-service/methods/saml/metadata/{provider} | Get Per-Connection SAML SP Metadata
 *OryClient::FrontendApi* | [**get_settings_flow**](docs/FrontendApi.md#get_settings_flow) | **GET** /self-service/settings/flows | Get Settings Flow
 *OryClient::FrontendApi* | [**get_verification_flow**](docs/FrontendApi.md#get_verification_flow) | **GET** /self-service/verification/flows | Get Verification Flow
 *OryClient::FrontendApi* | [**get_web_authn_java_script**](docs/FrontendApi.md#get_web_authn_java_script) | **GET** /.well-known/ory/webauthn.js | Get WebAuthn JavaScript
 *OryClient::FrontendApi* | [**get_web_authn_related_origins**](docs/FrontendApi.md#get_web_authn_related_origins) | **GET** /.well-known/webauthn | Get WebAuthn Related Origins
 *OryClient::FrontendApi* | [**get_well_known_change_password**](docs/FrontendApi.md#get_well_known_change_password) | **GET** /.well-known/change-password | Change Password URL
+*OryClient::FrontendApi* | [**init_saml_login**](docs/FrontendApi.md#init_saml_login) | **GET** /self-service/methods/saml/init/{provider} | Initiate Native SAML Sign-In
+*OryClient::FrontendApi* | [**init_saml_login_request**](docs/FrontendApi.md#init_saml_login_request) | **POST** /self-service/methods/saml/init/{provider} | Initiate Native SAML Sign-In (Direct POST)
 *OryClient::FrontendApi* | [**list_my_sessions**](docs/FrontendApi.md#list_my_sessions) | **GET** /sessions | Get My Active Sessions
 *OryClient::FrontendApi* | [**perform_native_logout**](docs/FrontendApi.md#perform_native_logout) | **DELETE** /self-service/logout/api | Perform Logout for Native Apps
+*OryClient::FrontendApi* | [**submit_saml_assertion**](docs/FrontendApi.md#submit_saml_assertion) | **POST** /self-service/methods/saml/acs/{provider} | Native SAML Assertion Consumer Service (ACS)
 *OryClient::FrontendApi* | [**to_session**](docs/FrontendApi.md#to_session) | **GET** /sessions/whoami | Check Who the Current HTTP Session Belongs To
 *OryClient::FrontendApi* | [**update_fedcm_flow**](docs/FrontendApi.md#update_fedcm_flow) | **POST** /self-service/fed-cm/token | Submit a FedCM token
 *OryClient::FrontendApi* | [**update_login_flow**](docs/FrontendApi.md#update_login_flow) | **POST** /self-service/login | Submit a Login Flow

data/docs/CreateProjectNormalizedPayload.md

@@ -157,11 +157,13 @@
 | **kratos_oauth2_provider_override_return_to** | **Boolean** | Kratos OAuth2 Provider Override Return To  Enabling this allows Kratos to set the return_to parameter automatically to the OAuth2 request URL on the login flow, allowing complex flows such as recovery to continue to the initial OAuth2 flow.  This governs the \"oauth2_provider.override_return_to\" setting. | [optional] |
 | **kratos_oauth2_provider_url** | **String** | The Revisions' OAuth2 Provider Integration URL  This governs the \"oauth2_provider.url\" setting. | [optional] |
 | **kratos_preview_default_read_consistency_level** | **String** | Configures the default read consistency level for identity APIs  The read consistency level determines the consistency guarantee for reads:  - strong (slow): The read is guaranteed to return the most recent data committed at the start of the read. - eventual (very fast): The result will return data that is about 4.8 seconds old.  Setting the default consistency level to `eventual` may cause regressions in the future as we add consistency controls to more APIs. Currently, the following APIs will be affected by this setting:  - `GET /admin/identities`  Defaults to \"strong\" for new and existing projects. This feature is in preview. Use with caution. This governs the \"preview.default_read_consistency_level\" setting. | [optional] |
+| **kratos_preview_enable_native_saml_engine** | **Boolean** | Configures whether the native Ory Kratos SAML engine is enabled (preview).  This is the preview flag that gates the native SAML engine. While it is false or unset, native SAML providers are inert and the native endpoints respond with 404. In Ory Network, turning it on requires the native_saml_engine feature.  This governs the \"preview.enable_native_saml_engine\" setting. | [optional] |
 | **kratos_secrets_cipher** | **Array<String>** | Configures the Ory Kratos Cipher Secret  This governs the \"secrets.cipher\" setting. | [optional] |
 | **kratos_secrets_cookie** | **Array<String>** | Configures the Ory Kratos Cookie Secret  This governs the \"secrets.cookie\" setting. | [optional] |
 | **kratos_secrets_default** | **Array<String>** | Configures the Ory Kratos Default Secret  This governs the \"secrets.default\" setting. | [optional] |
 | **kratos_secrets_pagination** | **Array<String>** | Configures the Ory Kratos Pagination Secret  This governs the \"secrets.pagination\" setting. | [optional] |
 | **kratos_security_account_enumeration_mitigate** | **Boolean** | Configures if account enumeration should be mitigated when using identifier first login.  This governs the \"security.account_enumeration.mitigate\" setting. | [optional] |
+| **kratos_security_restricted_origins** | **Array<String>** | Configures the Restricted Origins  Origins that may only check the session, use FedCM, and log out, such as pages that run third-party scripts. Responses to these origins never contain identity data. To let these origins read responses, also add them to the CORS allowed origins.  This governs the \"security.restricted_origins\" setting. | [optional] |
 | **kratos_selfservice_allowed_return_urls** | **Array<String>** | Configures the Ory Kratos Allowed Return URLs  This governs the \"selfservice.allowed_return_urls\" setting. | [optional] |
 | **kratos_selfservice_default_browser_return_url** | **String** | Configures the Ory Kratos Default Return URL  This governs the \"selfservice.default_browser_return_url\" setting. | [optional] |
 | **kratos_selfservice_flows_error_ui_url** | **String** | Configures the Ory Kratos Error UI URL  This governs the \"selfservice.flows.error.ui_url\" setting. | [optional] |
@@ -243,9 +245,15 @@
 | **kratos_selfservice_methods_oidc_config_providers** | [**Array<NormalizedProjectRevisionThirdPartyProvider>**](NormalizedProjectRevisionThirdPartyProvider.md) |  | [optional] |
 | **kratos_selfservice_methods_oidc_enable_auto_link_policy** | **Boolean** | Configures whether Ory Kratos allows auto-linking of OIDC credentials without a subject  This governs the \"selfservice.methods.oidc.enable_auto_link_policy\" setting. | [optional] |
 | **kratos_selfservice_methods_oidc_enabled** | **Boolean** | Configures whether Ory Kratos Third Party / OpenID Connect Login is enabled  This governs the \"selfservice.methods.oidc.enabled\" setting. | [optional] |
+| **kratos_selfservice_methods_passkey_config_attestation_preference** | **String** | Configures the attestation conveyance preference for passkey registration.  This governs the \"selfservice.methods.passkey.config.attestation.preference\" setting. | [optional] |
+| **kratos_selfservice_methods_passkey_config_authenticator_selection_attachment** | **String** | Configures which authenticator attachment modality is eligible for passkey registration.  This governs the \"selfservice.methods.passkey.config.authenticator_selection.attachment\" setting. | [optional] |
+| **kratos_selfservice_methods_passkey_config_authenticator_selection_resident_key** | **String** | Configures whether the authenticator must create a client-side discoverable passkey.  This governs the \"selfservice.methods.passkey.config.authenticator_selection.resident_key\" setting. | [optional] |
+| **kratos_selfservice_methods_passkey_config_authenticator_selection_user_verification** | **String** | Configures whether passkey ceremonies require user verification such as biometrics or a PIN.  This governs the \"selfservice.methods.passkey.config.authenticator_selection.user_verification\" setting. | [optional] |
 | **kratos_selfservice_methods_passkey_config_rp_display_name** | **String** | Configures the Ory Kratos Passkey RP Display Name  This governs the \"selfservice.methods.passkey.config.rp.display_name\" setting. | [optional] |
 | **kratos_selfservice_methods_passkey_config_rp_id** | **String** | Configures the Ory Kratos Passkey RP ID  This governs the \"selfservice.methods.passkey.config.rp.id\" setting. | [optional] |
 | **kratos_selfservice_methods_passkey_config_rp_origins** | **Array<String>** | Configures the Ory Kratos Passkey RP Origins  This governs the \"selfservice.methods.passkey.config.rp.origins\" setting. | [optional] |
+| **kratos_selfservice_methods_passkey_config_timeouts_login** | **String** | Configures the passkey login ceremony timeout.  This governs the \"selfservice.methods.passkey.config.timeouts.login\" setting. | [optional] |
+| **kratos_selfservice_methods_passkey_config_timeouts_registration** | **String** | Configures the passkey registration ceremony timeout.  This governs the \"selfservice.methods.passkey.config.timeouts.registration\" setting. | [optional] |
 | **kratos_selfservice_methods_passkey_enabled** | **Boolean** | Configures whether Ory Kratos Passkey authentication is enabled  This governs the \"selfservice.methods.passkey.enabled\" setting. | [optional] |
 | **kratos_selfservice_methods_password_config_haveibeenpwned_enabled** | **Boolean** | Configures whether Ory Kratos Password HIBP Checks is enabled  This governs the \"selfservice.methods.password.config.haveibeenpwned_enabled\" setting. | [optional] |
 | **kratos_selfservice_methods_password_config_identifier_similarity_check_enabled** | **Boolean** | Configures whether Ory Kratos Password should disable the similarity policy.  This governs the \"selfservice.methods.password.config.identifier_similarity_check_enabled\" setting. | [optional] |
@@ -461,11 +469,13 @@ instance = OryClient::CreateProjectNormalizedPayload.new(
   kratos_oauth2_provider_override_return_to: null,
   kratos_oauth2_provider_url: null,
   kratos_preview_default_read_consistency_level: null,
+  kratos_preview_enable_native_saml_engine: null,
   kratos_secrets_cipher: null,
   kratos_secrets_cookie: null,
   kratos_secrets_default: null,
   kratos_secrets_pagination: null,
   kratos_security_account_enumeration_mitigate: null,
+  kratos_security_restricted_origins: null,
   kratos_selfservice_allowed_return_urls: null,
   kratos_selfservice_default_browser_return_url: null,
   kratos_selfservice_flows_error_ui_url: null,
@@ -547,9 +557,15 @@ instance = OryClient::CreateProjectNormalizedPayload.new(
   kratos_selfservice_methods_oidc_config_providers: null,
   kratos_selfservice_methods_oidc_enable_auto_link_policy: null,
   kratos_selfservice_methods_oidc_enabled: null,
+  kratos_selfservice_methods_passkey_config_attestation_preference: null,
+  kratos_selfservice_methods_passkey_config_authenticator_selection_attachment: null,
+  kratos_selfservice_methods_passkey_config_authenticator_selection_resident_key: null,
+  kratos_selfservice_methods_passkey_config_authenticator_selection_user_verification: null,
   kratos_selfservice_methods_passkey_config_rp_display_name: null,
   kratos_selfservice_methods_passkey_config_rp_id: null,
   kratos_selfservice_methods_passkey_config_rp_origins: null,
+  kratos_selfservice_methods_passkey_config_timeouts_login: null,
+  kratos_selfservice_methods_passkey_config_timeouts_registration: null,
   kratos_selfservice_methods_passkey_enabled: null,
   kratos_selfservice_methods_password_config_haveibeenpwned_enabled: null,
   kratos_selfservice_methods_password_config_identifier_similarity_check_enabled: null,

data/docs/ErrorBrowserLocationChangeRequired.md

@@ -4,7 +4,7 @@
 
 | Name | Type | Description | Notes |
 | ---- | ---- | ----------- | ----- |
-| **error** | [**ErrorGeneric**](ErrorGeneric.md) |  | [optional] |
+| **error** | [**GenericError**](GenericError.md) |  | [optional] |
 | **redirect_browser_to** | **String** | Points to where to redirect the user to next. | [optional] |
 
 ## Example

data/docs/FrontendApi.md

@@ -25,13 +25,18 @@ All URIs are relative to *https://playground.projects.oryapis.com*
 | [**get_login_flow**](FrontendApi.md#get_login_flow) | **GET** /self-service/login/flows | Get Login Flow |
 | [**get_recovery_flow**](FrontendApi.md#get_recovery_flow) | **GET** /self-service/recovery/flows | Get Recovery Flow |
 | [**get_registration_flow**](FrontendApi.md#get_registration_flow) | **GET** /self-service/registration/flows | Get Registration Flow |
+| [**get_saml_metadata**](FrontendApi.md#get_saml_metadata) | **GET** /self-service/methods/saml/metadata | Get SAML SP Metadata |
+| [**get_saml_provider_metadata**](FrontendApi.md#get_saml_provider_metadata) | **GET** /self-service/methods/saml/metadata/{provider} | Get Per-Connection SAML SP Metadata |
 | [**get_settings_flow**](FrontendApi.md#get_settings_flow) | **GET** /self-service/settings/flows | Get Settings Flow |
 | [**get_verification_flow**](FrontendApi.md#get_verification_flow) | **GET** /self-service/verification/flows | Get Verification Flow |
 | [**get_web_authn_java_script**](FrontendApi.md#get_web_authn_java_script) | **GET** /.well-known/ory/webauthn.js | Get WebAuthn JavaScript |
 | [**get_web_authn_related_origins**](FrontendApi.md#get_web_authn_related_origins) | **GET** /.well-known/webauthn | Get WebAuthn Related Origins |
 | [**get_well_known_change_password**](FrontendApi.md#get_well_known_change_password) | **GET** /.well-known/change-password | Change Password URL |
+| [**init_saml_login**](FrontendApi.md#init_saml_login) | **GET** /self-service/methods/saml/init/{provider} | Initiate Native SAML Sign-In |
+| [**init_saml_login_request**](FrontendApi.md#init_saml_login_request) | **POST** /self-service/methods/saml/init/{provider} | Initiate Native SAML Sign-In (Direct POST) |
 | [**list_my_sessions**](FrontendApi.md#list_my_sessions) | **GET** /sessions | Get My Active Sessions |
 | [**perform_native_logout**](FrontendApi.md#perform_native_logout) | **DELETE** /self-service/logout/api | Perform Logout for Native Apps |
+| [**submit_saml_assertion**](FrontendApi.md#submit_saml_assertion) | **POST** /self-service/methods/saml/acs/{provider} | Native SAML Assertion Consumer Service (ACS) |
 | [**to_session**](FrontendApi.md#to_session) | **GET** /sessions/whoami | Check Who the Current HTTP Session Belongs To |
 | [**update_fedcm_flow**](FrontendApi.md#update_fedcm_flow) | **POST** /self-service/fed-cm/token | Submit a FedCM token |
 | [**update_login_flow**](FrontendApi.md#update_login_flow) | **POST** /self-service/login | Submit a Login Flow |
@@ -338,7 +343,7 @@ No authorization required
 
 Create Settings Flow for Browsers
 
-This endpoint initializes a browser-based user settings flow. Once initialized, the browser will be redirected to `selfservice.flows.settings.ui_url` with the flow ID set as the query parameter `?flow=`. If no valid Ory Kratos Session Cookie is included in the request, a login flow will be initialized.  If this endpoint is opened as a link in the browser, it will be redirected to `selfservice.flows.settings.ui_url` with the flow ID set as the query parameter `?flow=`. If no valid user session was set, the browser will be redirected to the login endpoint.  If this endpoint is called via an AJAX request, the response contains the settings flow without any redirects or a 401 forbidden error if no valid session was set.  Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor (happens automatically for server-side browser flows) or change the configuration.  If this endpoint is called via an AJAX request, the response contains the flow without a redirect. In the case of an error, the `error.id` of the JSON response body can be one of:  - `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. - `session_inactive`: No Ory Session was found - sign in a user first. - `security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration!  This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed.  More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
+This endpoint initializes a browser-based user settings flow. Once initialized, the browser will be redirected to `selfservice.flows.settings.ui_url` with the flow ID set as the query parameter `?flow=`. If no valid Ory Kratos Session Cookie is included in the request, a login flow will be initialized.  If this endpoint is opened as a link in the browser, it will be redirected to `selfservice.flows.settings.ui_url` with the flow ID set as the query parameter `?flow=`. If no valid user session was set, the browser will be redirected to the login endpoint.  If this endpoint is called via an AJAX request, the response contains the settings flow without any redirects or a 401 forbidden error if no valid session was set.  Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor (happens automatically for server-side browser flows) or change the configuration.  If this endpoint is called via an AJAX request, the response contains the flow without a redirect. In the case of an error, the `error.id` of the JSON response body can be one of:  - `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. - `session_inactive`: No Ory Session was found - sign in a user first. - `session_credential_required`: The session must be authenticated with a specific credential first. Follow `redirect_browser_to` to the login flow to sign in with it. - `security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration!  This endpoint is NOT INTENDED for clients that do not have a browser (Chrome, Firefox, ...) as cookies are needed.  More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
 
 ### Examples
 
@@ -814,7 +819,7 @@ No authorization required
 
 Create Settings Flow for Native Apps
 
-This endpoint initiates a settings flow for API clients such as mobile devices, smart TVs, and so on. You must provide a valid Ory Kratos Session Token for this endpoint to respond with HTTP 200 OK.  To fetch an existing settings flow call `/self-service/settings/flows?flow=<flow_id>`.  You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks.  Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor or change the configuration.  In the case of an error, the `error.id` of the JSON response body can be one of:  - `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. - `session_inactive`: No Ory Session was found - sign in a user first.  This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...).  More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
+This endpoint initiates a settings flow for API clients such as mobile devices, smart TVs, and so on. You must provide a valid Ory Kratos Session Token for this endpoint to respond with HTTP 200 OK.  To fetch an existing settings flow call `/self-service/settings/flows?flow=<flow_id>`.  You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make you vulnerable to a variety of CSRF attacks.  Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor or change the configuration.  In the case of an error, the `error.id` of the JSON response body can be one of:  - `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. - `session_inactive`: No Ory Session was found - sign in a user first. - `session_credential_required`: The session must be authenticated with a specific credential first. Follow `redirect_browser_to` to the login flow to sign in with it.  This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...).  More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
 
 ### Examples
 
@@ -1478,13 +1483,138 @@ No authorization required
 - **Accept**: application/json
 
 
+## get_saml_metadata
+
+> String get_saml_metadata
+
+Get SAML SP Metadata
+
+This endpoint serves the per-project SAML Service Provider metadata document: the SP entity ID and certificates this Ory Network project presents to every SAML identity provider by default. It is a public, unauthenticated, cacheable endpoint and never contains a private key.  By SAML SP convention, the returned entity ID is this endpoint's own URL. The native engine derives and uses it automatically as the default SP entity ID for every connection, so there is nothing to copy; share it with an identity provider administrator setting up SSO. A connection can present a different SP entity ID via `sp_entity_id_override`.  This endpoint 404s if no native SAML connection has been configured for this project yet (no SP signing key exists to publish).
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-client'
+
+api_instance = OryClient::FrontendApi.new
+
+begin
+  # Get SAML SP Metadata
+  result = api_instance.get_saml_metadata
+  p result
+rescue OryClient::ApiError => e
+  puts "Error when calling FrontendApi->get_saml_metadata: #{e}"
+end
+```
+
+#### Using the get_saml_metadata_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> get_saml_metadata_with_http_info
+
+```ruby
+begin
+  # Get SAML SP Metadata
+  data, status_code, headers = api_instance.get_saml_metadata_with_http_info
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue OryClient::ApiError => e
+  puts "Error when calling FrontendApi->get_saml_metadata_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**String**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## get_saml_provider_metadata
+
+> String get_saml_provider_metadata(provider)
+
+Get Per-Connection SAML SP Metadata
+
+This endpoint serves per-connection SAML Service Provider metadata: the identity and certificate a single native connection presents to its identity provider, including the connection's own Assertion Consumer Service (ACS) URL. It serves a document for any native connection; when the connection sets `sp_entity_id_override` the SP entity ID is that value, otherwise it is the project default.  It 404s -- with the identical generic response -- for an unknown connection ID, a connection disabled by invalid configuration, and a non-native connection, which manages its SP identity out of band.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-client'
+
+api_instance = OryClient::FrontendApi.new
+provider = 'provider_example' # String | The SAML connection ID to get metadata for.
+
+begin
+  # Get Per-Connection SAML SP Metadata
+  result = api_instance.get_saml_provider_metadata(provider)
+  p result
+rescue OryClient::ApiError => e
+  puts "Error when calling FrontendApi->get_saml_provider_metadata: #{e}"
+end
+```
+
+#### Using the get_saml_provider_metadata_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> get_saml_provider_metadata_with_http_info(provider)
+
+```ruby
+begin
+  # Get Per-Connection SAML SP Metadata
+  data, status_code, headers = api_instance.get_saml_provider_metadata_with_http_info(provider)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue OryClient::ApiError => e
+  puts "Error when calling FrontendApi->get_saml_provider_metadata_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **provider** | **String** | The SAML connection ID to get metadata for. |  |
+
+### Return type
+
+**String**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## get_settings_flow
 
 > <SettingsFlow> get_settings_flow(id, opts)
 
 Get Settings Flow
 
-When accessing this endpoint through Ory Kratos' Public API you must ensure that either the Ory Kratos Session Cookie or the Ory Kratos Session Token are set.  Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor or change the configuration.  You can access this endpoint without credentials when using Ory Kratos' Admin API.  If this endpoint is called via an AJAX request, the response contains the flow without a redirect. In the case of an error, the `error.id` of the JSON response body can be one of:  - `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. - `session_inactive`: No Ory Session was found - sign in a user first. - `security_identity_mismatch`: The flow was interrupted with `session_refresh_required` but apparently some other identity logged in instead.  More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
+When accessing this endpoint through Ory Kratos' Public API you must ensure that either the Ory Kratos Session Cookie or the Ory Kratos Session Token are set.  Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor or change the configuration.  You can access this endpoint without credentials when using Ory Kratos' Admin API.  If this endpoint is called via an AJAX request, the response contains the flow without a redirect. In the case of an error, the `error.id` of the JSON response body can be one of:  - `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. - `session_inactive`: No Ory Session was found - sign in a user first. - `session_credential_required`: The session must be authenticated with a specific credential first. Follow `redirect_browser_to` to the login flow to sign in with it. - `security_identity_mismatch`: The flow was interrupted with `session_refresh_required` but apparently some other identity logged in instead.  More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
 
 ### Examples
 
@@ -1799,6 +1929,142 @@ No authorization required
 - **Accept**: application/json
 
 
+## init_saml_login
+
+> String init_saml_login(provider, flow, purpose)
+
+Initiate Native SAML Sign-In
+
+This endpoint starts a native SP-initiated SAML sign-in for the given connection. It checks that the flow named by the `flow` query parameter exists as the kind named by `purpose`, builds a SAML AuthnRequest, and forwards the browser to the identity provider's Single Sign-On endpoint -- either with an HTTP 302 redirect (HTTP-Redirect binding) or by returning a self-submitting HTML form (HTTP-POST binding).  A login, registration, or settings flow redirects here as a browser navigation once a SAML connection has been selected. This endpoint is NOT INTENDED to be called directly by API clients: it is a browser navigation target, not a JSON API.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-client'
+
+api_instance = OryClient::FrontendApi.new
+provider = 'provider_example' # String | The SAML connection ID to start a native SP-initiated sign-in for.
+flow = 'flow_example' # String | The Login, Registration, or Settings Flow ID this SAML sign-in continues.
+purpose = 'login' # String | The kind of flow `flow` names: `login`, `registration`, or `settings-link` (a settings flow linking a new SAML credential). The flow must exist in the named kind, or the request is not found.
+
+begin
+  # Initiate Native SAML Sign-In
+  result = api_instance.init_saml_login(provider, flow, purpose)
+  p result
+rescue OryClient::ApiError => e
+  puts "Error when calling FrontendApi->init_saml_login: #{e}"
+end
+```
+
+#### Using the init_saml_login_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> init_saml_login_with_http_info(provider, flow, purpose)
+
+```ruby
+begin
+  # Initiate Native SAML Sign-In
+  data, status_code, headers = api_instance.init_saml_login_with_http_info(provider, flow, purpose)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue OryClient::ApiError => e
+  puts "Error when calling FrontendApi->init_saml_login_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **provider** | **String** | The SAML connection ID to start a native SP-initiated sign-in for. |  |
+| **flow** | **String** | The Login, Registration, or Settings Flow ID this SAML sign-in continues. |  |
+| **purpose** | **String** | The kind of flow &#x60;flow&#x60; names: &#x60;login&#x60;, &#x60;registration&#x60;, or &#x60;settings-link&#x60; (a settings flow linking a new SAML credential). The flow must exist in the named kind, or the request is not found. |  |
+
+### Return type
+
+**String**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
+## init_saml_login_request
+
+> String init_saml_login_request(provider, flow, purpose)
+
+Initiate Native SAML Sign-In (Direct POST)
+
+Identical to `GET /self-service/methods/saml/init/{provider}`, except the caller POSTs directly to this endpoint -- validated by the anti-CSRF middleware -- instead of being redirected here as a GET.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-client'
+
+api_instance = OryClient::FrontendApi.new
+provider = 'provider_example' # String | The SAML connection ID to start a native SP-initiated sign-in for.
+flow = 'flow_example' # String | The Login, Registration, or Settings Flow ID this SAML sign-in continues.
+purpose = 'login' # String | The kind of flow `flow` names: `login`, `registration`, or `settings-link` (a settings flow linking a new SAML credential). The flow must exist in the named kind, or the request is not found.
+
+begin
+  # Initiate Native SAML Sign-In (Direct POST)
+  result = api_instance.init_saml_login_request(provider, flow, purpose)
+  p result
+rescue OryClient::ApiError => e
+  puts "Error when calling FrontendApi->init_saml_login_request: #{e}"
+end
+```
+
+#### Using the init_saml_login_request_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(String, Integer, Hash)> init_saml_login_request_with_http_info(provider, flow, purpose)
+
+```ruby
+begin
+  # Initiate Native SAML Sign-In (Direct POST)
+  data, status_code, headers = api_instance.init_saml_login_request_with_http_info(provider, flow, purpose)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => String
+rescue OryClient::ApiError => e
+  puts "Error when calling FrontendApi->init_saml_login_request_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **provider** | **String** | The SAML connection ID to start a native SP-initiated sign-in for. |  |
+| **flow** | **String** | The Login, Registration, or Settings Flow ID this SAML sign-in continues. |  |
+| **purpose** | **String** | The kind of flow &#x60;flow&#x60; names: &#x60;login&#x60;, &#x60;registration&#x60;, or &#x60;settings-link&#x60; (a settings flow linking a new SAML credential). The flow must exist in the named kind, or the request is not found. |  |
+
+### Return type
+
+**String**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: Not defined
+- **Accept**: application/json
+
+
 ## list_my_sessions
 
 > <Array<Session>> list_my_sessions(opts)
@@ -1938,13 +2204,81 @@ No authorization required
 - **Accept**: application/json
 
 
+## submit_saml_assertion
+
+> <ErrorGeneric> submit_saml_assertion(provider, relay_state, saml_response)
+
+Native SAML Assertion Consumer Service (ACS)
+
+This is the Assertion Consumer Service (ACS) for the native SAML engine. The identity provider delivers its SAML Response here via the HTTP-POST binding, carrying the RelayState token that correlates it with the AuthnRequest issued by the init endpoint. On success the browser is redirected to complete the login, registration, or settings-link flow that started the sign-in.  This endpoint is posted to directly by the identity provider's browser and is NOT INTENDED to be called by API clients.  Every failure -- a replayed or unknown token, a malformed request, a provider mismatch, a response delivered to a browser other than the one that started the flow, or a signature/assertion validation failure -- is reported with the identical generic error, so the response body cannot be used to probe which check failed.
+
+### Examples
+
+```ruby
+require 'time'
+require 'ory-client'
+
+api_instance = OryClient::FrontendApi.new
+provider = 'provider_example' # String | The SAML connection ID this assertion is delivered for.
+relay_state = 'relay_state_example' # String | The opaque token that correlates this response with the AuthnRequest issued by `POST /self-service/methods/saml/init/{provider}`.  The PascalCase property name deliberately violates this API's snake_case convention: `RelayState` is the literal form-field name mandated by the SAML 2.0 HTTP-POST binding (OASIS SAML bindings spec), and every identity provider posts exactly this name. Do not rename it.
+saml_response = 'saml_response_example' # String | The base64-encoded, XML-serialized samlp:Response the identity provider produced for the AuthnRequest issued by `POST /self-service/methods/saml/init/{provider}`.  The PascalCase property name deliberately violates this API's snake_case convention: `SAMLResponse` is the literal form-field name mandated by the SAML 2.0 HTTP-POST binding (OASIS SAML bindings spec), and every identity provider posts exactly this name. Do not rename it.
+
+begin
+  # Native SAML Assertion Consumer Service (ACS)
+  result = api_instance.submit_saml_assertion(provider, relay_state, saml_response)
+  p result
+rescue OryClient::ApiError => e
+  puts "Error when calling FrontendApi->submit_saml_assertion: #{e}"
+end
+```
+
+#### Using the submit_saml_assertion_with_http_info variant
+
+This returns an Array which contains the response data, status code and headers.
+
+> <Array(<ErrorGeneric>, Integer, Hash)> submit_saml_assertion_with_http_info(provider, relay_state, saml_response)
+
+```ruby
+begin
+  # Native SAML Assertion Consumer Service (ACS)
+  data, status_code, headers = api_instance.submit_saml_assertion_with_http_info(provider, relay_state, saml_response)
+  p status_code # => 2xx
+  p headers # => { ... }
+  p data # => <ErrorGeneric>
+rescue OryClient::ApiError => e
+  puts "Error when calling FrontendApi->submit_saml_assertion_with_http_info: #{e}"
+end
+```
+
+### Parameters
+
+| Name | Type | Description | Notes |
+| ---- | ---- | ----------- | ----- |
+| **provider** | **String** | The SAML connection ID this assertion is delivered for. |  |
+| **relay_state** | **String** | The opaque token that correlates this response with the AuthnRequest issued by &#x60;POST /self-service/methods/saml/init/{provider}&#x60;.  The PascalCase property name deliberately violates this API&#39;s snake_case convention: &#x60;RelayState&#x60; is the literal form-field name mandated by the SAML 2.0 HTTP-POST binding (OASIS SAML bindings spec), and every identity provider posts exactly this name. Do not rename it. |  |
+| **saml_response** | **String** | The base64-encoded, XML-serialized samlp:Response the identity provider produced for the AuthnRequest issued by &#x60;POST /self-service/methods/saml/init/{provider}&#x60;.  The PascalCase property name deliberately violates this API&#39;s snake_case convention: &#x60;SAMLResponse&#x60; is the literal form-field name mandated by the SAML 2.0 HTTP-POST binding (OASIS SAML bindings spec), and every identity provider posts exactly this name. Do not rename it. |  |
+
+### Return type
+
+[**ErrorGeneric**](ErrorGeneric.md)
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+- **Content-Type**: application/x-www-form-urlencoded
+- **Accept**: application/json
+
+
 ## to_session
 
 > <Session> to_session(opts)
 
 Check Who the Current HTTP Session Belongs To
 
-Uses the HTTP Headers in the GET request to determine (e.g. by using checking the cookies) who is authenticated. Returns a session object in the body or 401 if the credentials are invalid or no credentials were sent. When the request it successful it adds the user ID to the 'X-Kratos-Authenticated-Identity-Id' header in the response.  If you call this endpoint from a server-side application, you must forward the HTTP Cookie Header to this endpoint:  ```js pseudo-code example router.get('/protected-endpoint', async function (req, res) { const session = await client.toSession(undefined, req.header('cookie'))  console.log(session) }) ```  When calling this endpoint from a non-browser application (e.g. mobile app) you must include the session token:  ```js pseudo-code example ... const session = await client.toSession(\"the-session-token\")  console.log(session) ```  When using a token template, the token is included in the `tokenized` field of the session.  ```js pseudo-code example ... const session = await client.toSession(\"the-session-token\", { tokenize_as: \"example-jwt-template\" })  console.log(session.tokenized) // The JWT ```  Depending on your configuration this endpoint might return a 403 status code if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor or change the configuration.  This endpoint is useful for:  - AJAX calls. Remember to send credentials and set up CORS correctly! - Reverse proxies and API Gateways - Server-side calls - use the `X-Session-Token` header!  This endpoint authenticates users by checking:  - if the `Cookie` HTTP header was set containing an Ory Kratos Session Cookie; - if the `Authorization: bearer <ory-session-token>` HTTP header was set with a valid Ory Kratos Session Token; - if the `X-Session-Token` HTTP header was set with a valid Ory Kratos Session Token.  If none of these headers are set or the cookie or token are invalid, the endpoint returns a HTTP 401 status code.  As explained above, this request may fail due to several reasons. The `error.id` can be one of:  - `session_inactive`: No active session was found in the request (e.g. no Ory Session Cookie / Ory Session Token). - `session_aal2_required`: An active session was found but it does not fulfil the Authenticator Assurance Level, implying that the session must (e.g.) authenticate the second factor. - `session_aal2_enrollment_required`: An active session was found but the required Authenticator Assurance Level can not be reached because the identity has no second factor enrolled. Follow `redirect_browser_to` to the settings flow to enroll one.
+Uses the HTTP Headers in the GET request to determine (e.g. by using checking the cookies) who is authenticated. Returns a session object in the body or 401 if the credentials are invalid or no credentials were sent. When the request it successful it adds the user ID to the 'X-Kratos-Authenticated-Identity-Id' header in the response. For requests from an origin in `security.restricted_origins`, the response contains only the session ID and `active`, and `tokenize_as` is rejected with a 400.  If you call this endpoint from a server-side application, you must forward the HTTP Cookie Header to this endpoint:  ```js pseudo-code example router.get('/protected-endpoint', async function (req, res) { const session = await client.toSession(undefined, req.header('cookie'))  console.log(session) }) ```  When calling this endpoint from a non-browser application (e.g. mobile app) you must include the session token:  ```js pseudo-code example ... const session = await client.toSession(\"the-session-token\")  console.log(session) ```  When using a token template, the token is included in the `tokenized` field of the session.  ```js pseudo-code example ... const session = await client.toSession(\"the-session-token\", { tokenize_as: \"example-jwt-template\" })  console.log(session.tokenized) // The JWT ```  Depending on your configuration this endpoint might return a 403 status code if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor or change the configuration.  This endpoint is useful for:  - AJAX calls. Remember to send credentials and set up CORS correctly! - Reverse proxies and API Gateways - Server-side calls - use the `X-Session-Token` header!  This endpoint authenticates users by checking:  - if the `Cookie` HTTP header was set containing an Ory Kratos Session Cookie; - if the `Authorization: bearer <ory-session-token>` HTTP header was set with a valid Ory Kratos Session Token; - if the `X-Session-Token` HTTP header was set with a valid Ory Kratos Session Token.  If none of these headers are set or the cookie or token are invalid, the endpoint returns a HTTP 401 status code.  As explained above, this request may fail due to several reasons. The `error.id` can be one of:  - `session_inactive`: No active session was found in the request (e.g. no Ory Session Cookie / Ory Session Token). - `session_aal2_required`: An active session was found but it does not fulfil the Authenticator Assurance Level, implying that the session must (e.g.) authenticate the second factor. - `session_aal2_enrollment_required`: An active session was found but the required Authenticator Assurance Level can not be reached because the identity has no second factor enrolled. Follow `redirect_browser_to` to the settings flow to enroll one. - `session_credential_required`: An active session was found but it must be authenticated with a specific credential first. Follow `redirect_browser_to` to the login flow to sign in with it.
 
 ### Examples
 
@@ -2361,7 +2695,7 @@ No authorization required
 
 Complete Settings Flow
 
-Use this endpoint to complete a settings flow by sending an identity's updated password. This endpoint behaves differently for API and browser flows.  API-initiated flows expect `application/json` to be sent in the body and respond with - HTTP 200 and an application/json body with the session token on success; - HTTP 303 redirect to a fresh settings flow if the original flow expired with the appropriate error messages set; - HTTP 400 on form validation errors. - HTTP 401 when the endpoint is called without a valid session token. - HTTP 403 when `selfservice.flows.settings.privileged_session_max_age` was reached or the session's AAL is too low. Implies that the user needs to re-authenticate.  Browser flows without HTTP Header `Accept` or with `Accept: text/*` respond with - a HTTP 303 redirect to the post/after settings URL or the `return_to` value if it was set and if the flow succeeded; - a HTTP 303 redirect to the Settings UI URL with the flow ID containing the validation errors otherwise. - a HTTP 303 redirect to the login endpoint when `selfservice.flows.settings.privileged_session_max_age` was reached or the session's AAL is too low.  Browser flows with HTTP Header `Accept: application/json` respond with - HTTP 200 and a application/json body with the signed in identity and a `Set-Cookie` header on success; - HTTP 303 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; - HTTP 401 when the endpoint is called without a valid session cookie. - HTTP 403 when the page is accessed without a session cookie or the session's AAL is too low. - HTTP 400 on form validation errors.  Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor (happens automatically for server-side browser flows) or change the configuration.  If this endpoint is called with a `Accept: application/json` HTTP header, the response contains the flow without a redirect. In the case of an error, the `error.id` of the JSON response body can be one of:  - `session_refresh_required`: The identity requested to change something that needs a privileged session. Redirect the identity to the login init endpoint with query parameters `?refresh=true&return_to=<the-current-browser-url>`, or initiate a refresh login flow otherwise. - `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. - `session_inactive`: No Ory Session was found - sign in a user first. - `security_identity_mismatch`: The flow was interrupted with `session_refresh_required` but apparently some other identity logged in instead. - `security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration! - `browser_location_change_required`: Usually sent when an AJAX request indicates that the browser needs to open a specific URL. Most likely used in Social Sign In flows.  More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
+Use this endpoint to complete a settings flow by sending an identity's updated password. This endpoint behaves differently for API and browser flows.  API-initiated flows expect `application/json` to be sent in the body and respond with - HTTP 200 and an application/json body with the session token on success; - HTTP 303 redirect to a fresh settings flow if the original flow expired with the appropriate error messages set; - HTTP 400 on form validation errors. - HTTP 401 when the endpoint is called without a valid session token. - HTTP 403 when `selfservice.flows.settings.privileged_session_max_age` was reached or the session's AAL is too low. Implies that the user needs to re-authenticate.  Browser flows without HTTP Header `Accept` or with `Accept: text/*` respond with - a HTTP 303 redirect to the post/after settings URL or the `return_to` value if it was set and if the flow succeeded; - a HTTP 303 redirect to the Settings UI URL with the flow ID containing the validation errors otherwise. - a HTTP 303 redirect to the login endpoint when `selfservice.flows.settings.privileged_session_max_age` was reached or the session's AAL is too low.  Browser flows with HTTP Header `Accept: application/json` respond with - HTTP 200 and a application/json body with the signed in identity and a `Set-Cookie` header on success; - HTTP 303 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; - HTTP 401 when the endpoint is called without a valid session cookie. - HTTP 403 when the page is accessed without a session cookie or the session's AAL is too low. - HTTP 400 on form validation errors.  Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user to sign in with the second factor (happens automatically for server-side browser flows) or change the configuration.  If this endpoint is called with a `Accept: application/json` HTTP header, the response contains the flow without a redirect. In the case of an error, the `error.id` of the JSON response body can be one of:  - `session_refresh_required`: The identity requested to change something that needs a privileged session. Redirect the identity to the login init endpoint with query parameters `?refresh=true&return_to=<the-current-browser-url>`, or initiate a refresh login flow otherwise. - `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. - `session_inactive`: No Ory Session was found - sign in a user first. - `session_credential_required`: The session must be authenticated with a specific credential first. Follow `redirect_browser_to` to the login flow to sign in with it. - `security_identity_mismatch`: The flow was interrupted with `session_refresh_required` but apparently some other identity logged in instead. - `security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration! - `browser_location_change_required`: Usually sent when an AJAX request indicates that the browser needs to open a specific URL. Most likely used in Social Sign In flows.  More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
 
 ### Examples
 

data/docs/IdentityApi.md

@@ -1035,7 +1035,7 @@ api_instance = OryClient::IdentityApi.new
 opts = {
   per_page: 789, # Integer | Deprecated Items per Page  DEPRECATED: Please use `page_token` instead. This parameter will be removed in the future.  This is the number of items per page.
   page: 789, # Integer | Deprecated Pagination Page  DEPRECATED: Please use `page_token` instead. This parameter will be removed in the future.  This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list.  For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist. The first page can be retrieved by omitting this parameter. Following page pointers will be returned in the `Link` header.
-  page_size: 789, # Integer | Page Size  This is the number of items per page to return. For details on pagination please head over to the [pagination documentation](https://www.ory.com/docs/ecosystem/api-design#pagination).
+  page_size: 789, # Integer | Page Size  This is the number of items per page to return. A larger value is capped at the maximum, so a response can contain fewer items than requested while more items exist. Follow the `next` link in the `Link` header to fetch the rest. For details on pagination please head over to the [pagination documentation](https://www.ory.com/docs/ecosystem/api-design#pagination).
   page_token: 'page_token_example', # String | Next Page Token  The next page token. For details on pagination please head over to the [pagination documentation](https://www.ory.com/docs/ecosystem/api-design#pagination).
   consistency: 'consistency_example', # String | Read Consistency Level (preview)  The read consistency level determines the consistency guarantee for reads:  - strong (slow): The read is guaranteed to return the most recent data committed at the start of the read. - eventual (very fast): The result will return data that is about 4.8 seconds old.  The default consistency guarantee can be changed in the Ory Network Console or using the Ory CLI with `ory patch project --replace '/previews/default_read_consistency_level=\"strong\"'`.  Setting the default consistency level to `eventual` may cause regressions in the future as we add consistency controls to more APIs. Currently, the following APIs will be affected by this setting:  - `GET /admin/identities`  This feature is in preview and only available in Ory Network.  ConsistencyLevelUnset is the unset / default consistency level. strong ConsistencyLevelStrong is the strong consistency level. eventual ConsistencyLevelEventual is the eventual consistency level using follower read timestamps.
   ids: ['inner_example'], # Array<String> | Retrieve multiple identities by their IDs.  This parameter has the following limitations:  - Duplicate or non-existent IDs are ignored. - The order of returned IDs may be different from the request. - This filter does not support pagination. You must implement your own pagination as the maximum number of items returned by this endpoint may not exceed a certain threshold (currently 500).
@@ -1078,7 +1078,7 @@ end
 | ---- | ---- | ----------- | ----- |
 | **per_page** | **Integer** | Deprecated Items per Page  DEPRECATED: Please use &#x60;page_token&#x60; instead. This parameter will be removed in the future.  This is the number of items per page. | [optional][default to 250] |
 | **page** | **Integer** | Deprecated Pagination Page  DEPRECATED: Please use &#x60;page_token&#x60; instead. This parameter will be removed in the future.  This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list.  For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist. The first page can be retrieved by omitting this parameter. Following page pointers will be returned in the &#x60;Link&#x60; header. | [optional] |
-| **page_size** | **Integer** | Page Size  This is the number of items per page to return. For details on pagination please head over to the [pagination documentation](https://www.ory.com/docs/ecosystem/api-design#pagination). | [optional][default to 250] |
+| **page_size** | **Integer** | Page Size  This is the number of items per page to return. A larger value is capped at the maximum, so a response can contain fewer items than requested while more items exist. Follow the &#x60;next&#x60; link in the &#x60;Link&#x60; header to fetch the rest. For details on pagination please head over to the [pagination documentation](https://www.ory.com/docs/ecosystem/api-design#pagination). | [optional][default to 250] |
 | **page_token** | **String** | Next Page Token  The next page token. For details on pagination please head over to the [pagination documentation](https://www.ory.com/docs/ecosystem/api-design#pagination). | [optional] |
 | **consistency** | **String** | Read Consistency Level (preview)  The read consistency level determines the consistency guarantee for reads:  - strong (slow): The read is guaranteed to return the most recent data committed at the start of the read. - eventual (very fast): The result will return data that is about 4.8 seconds old.  The default consistency guarantee can be changed in the Ory Network Console or using the Ory CLI with &#x60;ory patch project --replace &#39;/previews/default_read_consistency_level&#x3D;\&quot;strong\&quot;&#39;&#x60;.  Setting the default consistency level to &#x60;eventual&#x60; may cause regressions in the future as we add consistency controls to more APIs. Currently, the following APIs will be affected by this setting:  - &#x60;GET /admin/identities&#x60;  This feature is in preview and only available in Ory Network.  ConsistencyLevelUnset is the unset / default consistency level. strong ConsistencyLevelStrong is the strong consistency level. eventual ConsistencyLevelEventual is the eventual consistency level using follower read timestamps. | [optional] |
 | **ids** | [**Array&lt;String&gt;**](String.md) | Retrieve multiple identities by their IDs.  This parameter has the following limitations:  - Duplicate or non-existent IDs are ignored. - The order of returned IDs may be different from the request. - This filter does not support pagination. You must implement your own pagination as the maximum number of items returned by this endpoint may not exceed a certain threshold (currently 500). | [optional] |