# OryClient::FrontendApi All URIs are relative to *https://playground.projects.oryapis.com* | Method | HTTP request | Description | | ------ | ------------ | ----------- | | [**create_browser_login_flow**](FrontendApi.md#create_browser_login_flow) | **GET** /self-service/login/browser | Create Login Flow for Browsers | | [**create_browser_logout_flow**](FrontendApi.md#create_browser_logout_flow) | **GET** /self-service/logout/browser | Create a Logout URL for Browsers | | [**create_browser_recovery_flow**](FrontendApi.md#create_browser_recovery_flow) | **GET** /self-service/recovery/browser | Create Recovery Flow for Browsers | | [**create_browser_registration_flow**](FrontendApi.md#create_browser_registration_flow) | **GET** /self-service/registration/browser | Create Registration Flow for Browsers | | [**create_browser_settings_flow**](FrontendApi.md#create_browser_settings_flow) | **GET** /self-service/settings/browser | Create Settings Flow for Browsers | | [**create_browser_verification_flow**](FrontendApi.md#create_browser_verification_flow) | **GET** /self-service/verification/browser | Create Verification Flow for Browser Clients | | [**create_native_login_flow**](FrontendApi.md#create_native_login_flow) | **GET** /self-service/login/api | Create Login Flow for Native Apps | | [**create_native_recovery_flow**](FrontendApi.md#create_native_recovery_flow) | **GET** /self-service/recovery/api | Create Recovery Flow for Native Apps | | [**create_native_registration_flow**](FrontendApi.md#create_native_registration_flow) | **GET** /self-service/registration/api | Create Registration Flow for Native Apps | | [**create_native_settings_flow**](FrontendApi.md#create_native_settings_flow) | **GET** /self-service/settings/api | Create Settings Flow for Native Apps | | [**create_native_verification_flow**](FrontendApi.md#create_native_verification_flow) | **GET** /self-service/verification/api | Create Verification Flow for Native Apps | | [**disable_my_other_sessions**](FrontendApi.md#disable_my_other_sessions) | **DELETE** /sessions | Disable my other sessions | | [**disable_my_session**](FrontendApi.md#disable_my_session) | **DELETE** /sessions/{id} | Disable one of my sessions | | [**exchange_session_token**](FrontendApi.md#exchange_session_token) | **GET** /sessions/token-exchange | Exchange Session Token | | [**get_flow_error**](FrontendApi.md#get_flow_error) | **GET** /self-service/errors | Get User-Flow Errors | | [**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_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 | | [**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 | | [**to_session**](FrontendApi.md#to_session) | **GET** /sessions/whoami | Check Who the Current HTTP Session Belongs To | | [**update_login_flow**](FrontendApi.md#update_login_flow) | **POST** /self-service/login | Submit a Login Flow | | [**update_logout_flow**](FrontendApi.md#update_logout_flow) | **GET** /self-service/logout | Update Logout Flow | | [**update_recovery_flow**](FrontendApi.md#update_recovery_flow) | **POST** /self-service/recovery | Update Recovery Flow | | [**update_registration_flow**](FrontendApi.md#update_registration_flow) | **POST** /self-service/registration | Update Registration Flow | | [**update_settings_flow**](FrontendApi.md#update_settings_flow) | **POST** /self-service/settings | Complete Settings Flow | | [**update_verification_flow**](FrontendApi.md#update_verification_flow) | **POST** /self-service/verification | Complete Verification Flow | ## create_browser_login_flow > create_browser_login_flow(opts) Create Login Flow for Browsers This endpoint initializes a browser-based user login flow. This endpoint will set the appropriate cookies and anti-CSRF measures required for browser-based flows. If this endpoint is opened as a link in the browser, it will be redirected to `selfservice.flows.login.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists already, the browser will be redirected to `urls.default_redirect_url` unless the query parameter `?refresh=true` was set. 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: `session_already_available`: The user is already signed in. `session_aal1_required`: Multi-factor auth (e.g. 2fa) was requested but the user has no session yet. `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. `security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration! The optional query parameter login_challenge is set when using Kratos with Hydra in an OAuth2 flow. See the oauth2_provider.url configuration option. 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 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). ### Examples ```ruby require 'time' require 'ory-client' api_instance = OryClient::FrontendApi.new opts = { refresh: true, # Boolean | 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. aal: 'aal_example', # String | Request a Specific AuthenticationMethod Assurance Level Use this parameter to upgrade an existing session'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 \"upgrade\" the session's security by asking the user to perform TOTP / WebAuth/ ... you would set this to \"aal2\". return_to: 'return_to_example', # String | The URL to return the browser to after the flow was completed. cookie: 'cookie_example', # String | 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. login_challenge: 'login_challenge_example', # String | An optional Hydra login challenge. If present, Kratos will cooperate with Ory Hydra to act as an OAuth2 identity provider. The value for this parameter comes from `login_challenge` URL Query parameter sent to your application (e.g. `/login?login_challenge=abcde`). organization: 'organization_example', # String | An optional organization ID that should be used for logging this user in. This parameter is only effective in the Ory Network. via: 'via_example' # String | Via should contain the identity's credential the code should be sent to. Only relevant in aal2 flows. } begin # Create Login Flow for Browsers result = api_instance.create_browser_login_flow(opts) p result rescue OryClient::ApiError => e puts "Error when calling FrontendApi->create_browser_login_flow: #{e}" end ``` #### Using the create_browser_login_flow_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> create_browser_login_flow_with_http_info(opts) ```ruby begin # Create Login Flow for Browsers data, status_code, headers = api_instance.create_browser_login_flow_with_http_info(opts) p status_code # => 2xx p headers # => { ... } p data # => rescue OryClient::ApiError => e puts "Error when calling FrontendApi->create_browser_login_flow_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **refresh** | **Boolean** | 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. | [optional] | | **aal** | **String** | Request a Specific AuthenticationMethod Assurance Level Use this parameter to upgrade an existing session'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 \"upgrade\" the session's security by asking the user to perform TOTP / WebAuth/ ... you would set this to \"aal2\". | [optional] | | **return_to** | **String** | The URL to return the browser to after the flow was completed. | [optional] | | **cookie** | **String** | HTTP Cookies When using the SDK in a browser app, on the server side you must include the HTTP Cookie Header sent by the client to your server here. This ensures that CSRF and session cookies are respected. | [optional] | | **login_challenge** | **String** | An optional Hydra login challenge. If present, Kratos will cooperate with Ory Hydra to act as an OAuth2 identity provider. The value for this parameter comes from `login_challenge` URL Query parameter sent to your application (e.g. `/login?login_challenge=abcde`). | [optional] | | **organization** | **String** | An optional organization ID that should be used for logging this user in. This parameter is only effective in the Ory Network. | [optional] | | **via** | **String** | Via should contain the identity's credential the code should be sent to. Only relevant in aal2 flows. | [optional] | ### Return type [**LoginFlow**](LoginFlow.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## create_browser_logout_flow > create_browser_logout_flow(opts) Create a Logout URL for Browsers 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. ### Examples ```ruby require 'time' require 'ory-client' api_instance = OryClient::FrontendApi.new opts = { cookie: 'cookie_example', # String | HTTP Cookies If you call this endpoint from a backend, please include the original Cookie header in the request. return_to: 'return_to_example' # String | Return to URL The URL to which the browser should be redirected to after the logout has been performed. } begin # Create a Logout URL for Browsers result = api_instance.create_browser_logout_flow(opts) p result rescue OryClient::ApiError => e puts "Error when calling FrontendApi->create_browser_logout_flow: #{e}" end ``` #### Using the create_browser_logout_flow_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> create_browser_logout_flow_with_http_info(opts) ```ruby begin # Create a Logout URL for Browsers data, status_code, headers = api_instance.create_browser_logout_flow_with_http_info(opts) p status_code # => 2xx p headers # => { ... } p data # => rescue OryClient::ApiError => e puts "Error when calling FrontendApi->create_browser_logout_flow_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **cookie** | **String** | HTTP Cookies If you call this endpoint from a backend, please include the original Cookie header in the request. | [optional] | | **return_to** | **String** | Return to URL The URL to which the browser should be redirected to after the logout has been performed. | [optional] | ### Return type [**LogoutFlow**](LogoutFlow.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## create_browser_recovery_flow > create_browser_recovery_flow(opts) Create Recovery Flow for Browsers This endpoint initializes a browser-based account recovery flow. Once initialized, the browser will be redirected to `selfservice.flows.recovery.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists, the browser is returned to the configured return URL. If this endpoint is called via an AJAX request, the response contains the recovery flow without any redirects or a 400 bad request error if the user is already authenticated. 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 Account Recovery Documentation](../self-service/flows/account-recovery). ### Examples ```ruby require 'time' require 'ory-client' api_instance = OryClient::FrontendApi.new opts = { return_to: 'return_to_example' # String | The URL to return the browser to after the flow was completed. } begin # Create Recovery Flow for Browsers result = api_instance.create_browser_recovery_flow(opts) p result rescue OryClient::ApiError => e puts "Error when calling FrontendApi->create_browser_recovery_flow: #{e}" end ``` #### Using the create_browser_recovery_flow_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> create_browser_recovery_flow_with_http_info(opts) ```ruby begin # Create Recovery Flow for Browsers data, status_code, headers = api_instance.create_browser_recovery_flow_with_http_info(opts) p status_code # => 2xx p headers # => { ... } p data # => rescue OryClient::ApiError => e puts "Error when calling FrontendApi->create_browser_recovery_flow_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **return_to** | **String** | The URL to return the browser to after the flow was completed. | [optional] | ### Return type [**RecoveryFlow**](RecoveryFlow.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## create_browser_registration_flow > create_browser_registration_flow(opts) Create Registration Flow for Browsers This endpoint initializes a browser-based user registration flow. This endpoint will set the appropriate cookies and anti-CSRF measures required for browser-based flows. If this endpoint is opened as a link in the browser, it will be redirected to `selfservice.flows.registration.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session exists already, the browser will be redirected to `urls.default_redirect_url`. 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: `session_already_available`: The user is already signed in. `security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred. `security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration! If this endpoint is called via an AJAX request, the response contains the registration flow without a redirect. 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 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). ### Examples ```ruby require 'time' require 'ory-client' api_instance = OryClient::FrontendApi.new opts = { return_to: 'return_to_example', # String | The URL to return the browser to after the flow was completed. login_challenge: 'login_challenge_example', # String | Ory OAuth 2.0 Login Challenge. If set will cooperate with Ory OAuth2 and OpenID to act as an OAuth2 server / OpenID Provider. The value for this parameter comes from `login_challenge` URL Query parameter sent to your application (e.g. `/registration?login_challenge=abcde`). This feature is compatible with Ory Hydra when not running on the Ory Network. after_verification_return_to: 'after_verification_return_to_example', # String | The URL to return the browser to after the verification flow was completed. After the registration flow is completed, the user will be sent a verification email. Upon completing the verification flow, this URL will be used to override the default `selfservice.flows.verification.after.default_redirect_to` value. organization: 'organization_example' # String | } begin # Create Registration Flow for Browsers result = api_instance.create_browser_registration_flow(opts) p result rescue OryClient::ApiError => e puts "Error when calling FrontendApi->create_browser_registration_flow: #{e}" end ``` #### Using the create_browser_registration_flow_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> create_browser_registration_flow_with_http_info(opts) ```ruby begin # Create Registration Flow for Browsers data, status_code, headers = api_instance.create_browser_registration_flow_with_http_info(opts) p status_code # => 2xx p headers # => { ... } p data # => rescue OryClient::ApiError => e puts "Error when calling FrontendApi->create_browser_registration_flow_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **return_to** | **String** | The URL to return the browser to after the flow was completed. | [optional] | | **login_challenge** | **String** | Ory OAuth 2.0 Login Challenge. If set will cooperate with Ory OAuth2 and OpenID to act as an OAuth2 server / OpenID Provider. The value for this parameter comes from `login_challenge` URL Query parameter sent to your application (e.g. `/registration?login_challenge=abcde`). This feature is compatible with Ory Hydra when not running on the Ory Network. | [optional] | | **after_verification_return_to** | **String** | The URL to return the browser to after the verification flow was completed. After the registration flow is completed, the user will be sent a verification email. Upon completing the verification flow, this URL will be used to override the default `selfservice.flows.verification.after.default_redirect_to` value. | [optional] | | **organization** | **String** | | [optional] | ### Return type [**RegistrationFlow**](RegistrationFlow.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## create_browser_settings_flow > create_browser_settings_flow(opts) 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). ### Examples ```ruby require 'time' require 'ory-client' api_instance = OryClient::FrontendApi.new opts = { return_to: 'return_to_example', # String | The URL to return the browser to after the flow was completed. cookie: 'cookie_example' # String | 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. } begin # Create Settings Flow for Browsers result = api_instance.create_browser_settings_flow(opts) p result rescue OryClient::ApiError => e puts "Error when calling FrontendApi->create_browser_settings_flow: #{e}" end ``` #### Using the create_browser_settings_flow_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> create_browser_settings_flow_with_http_info(opts) ```ruby begin # Create Settings Flow for Browsers data, status_code, headers = api_instance.create_browser_settings_flow_with_http_info(opts) p status_code # => 2xx p headers # => { ... } p data # => rescue OryClient::ApiError => e puts "Error when calling FrontendApi->create_browser_settings_flow_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **return_to** | **String** | The URL to return the browser to after the flow was completed. | [optional] | | **cookie** | **String** | HTTP Cookies When using the SDK in a browser app, on the server side you must include the HTTP Cookie Header sent by the client to your server here. This ensures that CSRF and session cookies are respected. | [optional] | ### Return type [**SettingsFlow**](SettingsFlow.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## create_browser_verification_flow > create_browser_verification_flow(opts) Create Verification Flow for Browser Clients This endpoint initializes a browser-based account verification flow. Once initialized, the browser will be redirected to `selfservice.flows.verification.ui_url` with the flow ID set as the query parameter `?flow=`. If this endpoint is called via an AJAX request, the response contains the recovery flow without any redirects. This endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...). More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/self-service/flows/verify-email-account-activation). ### Examples ```ruby require 'time' require 'ory-client' api_instance = OryClient::FrontendApi.new opts = { return_to: 'return_to_example' # String | The URL to return the browser to after the flow was completed. } begin # Create Verification Flow for Browser Clients result = api_instance.create_browser_verification_flow(opts) p result rescue OryClient::ApiError => e puts "Error when calling FrontendApi->create_browser_verification_flow: #{e}" end ``` #### Using the create_browser_verification_flow_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> create_browser_verification_flow_with_http_info(opts) ```ruby begin # Create Verification Flow for Browser Clients data, status_code, headers = api_instance.create_browser_verification_flow_with_http_info(opts) p status_code # => 2xx p headers # => { ... } p data # => rescue OryClient::ApiError => e puts "Error when calling FrontendApi->create_browser_verification_flow_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **return_to** | **String** | The URL to return the browser to after the flow was completed. | [optional] | ### Return type [**VerificationFlow**](VerificationFlow.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## create_native_login_flow > create_native_login_flow(opts) Create Login Flow for Native Apps This endpoint initiates a login flow for native apps that do not use a browser, 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 login flow call `/self-service/login/flows?flow=`. 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, including CSRF login 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. `session_aal1_required`: Multi-factor auth (e.g. 2fa) was requested but the user has no session yet. `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). ### Examples ```ruby require 'time' require 'ory-client' api_instance = OryClient::FrontendApi.new opts = { refresh: true, # Boolean | 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. aal: 'aal_example', # String | Request a Specific AuthenticationMethod Assurance Level Use this parameter to upgrade an existing session'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 \"upgrade\" the session's security by asking the user to perform TOTP / WebAuth/ ... you would set this to \"aal2\". x_session_token: 'x_session_token_example', # String | The Session Token of the Identity performing the settings flow. return_session_token_exchange_code: true, # Boolean | 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. return_to: 'return_to_example', # String | The URL to return the browser to after the flow was completed. via: 'via_example' # String | Via should contain the identity's credential the code should be sent to. Only relevant in aal2 flows. } begin # Create Login Flow for Native Apps result = api_instance.create_native_login_flow(opts) p result rescue OryClient::ApiError => e puts "Error when calling FrontendApi->create_native_login_flow: #{e}" end ``` #### Using the create_native_login_flow_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> create_native_login_flow_with_http_info(opts) ```ruby begin # Create Login Flow for Native Apps data, status_code, headers = api_instance.create_native_login_flow_with_http_info(opts) p status_code # => 2xx p headers # => { ... } p data # => rescue OryClient::ApiError => e puts "Error when calling FrontendApi->create_native_login_flow_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **refresh** | **Boolean** | 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. | [optional] | | **aal** | **String** | Request a Specific AuthenticationMethod Assurance Level Use this parameter to upgrade an existing session'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 \"upgrade\" the session's security by asking the user to perform TOTP / WebAuth/ ... you would set this to \"aal2\". | [optional] | | **x_session_token** | **String** | The Session Token of the Identity performing the settings flow. | [optional] | | **return_session_token_exchange_code** | **Boolean** | 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. | [optional] | | **return_to** | **String** | The URL to return the browser to after the flow was completed. | [optional] | | **via** | **String** | Via should contain the identity's credential the code should be sent to. Only relevant in aal2 flows. | [optional] | ### Return type [**LoginFlow**](LoginFlow.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## create_native_recovery_flow > create_native_recovery_flow Create Recovery Flow for Native Apps This endpoint initiates a recovery 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. On an existing recovery flow, use the `getRecoveryFlow` API endpoint. 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. 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 Account Recovery Documentation](../self-service/flows/account-recovery). ### Examples ```ruby require 'time' require 'ory-client' api_instance = OryClient::FrontendApi.new begin # Create Recovery Flow for Native Apps result = api_instance.create_native_recovery_flow p result rescue OryClient::ApiError => e puts "Error when calling FrontendApi->create_native_recovery_flow: #{e}" end ``` #### Using the create_native_recovery_flow_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> create_native_recovery_flow_with_http_info ```ruby begin # Create Recovery Flow for Native Apps data, status_code, headers = api_instance.create_native_recovery_flow_with_http_info p status_code # => 2xx p headers # => { ... } p data # => rescue OryClient::ApiError => e puts "Error when calling FrontendApi->create_native_recovery_flow_with_http_info: #{e}" end ``` ### Parameters This endpoint does not need any parameter. ### Return type [**RecoveryFlow**](RecoveryFlow.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## create_native_registration_flow > create_native_registration_flow(opts) 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=`. 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). ### Examples ```ruby require 'time' require 'ory-client' api_instance = OryClient::FrontendApi.new opts = { return_session_token_exchange_code: true, # Boolean | 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. return_to: 'return_to_example' # String | The URL to return the browser to after the flow was completed. } begin # Create Registration Flow for Native Apps result = api_instance.create_native_registration_flow(opts) p result rescue OryClient::ApiError => e puts "Error when calling FrontendApi->create_native_registration_flow: #{e}" end ``` #### Using the create_native_registration_flow_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> create_native_registration_flow_with_http_info(opts) ```ruby begin # Create Registration Flow for Native Apps data, status_code, headers = api_instance.create_native_registration_flow_with_http_info(opts) p status_code # => 2xx p headers # => { ... } p data # => rescue OryClient::ApiError => e puts "Error when calling FrontendApi->create_native_registration_flow_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **return_session_token_exchange_code** | **Boolean** | 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. | [optional] | | **return_to** | **String** | The URL to return the browser to after the flow was completed. | [optional] | ### Return type [**RegistrationFlow**](RegistrationFlow.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## create_native_settings_flow > create_native_settings_flow(opts) 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=`. 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). ### Examples ```ruby require 'time' require 'ory-client' api_instance = OryClient::FrontendApi.new opts = { x_session_token: 'x_session_token_example' # String | The Session Token of the Identity performing the settings flow. } begin # Create Settings Flow for Native Apps result = api_instance.create_native_settings_flow(opts) p result rescue OryClient::ApiError => e puts "Error when calling FrontendApi->create_native_settings_flow: #{e}" end ``` #### Using the create_native_settings_flow_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> create_native_settings_flow_with_http_info(opts) ```ruby begin # Create Settings Flow for Native Apps data, status_code, headers = api_instance.create_native_settings_flow_with_http_info(opts) p status_code # => 2xx p headers # => { ... } p data # => rescue OryClient::ApiError => e puts "Error when calling FrontendApi->create_native_settings_flow_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **x_session_token** | **String** | The Session Token of the Identity performing the settings flow. | [optional] | ### Return type [**SettingsFlow**](SettingsFlow.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## create_native_verification_flow > create_native_verification_flow Create Verification Flow for Native Apps This endpoint initiates a verification flow for API clients such as mobile devices, smart TVs, and so on. To fetch an existing verification flow call `/self-service/verification/flows?flow=`. 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. 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 Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/self-service/flows/verify-email-account-activation). ### Examples ```ruby require 'time' require 'ory-client' api_instance = OryClient::FrontendApi.new begin # Create Verification Flow for Native Apps result = api_instance.create_native_verification_flow p result rescue OryClient::ApiError => e puts "Error when calling FrontendApi->create_native_verification_flow: #{e}" end ``` #### Using the create_native_verification_flow_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> create_native_verification_flow_with_http_info ```ruby begin # Create Verification Flow for Native Apps data, status_code, headers = api_instance.create_native_verification_flow_with_http_info p status_code # => 2xx p headers # => { ... } p data # => rescue OryClient::ApiError => e puts "Error when calling FrontendApi->create_native_verification_flow_with_http_info: #{e}" end ``` ### Parameters This endpoint does not need any parameter. ### Return type [**VerificationFlow**](VerificationFlow.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## disable_my_other_sessions > disable_my_other_sessions(opts) Disable my other sessions Calling this endpoint invalidates all except the current session that belong to the logged-in user. Session data are not deleted. ### Examples ```ruby require 'time' require 'ory-client' api_instance = OryClient::FrontendApi.new opts = { x_session_token: 'x_session_token_example', # String | Set the Session Token when calling from non-browser clients. A session token has a format of `MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj`. cookie: 'cookie_example' # String | 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: `ory_kratos_session=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9DWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f==`. It is ok if more than one cookie are included here as all other cookies will be ignored. } begin # Disable my other sessions result = api_instance.disable_my_other_sessions(opts) p result rescue OryClient::ApiError => e puts "Error when calling FrontendApi->disable_my_other_sessions: #{e}" end ``` #### Using the disable_my_other_sessions_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> disable_my_other_sessions_with_http_info(opts) ```ruby begin # Disable my other sessions data, status_code, headers = api_instance.disable_my_other_sessions_with_http_info(opts) p status_code # => 2xx p headers # => { ... } p data # => rescue OryClient::ApiError => e puts "Error when calling FrontendApi->disable_my_other_sessions_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **x_session_token** | **String** | Set the Session Token when calling from non-browser clients. A session token has a format of `MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj`. | [optional] | | **cookie** | **String** | 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: `ory_kratos_session=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9DWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f==`. It is ok if more than one cookie are included here as all other cookies will be ignored. | [optional] | ### Return type [**DeleteMySessionsCount**](DeleteMySessionsCount.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## disable_my_session > disable_my_session(id, opts) Disable one of my sessions Calling this endpoint invalidates the specified session. The current session cannot be revoked. Session data are not deleted. ### Examples ```ruby require 'time' require 'ory-client' api_instance = OryClient::FrontendApi.new id = 'id_example' # String | ID is the session's ID. opts = { x_session_token: 'x_session_token_example', # String | Set the Session Token when calling from non-browser clients. A session token has a format of `MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj`. cookie: 'cookie_example' # String | 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: `ory_kratos_session=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9DWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f==`. It is ok if more than one cookie are included here as all other cookies will be ignored. } begin # Disable one of my sessions api_instance.disable_my_session(id, opts) rescue OryClient::ApiError => e puts "Error when calling FrontendApi->disable_my_session: #{e}" end ``` #### Using the disable_my_session_with_http_info variant This returns an Array which contains the response data (`nil` in this case), status code and headers. > disable_my_session_with_http_info(id, opts) ```ruby begin # Disable one of my sessions data, status_code, headers = api_instance.disable_my_session_with_http_info(id, opts) p status_code # => 2xx p headers # => { ... } p data # => nil rescue OryClient::ApiError => e puts "Error when calling FrontendApi->disable_my_session_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **id** | **String** | ID is the session's ID. | | | **x_session_token** | **String** | Set the Session Token when calling from non-browser clients. A session token has a format of `MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj`. | [optional] | | **cookie** | **String** | 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: `ory_kratos_session=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9DWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f==`. It is ok if more than one cookie are included here as all other cookies will be ignored. | [optional] | ### Return type nil (empty response body) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## exchange_session_token > exchange_session_token(init_code, return_to_code) Exchange Session Token ### Examples ```ruby require 'time' require 'ory-client' api_instance = OryClient::FrontendApi.new init_code = 'init_code_example' # String | The part of the code return when initializing the flow. return_to_code = 'return_to_code_example' # String | The part of the code returned by the return_to URL. begin # Exchange Session Token result = api_instance.exchange_session_token(init_code, return_to_code) p result rescue OryClient::ApiError => e puts "Error when calling FrontendApi->exchange_session_token: #{e}" end ``` #### Using the exchange_session_token_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> exchange_session_token_with_http_info(init_code, return_to_code) ```ruby begin # Exchange Session Token data, status_code, headers = api_instance.exchange_session_token_with_http_info(init_code, return_to_code) p status_code # => 2xx p headers # => { ... } p data # => rescue OryClient::ApiError => e puts "Error when calling FrontendApi->exchange_session_token_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **init_code** | **String** | The part of the code return when initializing the flow. | | | **return_to_code** | **String** | The part of the code returned by the return_to URL. | | ### Return type [**SuccessfulNativeLogin**](SuccessfulNativeLogin.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## get_flow_error > get_flow_error(id) 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). ### Examples ```ruby require 'time' require 'ory-client' api_instance = OryClient::FrontendApi.new id = 'id_example' # String | Error is the error's ID begin # Get User-Flow Errors result = api_instance.get_flow_error(id) p result rescue OryClient::ApiError => e puts "Error when calling FrontendApi->get_flow_error: #{e}" end ``` #### Using the get_flow_error_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> get_flow_error_with_http_info(id) ```ruby begin # Get User-Flow Errors data, status_code, headers = api_instance.get_flow_error_with_http_info(id) p status_code # => 2xx p headers # => { ... } p data # => rescue OryClient::ApiError => e puts "Error when calling FrontendApi->get_flow_error_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **id** | **String** | Error is the error's ID | | ### Return type [**FlowError**](FlowError.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## get_login_flow > get_login_flow(id, opts) Get Login Flow This endpoint returns a login flow's context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request's HTTP Cookie Header. For AJAX requests you must ensure that cookies are included in the request or requests will fail. If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward the incoming HTTP Cookie header to this endpoint: ```js pseudo-code example router.get('/login', async function (req, res) { const flow = await client.getLoginFlow(req.header('cookie'), req.query['flow']) res.render('login', flow) }) ``` This request may fail due to several reasons. The `error.id` can be one of: `session_already_available`: The user is already signed in. `self_service_flow_expired`: The flow is expired and you should request a new one. 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). ### Examples ```ruby require 'time' require 'ory-client' api_instance = OryClient::FrontendApi.new id = 'id_example' # String | The Login Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/login?flow=abcde`). opts = { cookie: 'cookie_example' # String | 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. } begin # Get Login Flow result = api_instance.get_login_flow(id, opts) p result rescue OryClient::ApiError => e puts "Error when calling FrontendApi->get_login_flow: #{e}" end ``` #### Using the get_login_flow_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> get_login_flow_with_http_info(id, opts) ```ruby begin # Get Login Flow data, status_code, headers = api_instance.get_login_flow_with_http_info(id, opts) p status_code # => 2xx p headers # => { ... } p data # => rescue OryClient::ApiError => e puts "Error when calling FrontendApi->get_login_flow_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **id** | **String** | The Login Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/login?flow=abcde`). | | | **cookie** | **String** | HTTP Cookies When using the SDK in a browser app, on the server side you must include the HTTP Cookie Header sent by the client to your server here. This ensures that CSRF and session cookies are respected. | [optional] | ### Return type [**LoginFlow**](LoginFlow.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## get_recovery_flow > get_recovery_flow(id, opts) Get Recovery Flow This endpoint returns a recovery flow's context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request's HTTP Cookie Header. For AJAX requests you must ensure that cookies are included in the request or requests will fail. If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward the incoming HTTP Cookie header to this endpoint: ```js pseudo-code example router.get('/recovery', async function (req, res) { const flow = await client.getRecoveryFlow(req.header('Cookie'), req.query['flow']) res.render('recovery', flow) }) ``` More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery). ### Examples ```ruby require 'time' require 'ory-client' api_instance = OryClient::FrontendApi.new id = 'id_example' # String | The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/recovery?flow=abcde`). opts = { cookie: 'cookie_example' # String | 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. } begin # Get Recovery Flow result = api_instance.get_recovery_flow(id, opts) p result rescue OryClient::ApiError => e puts "Error when calling FrontendApi->get_recovery_flow: #{e}" end ``` #### Using the get_recovery_flow_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> get_recovery_flow_with_http_info(id, opts) ```ruby begin # Get Recovery Flow data, status_code, headers = api_instance.get_recovery_flow_with_http_info(id, opts) p status_code # => 2xx p headers # => { ... } p data # => rescue OryClient::ApiError => e puts "Error when calling FrontendApi->get_recovery_flow_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **id** | **String** | The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/recovery?flow=abcde`). | | | **cookie** | **String** | HTTP Cookies When using the SDK in a browser app, on the server side you must include the HTTP Cookie Header sent by the client to your server here. This ensures that CSRF and session cookies are respected. | [optional] | ### Return type [**RecoveryFlow**](RecoveryFlow.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## get_registration_flow > get_registration_flow(id, opts) Get Registration Flow This endpoint returns a registration flow's context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request's HTTP Cookie Header. For AJAX requests you must ensure that cookies are included in the request or requests will fail. If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward the incoming HTTP Cookie header to this endpoint: ```js pseudo-code example router.get('/registration', async function (req, res) { const flow = await client.getRegistrationFlow(req.header('cookie'), req.query['flow']) res.render('registration', flow) }) ``` This request may fail due to several reasons. The `error.id` can be one of: `session_already_available`: The user is already signed in. `self_service_flow_expired`: The flow is expired and you should request a new one. 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). ### Examples ```ruby require 'time' require 'ory-client' api_instance = OryClient::FrontendApi.new id = 'id_example' # String | The Registration Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/registration?flow=abcde`). opts = { cookie: 'cookie_example' # String | 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. } begin # Get Registration Flow result = api_instance.get_registration_flow(id, opts) p result rescue OryClient::ApiError => e puts "Error when calling FrontendApi->get_registration_flow: #{e}" end ``` #### Using the get_registration_flow_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> get_registration_flow_with_http_info(id, opts) ```ruby begin # Get Registration Flow data, status_code, headers = api_instance.get_registration_flow_with_http_info(id, opts) p status_code # => 2xx p headers # => { ... } p data # => rescue OryClient::ApiError => e puts "Error when calling FrontendApi->get_registration_flow_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **id** | **String** | The Registration Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/registration?flow=abcde`). | | | **cookie** | **String** | HTTP Cookies When using the SDK in a browser app, on the server side you must include the HTTP Cookie Header sent by the client to your server here. This ensures that CSRF and session cookies are respected. | [optional] | ### Return type [**RegistrationFlow**](RegistrationFlow.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## get_settings_flow > 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). ### Examples ```ruby require 'time' require 'ory-client' api_instance = OryClient::FrontendApi.new id = 'id_example' # String | ID is the Settings Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/settings?flow=abcde`). opts = { x_session_token: 'x_session_token_example', # String | The Session Token When using the SDK in an app without a browser, please include the session token here. cookie: 'cookie_example' # String | 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. } begin # Get Settings Flow result = api_instance.get_settings_flow(id, opts) p result rescue OryClient::ApiError => e puts "Error when calling FrontendApi->get_settings_flow: #{e}" end ``` #### Using the get_settings_flow_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> get_settings_flow_with_http_info(id, opts) ```ruby begin # Get Settings Flow data, status_code, headers = api_instance.get_settings_flow_with_http_info(id, opts) p status_code # => 2xx p headers # => { ... } p data # => rescue OryClient::ApiError => e puts "Error when calling FrontendApi->get_settings_flow_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **id** | **String** | ID is the Settings Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/settings?flow=abcde`). | | | **x_session_token** | **String** | The Session Token When using the SDK in an app without a browser, please include the session token here. | [optional] | | **cookie** | **String** | HTTP Cookies When using the SDK in a browser app, on the server side you must include the HTTP Cookie Header sent by the client to your server here. This ensures that CSRF and session cookies are respected. | [optional] | ### Return type [**SettingsFlow**](SettingsFlow.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## get_verification_flow > get_verification_flow(id, opts) Get Verification Flow This endpoint returns a verification flow's context with, for example, error details and other information. Browser flows expect the anti-CSRF cookie to be included in the request's HTTP Cookie Header. For AJAX requests you must ensure that cookies are included in the request or requests will fail. If you use the browser-flow for server-side apps, the services need to run on a common top-level-domain and you need to forward the incoming HTTP Cookie header to this endpoint: ```js pseudo-code example router.get('/recovery', async function (req, res) { const flow = await client.getVerificationFlow(req.header('cookie'), req.query['flow']) res.render('verification', flow) }) ``` More information can be found at [Ory Kratos Email and Phone Verification Documentation](https://www.ory.sh/docs/kratos/self-service/flows/verify-email-account-activation). ### Examples ```ruby require 'time' require 'ory-client' api_instance = OryClient::FrontendApi.new id = 'id_example' # String | The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verification?flow=abcde`). opts = { cookie: 'cookie_example' # String | HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here. } begin # Get Verification Flow result = api_instance.get_verification_flow(id, opts) p result rescue OryClient::ApiError => e puts "Error when calling FrontendApi->get_verification_flow: #{e}" end ``` #### Using the get_verification_flow_with_http_info variant This returns an Array which contains the response data, status code and headers. > , Integer, Hash)> get_verification_flow_with_http_info(id, opts) ```ruby begin # Get Verification Flow data, status_code, headers = api_instance.get_verification_flow_with_http_info(id, opts) p status_code # => 2xx p headers # => { ... } p data # => rescue OryClient::ApiError => e puts "Error when calling FrontendApi->get_verification_flow_with_http_info: #{e}" end ``` ### Parameters | Name | Type | Description | Notes | | ---- | ---- | ----------- | ----- | | **id** | **String** | The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verification?flow=abcde`). | | | **cookie** | **String** | HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here. | [optional] | ### Return type [**VerificationFlow**](VerificationFlow.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json ## get_web_authn_java_script > String get_web_authn_java_script Get WebAuthn JavaScript This endpoint provides JavaScript which is needed in order to perform WebAuthn login and registration. If you are building a JavaScript Browser App (e.g. in ReactJS or AngularJS) you will need to load this file: ```html