ory-kratos-client 0.13.1 → 1.0.0

data/lib/ory-kratos-client/api/frontend_api.rb

@@ -3,7 +3,7 @@
 
 #This is the API specification for Ory Identities with features such as registration, login, recovery, account verification, profile settings, password reset, identity management, session management, email and sms delivery, and more. 
 
-The version of the OpenAPI document: v0.13.1
+The version of the OpenAPI document: v1.0.0
 Contact: office@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1
@@ -95,6 +95,7 @@ module OryKratosClient
     # This endpoint initializes a browser-based user logout flow and a URL which can be used to log out the user.  This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). For API clients you can call the `/self-service/logout/api` URL directly with the Ory Session Token.  The URL is only valid for the currently signed in user. If no user is signed in, this endpoint returns a 401 error.  When calling this endpoint from a backend, please ensure to properly forward the HTTP cookies.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :cookie HTTP Cookies  If you call this endpoint from a backend, please include the original Cookie header in the request.
+    # @option opts [String] :return_to Return to URL  The URL to which the browser should be redirected to after the logout has been performed.
     # @return [LogoutFlow]
     def create_browser_logout_flow(opts = {})
       data, _status_code, _headers = create_browser_logout_flow_with_http_info(opts)
@@ -105,6 +106,7 @@ module OryKratosClient
     # This endpoint initializes a browser-based user logout flow and a URL which can be used to log out the user.  This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). For API clients you can call the `/self-service/logout/api` URL directly with the Ory Session Token.  The URL is only valid for the currently signed in user. If no user is signed in, this endpoint returns a 401 error.  When calling this endpoint from a backend, please ensure to properly forward the HTTP cookies.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :cookie HTTP Cookies  If you call this endpoint from a backend, please include the original Cookie header in the request.
+    # @option opts [String] :return_to Return to URL  The URL to which the browser should be redirected to after the logout has been performed.
     # @return [Array<(LogoutFlow, Integer, Hash)>] LogoutFlow data, response status code and response headers
     def create_browser_logout_flow_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -115,6 +117,7 @@ module OryKratosClient
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'return_to'] = opts[:'return_to'] if !opts[:'return_to'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -406,6 +409,8 @@ module OryKratosClient
     # @option opts [Boolean] :refresh Refresh a login session  If set to true, this will refresh an existing login session by asking the user to sign in again. This will reset the authenticated_at time of the session.
     # @option opts [String] :aal Request a Specific AuthenticationMethod Assurance Level  Use this parameter to upgrade an existing session&#39;s authenticator assurance level (AAL). This allows you to ask for multi-factor authentication. When an identity sign in using e.g. username+password, the AAL is 1. If you wish to \&quot;upgrade\&quot; the session&#39;s security by asking the user to perform TOTP / WebAuth/ ... you would set this to \&quot;aal2\&quot;.
     # @option opts [String] :x_session_token The Session Token of the Identity performing the settings flow.
+    # @option opts [Boolean] :return_session_token_exchange_code EnableSessionTokenExchangeCode requests the login flow to include a code that can be used to retrieve the session token after the login flow has been completed.
+    # @option opts [String] :return_to The URL to return the browser to after the flow was completed.
     # @return [LoginFlow]
     def create_native_login_flow(opts = {})
       data, _status_code, _headers = create_native_login_flow_with_http_info(opts)
@@ -418,6 +423,8 @@ module OryKratosClient
     # @option opts [Boolean] :refresh Refresh a login session  If set to true, this will refresh an existing login session by asking the user to sign in again. This will reset the authenticated_at time of the session.
     # @option opts [String] :aal Request a Specific AuthenticationMethod Assurance Level  Use this parameter to upgrade an existing session&#39;s authenticator assurance level (AAL). This allows you to ask for multi-factor authentication. When an identity sign in using e.g. username+password, the AAL is 1. If you wish to \&quot;upgrade\&quot; the session&#39;s security by asking the user to perform TOTP / WebAuth/ ... you would set this to \&quot;aal2\&quot;.
     # @option opts [String] :x_session_token The Session Token of the Identity performing the settings flow.
+    # @option opts [Boolean] :return_session_token_exchange_code EnableSessionTokenExchangeCode requests the login flow to include a code that can be used to retrieve the session token after the login flow has been completed.
+    # @option opts [String] :return_to The URL to return the browser to after the flow was completed.
     # @return [Array<(LoginFlow, Integer, Hash)>] LoginFlow data, response status code and response headers
     def create_native_login_flow_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -430,6 +437,8 @@ module OryKratosClient
       query_params = opts[:query_params] || {}
       query_params[:'refresh'] = opts[:'refresh'] if !opts[:'refresh'].nil?
       query_params[:'aal'] = opts[:'aal'] if !opts[:'aal'].nil?
+      query_params[:'return_session_token_exchange_code'] = opts[:'return_session_token_exchange_code'] if !opts[:'return_session_token_exchange_code'].nil?
+      query_params[:'return_to'] = opts[:'return_to'] if !opts[:'return_to'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -526,6 +535,8 @@ module OryKratosClient
     # Create Registration Flow for Native Apps
     # This endpoint initiates a registration flow for API clients such as mobile devices, smart TVs, and so on.  If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query parameter `?refresh=true` is set.  To fetch an existing registration flow call `/self-service/registration/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.  In the case of an error, the `error.id` of the JSON response body can be one of:  `session_already_available`: The user is already signed in. `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred.  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 Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :return_session_token_exchange_code EnableSessionTokenExchangeCode requests the login flow to include a code that can be used to retrieve the session token after the login flow has been completed.
+    # @option opts [String] :return_to The URL to return the browser to after the flow was completed.
     # @return [RegistrationFlow]
     def create_native_registration_flow(opts = {})
       data, _status_code, _headers = create_native_registration_flow_with_http_info(opts)
@@ -535,6 +546,8 @@ module OryKratosClient
     # Create Registration Flow for Native Apps
     # This endpoint initiates a registration flow for API clients such as mobile devices, smart TVs, and so on.  If a valid provided session cookie or session token is provided, a 400 Bad Request error will be returned unless the URL query parameter &#x60;?refresh&#x3D;true&#x60; is set.  To fetch an existing registration flow call &#x60;/self-service/registration/flows?flow&#x3D;&lt;flow_id&gt;&#x60;.  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.  In the case of an error, the &#x60;error.id&#x60; of the JSON response body can be one of:  &#x60;session_already_available&#x60;: The user is already signed in. &#x60;security_csrf_violation&#x60;: Unable to fetch the flow because a CSRF violation occurred.  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 Login](https://www.ory.sh/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-registration).
     # @param [Hash] opts the optional parameters
+    # @option opts [Boolean] :return_session_token_exchange_code EnableSessionTokenExchangeCode requests the login flow to include a code that can be used to retrieve the session token after the login flow has been completed.
+    # @option opts [String] :return_to The URL to return the browser to after the flow was completed.
     # @return [Array<(RegistrationFlow, Integer, Hash)>] RegistrationFlow data, response status code and response headers
     def create_native_registration_flow_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -545,6 +558,8 @@ module OryKratosClient
 
       # query parameters
       query_params = opts[:query_params] || {}
+      query_params[:'return_session_token_exchange_code'] = opts[:'return_session_token_exchange_code'] if !opts[:'return_session_token_exchange_code'].nil?
+      query_params[:'return_to'] = opts[:'return_to'] if !opts[:'return_to'].nil?
 
       # header parameters
       header_params = opts[:header_params] || {}
@@ -829,6 +844,75 @@ module OryKratosClient
       return data, status_code, headers
     end
 
+    # Exchange Session Token
+    # @param init_code [String] The part of the code return when initializing the flow.
+    # @param return_to_code [String] The part of the code returned by the return_to URL.
+    # @param [Hash] opts the optional parameters
+    # @return [SuccessfulNativeLogin]
+    def exchange_session_token(init_code, return_to_code, opts = {})
+      data, _status_code, _headers = exchange_session_token_with_http_info(init_code, return_to_code, opts)
+      data
+    end
+
+    # Exchange Session Token
+    # @param init_code [String] The part of the code return when initializing the flow.
+    # @param return_to_code [String] The part of the code returned by the return_to URL.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(SuccessfulNativeLogin, Integer, Hash)>] SuccessfulNativeLogin data, response status code and response headers
+    def exchange_session_token_with_http_info(init_code, return_to_code, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: FrontendApi.exchange_session_token ...'
+      end
+      # verify the required parameter 'init_code' is set
+      if @api_client.config.client_side_validation && init_code.nil?
+        fail ArgumentError, "Missing the required parameter 'init_code' when calling FrontendApi.exchange_session_token"
+      end
+      # verify the required parameter 'return_to_code' is set
+      if @api_client.config.client_side_validation && return_to_code.nil?
+        fail ArgumentError, "Missing the required parameter 'return_to_code' when calling FrontendApi.exchange_session_token"
+      end
+      # resource path
+      local_var_path = '/sessions/token-exchange'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'init_code'] = init_code
+      query_params[:'return_to_code'] = return_to_code
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'SuccessfulNativeLogin'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"FrontendApi.exchange_session_token",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: FrontendApi#exchange_session_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get User-Flow Errors
     # This endpoint returns the error associated with a user-facing self service errors.  This endpoint supports stub values to help you implement the error UI:  `?id=stub:500` - returns a stub 500 (Internal Server Error) error.  More information can be found at [Ory Kratos User User Facing Error Documentation](https://www.ory.sh/docs/kratos/self-service/flows/user-facing-errors).
     # @param id [String] Error is the error&#39;s ID
@@ -1438,7 +1522,7 @@ module OryKratosClient
     end
 
     # 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) ```  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 cooke 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.
+    # 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) ```  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.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :x_session_token Set the Session Token when calling from non-browser clients. A session token has a format of &#x60;MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj&#x60;.
     # @option opts [String] :cookie Set the Cookie Header. This is especially useful when calling this endpoint from a server-side application. In that scenario you must include the HTTP Cookie Header which originally was included in the request to your server. An example of a session in the HTTP Cookie Header is: &#x60;ory_kratos_session&#x3D;a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9DWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f&#x3D;&#x3D;&#x60;.  It is ok if more than one cookie are included here as all other cookies will be ignored.
@@ -1449,7 +1533,7 @@ module OryKratosClient
     end
 
     # 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 &#39;X-Kratos-Authenticated-Identity-Id&#39; header in the response.  If you call this endpoint from a server-side application, you must forward the HTTP Cookie Header to this endpoint:  &#x60;&#x60;&#x60;js pseudo-code example router.get(&#39;/protected-endpoint&#39;, async function (req, res) { const session &#x3D; await client.toSession(undefined, req.header(&#39;cookie&#39;))  console.log(session) }) &#x60;&#x60;&#x60;  When calling this endpoint from a non-browser application (e.g. mobile app) you must include the session token:  &#x60;&#x60;&#x60;js pseudo-code example ... const session &#x3D; await client.toSession(\&quot;the-session-token\&quot;)  console.log(session) &#x60;&#x60;&#x60;  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 &#x60;X-Session-Token&#x60; header!  This endpoint authenticates users by checking:  if the &#x60;Cookie&#x60; HTTP header was set containing an Ory Kratos Session Cookie; if the &#x60;Authorization: bearer &lt;ory-session-token&gt;&#x60; HTTP header was set with a valid Ory Kratos Session Token; if the &#x60;X-Session-Token&#x60; HTTP header was set with a valid Ory Kratos Session Token.  If none of these headers are set or the cooke or token are invalid, the endpoint returns a HTTP 401 status code.  As explained above, this request may fail due to several reasons. The &#x60;error.id&#x60; can be one of:  &#x60;session_inactive&#x60;: No active session was found in the request (e.g. no Ory Session Cookie / Ory Session Token). &#x60;session_aal2_required&#x60;: 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.
+    # 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 &#39;X-Kratos-Authenticated-Identity-Id&#39; header in the response.  If you call this endpoint from a server-side application, you must forward the HTTP Cookie Header to this endpoint:  &#x60;&#x60;&#x60;js pseudo-code example router.get(&#39;/protected-endpoint&#39;, async function (req, res) { const session &#x3D; await client.toSession(undefined, req.header(&#39;cookie&#39;))  console.log(session) }) &#x60;&#x60;&#x60;  When calling this endpoint from a non-browser application (e.g. mobile app) you must include the session token:  &#x60;&#x60;&#x60;js pseudo-code example ... const session &#x3D; await client.toSession(\&quot;the-session-token\&quot;)  console.log(session) &#x60;&#x60;&#x60;  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 &#x60;X-Session-Token&#x60; header!  This endpoint authenticates users by checking:  if the &#x60;Cookie&#x60; HTTP header was set containing an Ory Kratos Session Cookie; if the &#x60;Authorization: bearer &lt;ory-session-token&gt;&#x60; HTTP header was set with a valid Ory Kratos Session Token; if the &#x60;X-Session-Token&#x60; 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 &#x60;error.id&#x60; can be one of:  &#x60;session_inactive&#x60;: No active session was found in the request (e.g. no Ory Session Cookie / Ory Session Token). &#x60;session_aal2_required&#x60;: 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.
     # @param [Hash] opts the optional parameters
     # @option opts [String] :x_session_token Set the Session Token when calling from non-browser clients. A session token has a format of &#x60;MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj&#x60;.
     # @option opts [String] :cookie Set the Cookie Header. This is especially useful when calling this endpoint from a server-side application. In that scenario you must include the HTTP Cookie Header which originally was included in the request to your server. An example of a session in the HTTP Cookie Header is: &#x60;ory_kratos_session&#x3D;a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9DWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f&#x3D;&#x3D;&#x60;.  It is ok if more than one cookie are included here as all other cookies will be ignored.
@@ -1586,6 +1670,7 @@ module OryKratosClient
     # @param [Hash] opts the optional parameters
     # @option opts [String] :token A Valid Logout Token  If you do not have a logout token because you only have a session cookie, call &#x60;/self-service/logout/browser&#x60; to generate a URL for this endpoint.
     # @option opts [String] :return_to The URL to return to after the logout was completed.
+    # @option opts [String] :cookie 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.
     # @return [nil]
     def update_logout_flow(opts = {})
       update_logout_flow_with_http_info(opts)
@@ -1597,6 +1682,7 @@ module OryKratosClient
     # @param [Hash] opts the optional parameters
     # @option opts [String] :token A Valid Logout Token  If you do not have a logout token because you only have a session cookie, call &#x60;/self-service/logout/browser&#x60; to generate a URL for this endpoint.
     # @option opts [String] :return_to The URL to return to after the logout was completed.
+    # @option opts [String] :cookie 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.
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def update_logout_flow_with_http_info(opts = {})
       if @api_client.config.debugging
@@ -1614,6 +1700,7 @@ module OryKratosClient
       header_params = opts[:header_params] || {}
       # HTTP header 'Accept' (if needed)
       header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+      header_params[:'Cookie'] = opts[:'cookie'] if !opts[:'cookie'].nil?
 
       # form parameters
       form_params = opts[:form_params] || {}

data/lib/ory-kratos-client/api/identity_api.rb

@@ -3,7 +3,7 @@
 
 #This is the API specification for Ory Identities with features such as registration, login, recovery, account verification, profile settings, password reset, identity management, session management, email and sms delivery, and more. 
 
-The version of the OpenAPI document: v0.13.1
+The version of the OpenAPI document: v1.0.0
 Contact: office@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1
@@ -343,10 +343,10 @@ module OryKratosClient
     # @param id [String] ID is the identity's ID.
     # @param type [String] Type is the credential's Type. One of totp, webauthn, lookup
     # @param [Hash] opts the optional parameters
-    # @return [Identity]
+    # @return [nil]
     def delete_identity_credentials(id, type, opts = {})
-      data, _status_code, _headers = delete_identity_credentials_with_http_info(id, type, opts)
-      data
+      delete_identity_credentials_with_http_info(id, type, opts)
+      nil
     end
 
     # Delete a credential for a specific identity
@@ -354,7 +354,7 @@ module OryKratosClient
     # @param id [String] ID is the identity's ID.
     # @param type [String] Type is the credential's Type. One of totp, webauthn, lookup
     # @param [Hash] opts the optional parameters
-    # @return [Array<(Identity, Integer, Hash)>] Identity data, response status code and response headers
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
     def delete_identity_credentials_with_http_info(id, type, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: IdentityApi.delete_identity_credentials ...'
@@ -390,7 +390,7 @@ module OryKratosClient
       post_body = opts[:debug_body]
 
       # return_type
-      return_type = opts[:debug_return_type] || 'Identity'
+      return_type = opts[:debug_return_type]
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['oryAccessToken']
@@ -605,7 +605,7 @@ module OryKratosClient
     # Return an [identity](https://www.ory.sh/docs/kratos/concepts/identity-user-model) by its ID. You can optionally include credentials (e.g. social sign in connections) in the response by using the `include_credential` query parameter.
     # @param id [String] ID must be set to the ID of identity you want to get
     # @param [Hash] opts the optional parameters
-    # @option opts [Array<String>] :include_credential Include Credentials in Response  Currently, only &#x60;oidc&#x60; is supported. This will return the initial OAuth 2.0 Access, Refresh and (optionally) OpenID Connect ID Token.
+    # @option opts [Array<String>] :include_credential Include Credentials in Response  Include any credential, for example &#x60;password&#x60; or &#x60;oidc&#x60;, in the response. When set to &#x60;oidc&#x60;, This will return the initial OAuth 2.0 Access Token, OAuth 2.0 Refresh Token and the OpenID Connect ID Token if available.
     # @return [Identity]
     def get_identity(id, opts = {})
       data, _status_code, _headers = get_identity_with_http_info(id, opts)
@@ -616,7 +616,7 @@ module OryKratosClient
     # Return an [identity](https://www.ory.sh/docs/kratos/concepts/identity-user-model) by its ID. You can optionally include credentials (e.g. social sign in connections) in the response by using the &#x60;include_credential&#x60; query parameter.
     # @param id [String] ID must be set to the ID of identity you want to get
     # @param [Hash] opts the optional parameters
-    # @option opts [Array<String>] :include_credential Include Credentials in Response  Currently, only &#x60;oidc&#x60; is supported. This will return the initial OAuth 2.0 Access, Refresh and (optionally) OpenID Connect ID Token.
+    # @option opts [Array<String>] :include_credential Include Credentials in Response  Include any credential, for example &#x60;password&#x60; or &#x60;oidc&#x60;, in the response. When set to &#x60;oidc&#x60;, This will return the initial OAuth 2.0 Access Token, OAuth 2.0 Refresh Token and the OpenID Connect ID Token if available.
     # @return [Array<(Identity, Integer, Hash)>] Identity data, response status code and response headers
     def get_identity_with_http_info(id, opts = {})
       if @api_client.config.debugging
@@ -626,6 +626,10 @@ module OryKratosClient
       if @api_client.config.client_side_validation && id.nil?
         fail ArgumentError, "Missing the required parameter 'id' when calling IdentityApi.get_identity"
       end
+      allowable_values = ["password", "totp", "oidc", "webauthn", "lookup_secret"]
+      if @api_client.config.client_side_validation && opts[:'include_credential'] && !opts[:'include_credential'].all? { |item| allowable_values.include?(item) }
+        fail ArgumentError, "invalid value for \"include_credential\", must include one of #{allowable_values}"
+      end
       # resource path
       local_var_path = '/admin/identities/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))
 

data/lib/ory-kratos-client/api/metadata_api.rb

@@ -3,7 +3,7 @@
 
 #This is the API specification for Ory Identities with features such as registration, login, recovery, account verification, profile settings, password reset, identity management, session management, email and sms delivery, and more. 
 
-The version of the OpenAPI document: v0.13.1
+The version of the OpenAPI document: v1.0.0
 Contact: office@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1

data/lib/ory-kratos-client/api_client.rb

@@ -3,7 +3,7 @@
 
 #This is the API specification for Ory Identities with features such as registration, login, recovery, account verification, profile settings, password reset, identity management, session management, email and sms delivery, and more. 
 
-The version of the OpenAPI document: v0.13.1
+The version of the OpenAPI document: v1.0.0
 Contact: office@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1

data/lib/ory-kratos-client/api_error.rb

@@ -3,7 +3,7 @@
 
 #This is the API specification for Ory Identities with features such as registration, login, recovery, account verification, profile settings, password reset, identity management, session management, email and sms delivery, and more. 
 
-The version of the OpenAPI document: v0.13.1
+The version of the OpenAPI document: v1.0.0
 Contact: office@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1

data/lib/ory-kratos-client/configuration.rb

@@ -3,7 +3,7 @@
 
 #This is the API specification for Ory Identities with features such as registration, login, recovery, account verification, profile settings, password reset, identity management, session management, email and sms delivery, and more. 
 
-The version of the OpenAPI document: v0.13.1
+The version of the OpenAPI document: v1.0.0
 Contact: office@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1

data/lib/ory-kratos-client/models/authenticator_assurance_level.rb

@@ -3,7 +3,7 @@
 
 #This is the API specification for Ory Identities with features such as registration, login, recovery, account verification, profile settings, password reset, identity management, session management, email and sms delivery, and more. 
 
-The version of the OpenAPI document: v0.13.1
+The version of the OpenAPI document: v1.0.0
 Contact: office@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1

data/lib/ory-kratos-client/models/batch_patch_identities_response.rb

@@ -3,7 +3,7 @@
 
 #This is the API specification for Ory Identities with features such as registration, login, recovery, account verification, profile settings, password reset, identity management, session management, email and sms delivery, and more. 
 
-The version of the OpenAPI document: v0.13.1
+The version of the OpenAPI document: v1.0.0
 Contact: office@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1

data/lib/ory-kratos-client/models/continue_with.rb

@@ -3,7 +3,7 @@
 
 #This is the API specification for Ory Identities with features such as registration, login, recovery, account verification, profile settings, password reset, identity management, session management, email and sms delivery, and more. 
 
-The version of the OpenAPI document: v0.13.1
+The version of the OpenAPI document: v1.0.0
 Contact: office@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1

data/lib/ory-kratos-client/models/continue_with_set_ory_session_token.rb

@@ -3,7 +3,7 @@
 
 #This is the API specification for Ory Identities with features such as registration, login, recovery, account verification, profile settings, password reset, identity management, session management, email and sms delivery, and more. 
 
-The version of the OpenAPI document: v0.13.1
+The version of the OpenAPI document: v1.0.0
 Contact: office@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1

data/lib/ory-kratos-client/models/continue_with_verification_ui.rb

@@ -3,7 +3,7 @@
 
 #This is the API specification for Ory Identities with features such as registration, login, recovery, account verification, profile settings, password reset, identity management, session management, email and sms delivery, and more. 
 
-The version of the OpenAPI document: v0.13.1
+The version of the OpenAPI document: v1.0.0
 Contact: office@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1

data/lib/ory-kratos-client/models/continue_with_verification_ui_flow.rb

@@ -3,7 +3,7 @@
 
 #This is the API specification for Ory Identities with features such as registration, login, recovery, account verification, profile settings, password reset, identity management, session management, email and sms delivery, and more. 
 
-The version of the OpenAPI document: v0.13.1
+The version of the OpenAPI document: v1.0.0
 Contact: office@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1

data/lib/ory-kratos-client/models/courier_message_status.rb

@@ -3,7 +3,7 @@
 
 #This is the API specification for Ory Identities with features such as registration, login, recovery, account verification, profile settings, password reset, identity management, session management, email and sms delivery, and more. 
 
-The version of the OpenAPI document: v0.13.1
+The version of the OpenAPI document: v1.0.0
 Contact: office@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1

data/lib/ory-kratos-client/models/courier_message_type.rb

@@ -3,7 +3,7 @@
 
 #This is the API specification for Ory Identities with features such as registration, login, recovery, account verification, profile settings, password reset, identity management, session management, email and sms delivery, and more. 
 
-The version of the OpenAPI document: v0.13.1
+The version of the OpenAPI document: v1.0.0
 Contact: office@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1

data/lib/ory-kratos-client/models/create_identity_body.rb

@@ -3,7 +3,7 @@
 
 #This is the API specification for Ory Identities with features such as registration, login, recovery, account verification, profile settings, password reset, identity management, session management, email and sms delivery, and more. 
 
-The version of the OpenAPI document: v0.13.1
+The version of the OpenAPI document: v1.0.0
 Contact: office@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1

data/lib/ory-kratos-client/models/create_recovery_code_for_identity_body.rb

@@ -3,7 +3,7 @@
 
 #This is the API specification for Ory Identities with features such as registration, login, recovery, account verification, profile settings, password reset, identity management, session management, email and sms delivery, and more. 
 
-The version of the OpenAPI document: v0.13.1
+The version of the OpenAPI document: v1.0.0
 Contact: office@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1

data/lib/ory-kratos-client/models/create_recovery_link_for_identity_body.rb

@@ -3,7 +3,7 @@
 
 #This is the API specification for Ory Identities with features such as registration, login, recovery, account verification, profile settings, password reset, identity management, session management, email and sms delivery, and more. 
 
-The version of the OpenAPI document: v0.13.1
+The version of the OpenAPI document: v1.0.0
 Contact: office@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1

data/lib/ory-kratos-client/models/delete_my_sessions_count.rb

@@ -3,7 +3,7 @@
 
 #This is the API specification for Ory Identities with features such as registration, login, recovery, account verification, profile settings, password reset, identity management, session management, email and sms delivery, and more. 
 
-The version of the OpenAPI document: v0.13.1
+The version of the OpenAPI document: v1.0.0
 Contact: office@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1

data/lib/ory-kratos-client/models/error_authenticator_assurance_level_not_satisfied.rb

@@ -3,7 +3,7 @@
 
 #This is the API specification for Ory Identities with features such as registration, login, recovery, account verification, profile settings, password reset, identity management, session management, email and sms delivery, and more. 
 
-The version of the OpenAPI document: v0.13.1
+The version of the OpenAPI document: v1.0.0
 Contact: office@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1

data/lib/ory-kratos-client/models/error_browser_location_change_required.rb

@@ -3,7 +3,7 @@
 
 #This is the API specification for Ory Identities with features such as registration, login, recovery, account verification, profile settings, password reset, identity management, session management, email and sms delivery, and more. 
 
-The version of the OpenAPI document: v0.13.1
+The version of the OpenAPI document: v1.0.0
 Contact: office@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1

data/lib/ory-kratos-client/models/error_flow_replaced.rb

@@ -3,7 +3,7 @@
 
 #This is the API specification for Ory Identities with features such as registration, login, recovery, account verification, profile settings, password reset, identity management, session management, email and sms delivery, and more. 
 
-The version of the OpenAPI document: v0.13.1
+The version of the OpenAPI document: v1.0.0
 Contact: office@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1

data/lib/ory-kratos-client/models/error_generic.rb

@@ -3,7 +3,7 @@
 
 #This is the API specification for Ory Identities with features such as registration, login, recovery, account verification, profile settings, password reset, identity management, session management, email and sms delivery, and more. 
 
-The version of the OpenAPI document: v0.13.1
+The version of the OpenAPI document: v1.0.0
 Contact: office@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1

data/lib/ory-kratos-client/models/flow_error.rb

@@ -3,7 +3,7 @@
 
 #This is the API specification for Ory Identities with features such as registration, login, recovery, account verification, profile settings, password reset, identity management, session management, email and sms delivery, and more. 
 
-The version of the OpenAPI document: v0.13.1
+The version of the OpenAPI document: v1.0.0
 Contact: office@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1

data/lib/ory-kratos-client/models/generic_error.rb

@@ -3,7 +3,7 @@
 
 #This is the API specification for Ory Identities with features such as registration, login, recovery, account verification, profile settings, password reset, identity management, session management, email and sms delivery, and more. 
 
-The version of the OpenAPI document: v0.13.1
+The version of the OpenAPI document: v1.0.0
 Contact: office@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1

data/lib/ory-kratos-client/models/get_version200_response.rb

@@ -3,7 +3,7 @@
 
 #This is the API specification for Ory Identities with features such as registration, login, recovery, account verification, profile settings, password reset, identity management, session management, email and sms delivery, and more. 
 
-The version of the OpenAPI document: v0.13.1
+The version of the OpenAPI document: v1.0.0
 Contact: office@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1

data/lib/ory-kratos-client/models/health_not_ready_status.rb

@@ -3,7 +3,7 @@
 
 #This is the API specification for Ory Identities with features such as registration, login, recovery, account verification, profile settings, password reset, identity management, session management, email and sms delivery, and more. 
 
-The version of the OpenAPI document: v0.13.1
+The version of the OpenAPI document: v1.0.0
 Contact: office@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1

data/lib/ory-kratos-client/models/health_status.rb

@@ -3,7 +3,7 @@
 
 #This is the API specification for Ory Identities with features such as registration, login, recovery, account verification, profile settings, password reset, identity management, session management, email and sms delivery, and more. 
 
-The version of the OpenAPI document: v0.13.1
+The version of the OpenAPI document: v1.0.0
 Contact: office@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1

data/lib/ory-kratos-client/models/identity.rb

@@ -3,7 +3,7 @@
 
 #This is the API specification for Ory Identities with features such as registration, login, recovery, account verification, profile settings, password reset, identity management, session management, email and sms delivery, and more. 
 
-The version of the OpenAPI document: v0.13.1
+The version of the OpenAPI document: v1.0.0
 Contact: office@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1

data/lib/ory-kratos-client/models/identity_credentials.rb

@@ -3,7 +3,7 @@
 
 #This is the API specification for Ory Identities with features such as registration, login, recovery, account verification, profile settings, password reset, identity management, session management, email and sms delivery, and more. 
 
-The version of the OpenAPI document: v0.13.1
+The version of the OpenAPI document: v1.0.0
 Contact: office@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1

data/lib/ory-kratos-client/models/identity_credentials_oidc.rb

@@ -3,7 +3,7 @@
 
 #This is the API specification for Ory Identities with features such as registration, login, recovery, account verification, profile settings, password reset, identity management, session management, email and sms delivery, and more. 
 
-The version of the OpenAPI document: v0.13.1
+The version of the OpenAPI document: v1.0.0
 Contact: office@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1

data/lib/ory-kratos-client/models/identity_credentials_oidc_provider.rb

@@ -3,7 +3,7 @@
 
 #This is the API specification for Ory Identities with features such as registration, login, recovery, account verification, profile settings, password reset, identity management, session management, email and sms delivery, and more. 
 
-The version of the OpenAPI document: v0.13.1
+The version of the OpenAPI document: v1.0.0
 Contact: office@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1

data/lib/ory-kratos-client/models/identity_credentials_password.rb

@@ -3,7 +3,7 @@
 
 #This is the API specification for Ory Identities with features such as registration, login, recovery, account verification, profile settings, password reset, identity management, session management, email and sms delivery, and more. 
 
-The version of the OpenAPI document: v0.13.1
+The version of the OpenAPI document: v1.0.0
 Contact: office@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1

data/lib/ory-kratos-client/models/identity_credentials_type.rb

@@ -3,7 +3,7 @@
 
 #This is the API specification for Ory Identities with features such as registration, login, recovery, account verification, profile settings, password reset, identity management, session management, email and sms delivery, and more. 
 
-The version of the OpenAPI document: v0.13.1
+The version of the OpenAPI document: v1.0.0
 Contact: office@ory.sh
 Generated by: https://openapi-generator.tech
 OpenAPI Generator version: 6.0.1