mirror of https://github.com/ory/kratos
6395 lines
260 KiB
Go
6395 lines
260 KiB
Go
/*
|
|
Ory Identities API
|
|
|
|
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.
|
|
|
|
API version:
|
|
Contact: office@ory.sh
|
|
*/
|
|
|
|
// Code generated by OpenAPI Generator (https://openapi-generator.tech); DO NOT EDIT.
|
|
|
|
package client
|
|
|
|
import (
|
|
"bytes"
|
|
"context"
|
|
"io"
|
|
"net/http"
|
|
"net/url"
|
|
"strings"
|
|
)
|
|
|
|
type FrontendAPI interface {
|
|
|
|
/*
|
|
CreateBrowserLoginFlow 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).
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPICreateBrowserLoginFlowRequest
|
|
*/
|
|
CreateBrowserLoginFlow(ctx context.Context) FrontendAPICreateBrowserLoginFlowRequest
|
|
|
|
// CreateBrowserLoginFlowExecute executes the request
|
|
// @return LoginFlow
|
|
CreateBrowserLoginFlowExecute(r FrontendAPICreateBrowserLoginFlowRequest) (*LoginFlow, *http.Response, error)
|
|
|
|
/*
|
|
CreateBrowserLogoutFlow 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.
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPICreateBrowserLogoutFlowRequest
|
|
*/
|
|
CreateBrowserLogoutFlow(ctx context.Context) FrontendAPICreateBrowserLogoutFlowRequest
|
|
|
|
// CreateBrowserLogoutFlowExecute executes the request
|
|
// @return LogoutFlow
|
|
CreateBrowserLogoutFlowExecute(r FrontendAPICreateBrowserLogoutFlowRequest) (*LogoutFlow, *http.Response, error)
|
|
|
|
/*
|
|
CreateBrowserRecoveryFlow 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).
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPICreateBrowserRecoveryFlowRequest
|
|
*/
|
|
CreateBrowserRecoveryFlow(ctx context.Context) FrontendAPICreateBrowserRecoveryFlowRequest
|
|
|
|
// CreateBrowserRecoveryFlowExecute executes the request
|
|
// @return RecoveryFlow
|
|
CreateBrowserRecoveryFlowExecute(r FrontendAPICreateBrowserRecoveryFlowRequest) (*RecoveryFlow, *http.Response, error)
|
|
|
|
/*
|
|
CreateBrowserRegistrationFlow 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).
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPICreateBrowserRegistrationFlowRequest
|
|
*/
|
|
CreateBrowserRegistrationFlow(ctx context.Context) FrontendAPICreateBrowserRegistrationFlowRequest
|
|
|
|
// CreateBrowserRegistrationFlowExecute executes the request
|
|
// @return RegistrationFlow
|
|
CreateBrowserRegistrationFlowExecute(r FrontendAPICreateBrowserRegistrationFlowRequest) (*RegistrationFlow, *http.Response, error)
|
|
|
|
/*
|
|
CreateBrowserSettingsFlow 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).
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPICreateBrowserSettingsFlowRequest
|
|
*/
|
|
CreateBrowserSettingsFlow(ctx context.Context) FrontendAPICreateBrowserSettingsFlowRequest
|
|
|
|
// CreateBrowserSettingsFlowExecute executes the request
|
|
// @return SettingsFlow
|
|
CreateBrowserSettingsFlowExecute(r FrontendAPICreateBrowserSettingsFlowRequest) (*SettingsFlow, *http.Response, error)
|
|
|
|
/*
|
|
CreateBrowserVerificationFlow 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).
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPICreateBrowserVerificationFlowRequest
|
|
*/
|
|
CreateBrowserVerificationFlow(ctx context.Context) FrontendAPICreateBrowserVerificationFlowRequest
|
|
|
|
// CreateBrowserVerificationFlowExecute executes the request
|
|
// @return VerificationFlow
|
|
CreateBrowserVerificationFlowExecute(r FrontendAPICreateBrowserVerificationFlowRequest) (*VerificationFlow, *http.Response, error)
|
|
|
|
/*
|
|
CreateFedcmFlow Get FedCM Parameters
|
|
|
|
This endpoint returns a list of all available FedCM providers. It is only supported on the Ory Network.
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPICreateFedcmFlowRequest
|
|
*/
|
|
CreateFedcmFlow(ctx context.Context) FrontendAPICreateFedcmFlowRequest
|
|
|
|
// CreateFedcmFlowExecute executes the request
|
|
// @return CreateFedcmFlowResponse
|
|
CreateFedcmFlowExecute(r FrontendAPICreateFedcmFlowRequest) (*CreateFedcmFlowResponse, *http.Response, error)
|
|
|
|
/*
|
|
CreateNativeLoginFlow 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=<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, 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).
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPICreateNativeLoginFlowRequest
|
|
*/
|
|
CreateNativeLoginFlow(ctx context.Context) FrontendAPICreateNativeLoginFlowRequest
|
|
|
|
// CreateNativeLoginFlowExecute executes the request
|
|
// @return LoginFlow
|
|
CreateNativeLoginFlowExecute(r FrontendAPICreateNativeLoginFlowRequest) (*LoginFlow, *http.Response, error)
|
|
|
|
/*
|
|
CreateNativeRecoveryFlow 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).
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPICreateNativeRecoveryFlowRequest
|
|
*/
|
|
CreateNativeRecoveryFlow(ctx context.Context) FrontendAPICreateNativeRecoveryFlowRequest
|
|
|
|
// CreateNativeRecoveryFlowExecute executes the request
|
|
// @return RecoveryFlow
|
|
CreateNativeRecoveryFlowExecute(r FrontendAPICreateNativeRecoveryFlowRequest) (*RecoveryFlow, *http.Response, error)
|
|
|
|
/*
|
|
CreateNativeRegistrationFlow 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 ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPICreateNativeRegistrationFlowRequest
|
|
*/
|
|
CreateNativeRegistrationFlow(ctx context.Context) FrontendAPICreateNativeRegistrationFlowRequest
|
|
|
|
// CreateNativeRegistrationFlowExecute executes the request
|
|
// @return RegistrationFlow
|
|
CreateNativeRegistrationFlowExecute(r FrontendAPICreateNativeRegistrationFlowRequest) (*RegistrationFlow, *http.Response, error)
|
|
|
|
/*
|
|
CreateNativeSettingsFlow Create Settings Flow for Native Apps
|
|
|
|
This endpoint initiates a settings flow for API clients such as mobile devices, smart TVs, and so on.
|
|
You must provide a valid Ory Kratos Session Token for this endpoint to respond with HTTP 200 OK.
|
|
|
|
To fetch an existing settings flow call `/self-service/settings/flows?flow=<flow_id>`.
|
|
|
|
You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server
|
|
Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make
|
|
you vulnerable to a variety of CSRF attacks.
|
|
|
|
Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator
|
|
Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn
|
|
credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user
|
|
to sign in with the second factor or change the configuration.
|
|
|
|
In the case of an error, the `error.id` of the JSON response body can be one of:
|
|
|
|
`security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred.
|
|
`session_inactive`: No Ory Session was found - sign in a user first.
|
|
|
|
This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...).
|
|
|
|
More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPICreateNativeSettingsFlowRequest
|
|
*/
|
|
CreateNativeSettingsFlow(ctx context.Context) FrontendAPICreateNativeSettingsFlowRequest
|
|
|
|
// CreateNativeSettingsFlowExecute executes the request
|
|
// @return SettingsFlow
|
|
CreateNativeSettingsFlowExecute(r FrontendAPICreateNativeSettingsFlowRequest) (*SettingsFlow, *http.Response, error)
|
|
|
|
/*
|
|
CreateNativeVerificationFlow 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=<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.
|
|
|
|
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).
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPICreateNativeVerificationFlowRequest
|
|
*/
|
|
CreateNativeVerificationFlow(ctx context.Context) FrontendAPICreateNativeVerificationFlowRequest
|
|
|
|
// CreateNativeVerificationFlowExecute executes the request
|
|
// @return VerificationFlow
|
|
CreateNativeVerificationFlowExecute(r FrontendAPICreateNativeVerificationFlowRequest) (*VerificationFlow, *http.Response, error)
|
|
|
|
/*
|
|
DisableMyOtherSessions 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.
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPIDisableMyOtherSessionsRequest
|
|
*/
|
|
DisableMyOtherSessions(ctx context.Context) FrontendAPIDisableMyOtherSessionsRequest
|
|
|
|
// DisableMyOtherSessionsExecute executes the request
|
|
// @return DeleteMySessionsCount
|
|
DisableMyOtherSessionsExecute(r FrontendAPIDisableMyOtherSessionsRequest) (*DeleteMySessionsCount, *http.Response, error)
|
|
|
|
/*
|
|
DisableMySession Disable one of my sessions
|
|
|
|
Calling this endpoint invalidates the specified session. The current session cannot be revoked.
|
|
Session data are not deleted.
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@param id ID is the session's ID.
|
|
@return FrontendAPIDisableMySessionRequest
|
|
*/
|
|
DisableMySession(ctx context.Context, id string) FrontendAPIDisableMySessionRequest
|
|
|
|
// DisableMySessionExecute executes the request
|
|
DisableMySessionExecute(r FrontendAPIDisableMySessionRequest) (*http.Response, error)
|
|
|
|
/*
|
|
ExchangeSessionToken Exchange Session Token
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPIExchangeSessionTokenRequest
|
|
*/
|
|
ExchangeSessionToken(ctx context.Context) FrontendAPIExchangeSessionTokenRequest
|
|
|
|
// ExchangeSessionTokenExecute executes the request
|
|
// @return SuccessfulNativeLogin
|
|
ExchangeSessionTokenExecute(r FrontendAPIExchangeSessionTokenRequest) (*SuccessfulNativeLogin, *http.Response, error)
|
|
|
|
/*
|
|
GetFlowError 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 ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPIGetFlowErrorRequest
|
|
*/
|
|
GetFlowError(ctx context.Context) FrontendAPIGetFlowErrorRequest
|
|
|
|
// GetFlowErrorExecute executes the request
|
|
// @return FlowError
|
|
GetFlowErrorExecute(r FrontendAPIGetFlowErrorRequest) (*FlowError, *http.Response, error)
|
|
|
|
/*
|
|
GetLoginFlow 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).
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPIGetLoginFlowRequest
|
|
*/
|
|
GetLoginFlow(ctx context.Context) FrontendAPIGetLoginFlowRequest
|
|
|
|
// GetLoginFlowExecute executes the request
|
|
// @return LoginFlow
|
|
GetLoginFlowExecute(r FrontendAPIGetLoginFlowRequest) (*LoginFlow, *http.Response, error)
|
|
|
|
/*
|
|
GetRecoveryFlow 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).
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPIGetRecoveryFlowRequest
|
|
*/
|
|
GetRecoveryFlow(ctx context.Context) FrontendAPIGetRecoveryFlowRequest
|
|
|
|
// GetRecoveryFlowExecute executes the request
|
|
// @return RecoveryFlow
|
|
GetRecoveryFlowExecute(r FrontendAPIGetRecoveryFlowRequest) (*RecoveryFlow, *http.Response, error)
|
|
|
|
/*
|
|
GetRegistrationFlow 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).
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPIGetRegistrationFlowRequest
|
|
*/
|
|
GetRegistrationFlow(ctx context.Context) FrontendAPIGetRegistrationFlowRequest
|
|
|
|
// GetRegistrationFlowExecute executes the request
|
|
// @return RegistrationFlow
|
|
GetRegistrationFlowExecute(r FrontendAPIGetRegistrationFlowRequest) (*RegistrationFlow, *http.Response, error)
|
|
|
|
/*
|
|
GetSettingsFlow 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).
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPIGetSettingsFlowRequest
|
|
*/
|
|
GetSettingsFlow(ctx context.Context) FrontendAPIGetSettingsFlowRequest
|
|
|
|
// GetSettingsFlowExecute executes the request
|
|
// @return SettingsFlow
|
|
GetSettingsFlowExecute(r FrontendAPIGetSettingsFlowRequest) (*SettingsFlow, *http.Response, error)
|
|
|
|
/*
|
|
GetVerificationFlow 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).
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPIGetVerificationFlowRequest
|
|
*/
|
|
GetVerificationFlow(ctx context.Context) FrontendAPIGetVerificationFlowRequest
|
|
|
|
// GetVerificationFlowExecute executes the request
|
|
// @return VerificationFlow
|
|
GetVerificationFlowExecute(r FrontendAPIGetVerificationFlowRequest) (*VerificationFlow, *http.Response, error)
|
|
|
|
/*
|
|
GetWebAuthnJavaScript 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
|
|
<script src="https://public-kratos.example.org/.well-known/ory/webauthn.js" type="script" async />
|
|
```
|
|
|
|
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 ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPIGetWebAuthnJavaScriptRequest
|
|
*/
|
|
GetWebAuthnJavaScript(ctx context.Context) FrontendAPIGetWebAuthnJavaScriptRequest
|
|
|
|
// GetWebAuthnJavaScriptExecute executes the request
|
|
// @return string
|
|
GetWebAuthnJavaScriptExecute(r FrontendAPIGetWebAuthnJavaScriptRequest) (string, *http.Response, error)
|
|
|
|
/*
|
|
ListMySessions Get My Active Sessions
|
|
|
|
This endpoints returns all other active sessions that belong to the logged-in user.
|
|
The current session can be retrieved by calling the `/sessions/whoami` endpoint.
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPIListMySessionsRequest
|
|
*/
|
|
ListMySessions(ctx context.Context) FrontendAPIListMySessionsRequest
|
|
|
|
// ListMySessionsExecute executes the request
|
|
// @return []Session
|
|
ListMySessionsExecute(r FrontendAPIListMySessionsRequest) ([]Session, *http.Response, error)
|
|
|
|
/*
|
|
PerformNativeLogout Perform Logout for Native Apps
|
|
|
|
Use this endpoint to log out an identity using an Ory Session Token. If the Ory Session Token was successfully
|
|
revoked, the server returns a 204 No Content response. A 204 No Content response is also sent when
|
|
the Ory Session Token has been revoked already before.
|
|
|
|
If the Ory Session Token is malformed or does not exist a 403 Forbidden response will be returned.
|
|
|
|
This endpoint does not remove any HTTP
|
|
Cookies - use the Browser-Based Self-Service Logout Flow instead.
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPIPerformNativeLogoutRequest
|
|
*/
|
|
PerformNativeLogout(ctx context.Context) FrontendAPIPerformNativeLogoutRequest
|
|
|
|
// PerformNativeLogoutExecute executes the request
|
|
PerformNativeLogoutExecute(r FrontendAPIPerformNativeLogoutRequest) (*http.Response, error)
|
|
|
|
/*
|
|
ToSession Check Who the Current HTTP Session Belongs To
|
|
|
|
Uses the HTTP Headers in the GET request to determine (e.g. by using checking the cookies) who is authenticated.
|
|
Returns a session object in the body or 401 if the credentials are invalid or no credentials were sent.
|
|
When the request it successful it adds the user ID to the 'X-Kratos-Authenticated-Identity-Id' header
|
|
in the response.
|
|
|
|
If you call this endpoint from a server-side application, you must forward the HTTP Cookie Header to this endpoint:
|
|
|
|
```js
|
|
pseudo-code example
|
|
router.get('/protected-endpoint', async function (req, res) {
|
|
const session = await client.toSession(undefined, req.header('cookie'))
|
|
|
|
console.log(session)
|
|
})
|
|
```
|
|
|
|
When calling this endpoint from a non-browser application (e.g. mobile app) you must include the session token:
|
|
|
|
```js
|
|
pseudo-code example
|
|
...
|
|
const session = await client.toSession("the-session-token")
|
|
|
|
console.log(session)
|
|
```
|
|
|
|
When using a token template, the token is included in the `tokenized` field of the session.
|
|
|
|
```js
|
|
pseudo-code example
|
|
...
|
|
const session = await client.toSession("the-session-token", { tokenize_as: "example-jwt-template" })
|
|
|
|
console.log(session.tokenized) // The JWT
|
|
```
|
|
|
|
Depending on your configuration this endpoint might return a 403 status code if the session has a lower Authenticator
|
|
Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn
|
|
credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user
|
|
to sign in with the second factor or change the configuration.
|
|
|
|
This endpoint is useful for:
|
|
|
|
AJAX calls. Remember to send credentials and set up CORS correctly!
|
|
Reverse proxies and API Gateways
|
|
Server-side calls - use the `X-Session-Token` header!
|
|
|
|
This endpoint authenticates users by checking:
|
|
|
|
if the `Cookie` HTTP header was set containing an Ory Kratos Session Cookie;
|
|
if the `Authorization: bearer <ory-session-token>` HTTP header was set with a valid Ory Kratos Session Token;
|
|
if the `X-Session-Token` HTTP header was set with a valid Ory Kratos Session Token.
|
|
|
|
If none of these headers are set or the cookie or token are invalid, the endpoint returns a HTTP 401 status code.
|
|
|
|
As explained above, this request may fail due to several reasons. The `error.id` can be one of:
|
|
|
|
`session_inactive`: No active session was found in the request (e.g. no Ory Session Cookie / Ory Session Token).
|
|
`session_aal2_required`: An active session was found but it does not fulfil the Authenticator Assurance Level, implying that the session must (e.g.) authenticate the second factor.
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPIToSessionRequest
|
|
*/
|
|
ToSession(ctx context.Context) FrontendAPIToSessionRequest
|
|
|
|
// ToSessionExecute executes the request
|
|
// @return Session
|
|
ToSessionExecute(r FrontendAPIToSessionRequest) (*Session, *http.Response, error)
|
|
|
|
/*
|
|
UpdateFedcmFlow Submit a FedCM token
|
|
|
|
Use this endpoint to submit a token from a FedCM provider through
|
|
`navigator.credentials.get` and log the user in. The parameters from
|
|
`navigator.credentials.get` must have come from `GET
|
|
self-service/fed-cm/parameters`.
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPIUpdateFedcmFlowRequest
|
|
*/
|
|
UpdateFedcmFlow(ctx context.Context) FrontendAPIUpdateFedcmFlowRequest
|
|
|
|
// UpdateFedcmFlowExecute executes the request
|
|
// @return SuccessfulNativeLogin
|
|
UpdateFedcmFlowExecute(r FrontendAPIUpdateFedcmFlowRequest) (*SuccessfulNativeLogin, *http.Response, error)
|
|
|
|
/*
|
|
UpdateLoginFlow Submit a Login Flow
|
|
|
|
Use this endpoint to complete a login flow. This endpoint
|
|
behaves differently for API and browser flows.
|
|
|
|
API flows expect `application/json` to be sent in the body and responds with
|
|
HTTP 200 and a application/json body with the session token on success;
|
|
HTTP 410 if the original flow expired with the appropriate error messages set and optionally a `use_flow_id` parameter in the body;
|
|
HTTP 400 on form validation errors.
|
|
|
|
Browser flows expect a Content-Type of `application/x-www-form-urlencoded` or `application/json` to be sent in the body and respond with
|
|
a HTTP 303 redirect to the post/after login URL or the `return_to` value if it was set and if the login succeeded;
|
|
a HTTP 303 redirect to the login UI URL with the flow ID containing the validation errors otherwise.
|
|
|
|
Browser flows with an accept header of `application/json` will not redirect but instead respond with
|
|
HTTP 200 and a application/json body with the signed in identity and a `Set-Cookie` header on success;
|
|
HTTP 303 redirect to a fresh login flow if the original flow expired with the appropriate error messages set;
|
|
HTTP 400 on form validation errors.
|
|
|
|
If this endpoint is called with `Accept: application/json` in the header, the response contains the flow without a redirect. In the
|
|
case of an error, the `error.id` of the JSON response body can be one of:
|
|
|
|
`session_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!
|
|
`browser_location_change_required`: Usually sent when an AJAX request indicates that the browser needs to open a specific URL.
|
|
Most likely used in Social Sign In flows.
|
|
|
|
More information can be found at [Ory Kratos User 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 ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPIUpdateLoginFlowRequest
|
|
*/
|
|
UpdateLoginFlow(ctx context.Context) FrontendAPIUpdateLoginFlowRequest
|
|
|
|
// UpdateLoginFlowExecute executes the request
|
|
// @return SuccessfulNativeLogin
|
|
UpdateLoginFlowExecute(r FrontendAPIUpdateLoginFlowRequest) (*SuccessfulNativeLogin, *http.Response, error)
|
|
|
|
/*
|
|
UpdateLogoutFlow Update Logout Flow
|
|
|
|
This endpoint logs out an identity in a self-service manner.
|
|
|
|
If the `Accept` HTTP header is not set to `application/json`, the browser will be redirected (HTTP 303 See Other)
|
|
to the `return_to` parameter of the initial request or fall back to `urls.default_return_to`.
|
|
|
|
If the `Accept` HTTP header is set to `application/json`, a 204 No Content response
|
|
will be sent on successful logout instead.
|
|
|
|
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.
|
|
|
|
More information can be found at [Ory Kratos User Logout Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-logout).
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPIUpdateLogoutFlowRequest
|
|
*/
|
|
UpdateLogoutFlow(ctx context.Context) FrontendAPIUpdateLogoutFlowRequest
|
|
|
|
// UpdateLogoutFlowExecute executes the request
|
|
UpdateLogoutFlowExecute(r FrontendAPIUpdateLogoutFlowRequest) (*http.Response, error)
|
|
|
|
/*
|
|
UpdateRecoveryFlow Update Recovery Flow
|
|
|
|
Use this endpoint to update a recovery flow. This endpoint
|
|
behaves differently for API and browser flows and has several states:
|
|
|
|
`choose_method` expects `flow` (in the URL query) and `email` (in the body) to be sent
|
|
and works with API- and Browser-initiated flows.
|
|
For API clients and Browser clients with HTTP Header `Accept: application/json` it either returns a HTTP 200 OK when the form is valid and HTTP 400 OK when the form is invalid.
|
|
and a HTTP 303 See Other redirect with a fresh recovery flow if the flow was otherwise invalid (e.g. expired).
|
|
For Browser clients without HTTP Header `Accept` or with `Accept: text/*` it returns a HTTP 303 See Other redirect to the Recovery UI URL with the Recovery Flow ID appended.
|
|
`sent_email` is the success state after `choose_method` for the `link` method and allows the user to request another recovery email. It
|
|
works for both API and Browser-initiated flows and returns the same responses as the flow in `choose_method` state.
|
|
`passed_challenge` expects a `token` to be sent in the URL query and given the nature of the flow ("sending a recovery link")
|
|
does not have any API capabilities. The server responds with a HTTP 303 See Other redirect either to the Settings UI URL
|
|
(if the link was valid) and instructs the user to update their password, or a redirect to the Recover UI URL with
|
|
a new Recovery Flow ID which contains an error message that the recovery link was invalid.
|
|
|
|
More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery).
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPIUpdateRecoveryFlowRequest
|
|
*/
|
|
UpdateRecoveryFlow(ctx context.Context) FrontendAPIUpdateRecoveryFlowRequest
|
|
|
|
// UpdateRecoveryFlowExecute executes the request
|
|
// @return RecoveryFlow
|
|
UpdateRecoveryFlowExecute(r FrontendAPIUpdateRecoveryFlowRequest) (*RecoveryFlow, *http.Response, error)
|
|
|
|
/*
|
|
UpdateRegistrationFlow Update Registration Flow
|
|
|
|
Use this endpoint to complete a registration flow by sending an identity's traits and password. This endpoint
|
|
behaves differently for API and browser flows.
|
|
|
|
API flows expect `application/json` to be sent in the body and respond with
|
|
HTTP 200 and a application/json body with the created identity success - if the session hook is configured the
|
|
`session` and `session_token` will also be included;
|
|
HTTP 410 if the original flow expired with the appropriate error messages set and optionally a `use_flow_id` parameter in the body;
|
|
HTTP 400 on form validation errors.
|
|
|
|
Browser flows expect a Content-Type of `application/x-www-form-urlencoded` or `application/json` to be sent in the body and respond with
|
|
a HTTP 303 redirect to the post/after registration URL or the `return_to` value if it was set and if the registration succeeded;
|
|
a HTTP 303 redirect to the registration UI URL with the flow ID containing the validation errors otherwise.
|
|
|
|
Browser flows with an accept header of `application/json` will not redirect but instead respond with
|
|
HTTP 200 and a application/json body with the signed in identity and a `Set-Cookie` header on success;
|
|
HTTP 303 redirect to a fresh login flow if the original flow expired with the appropriate error messages set;
|
|
HTTP 400 on form validation errors.
|
|
|
|
If this endpoint is called with `Accept: application/json` in the header, the response contains the flow without a redirect. In the
|
|
case of an error, the `error.id` of the JSON response body can be one of:
|
|
|
|
`session_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!
|
|
`browser_location_change_required`: Usually sent when an AJAX request indicates that the browser needs to open a specific URL.
|
|
Most likely used in Social Sign In flows.
|
|
|
|
More information can be found at [Ory Kratos User 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 ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPIUpdateRegistrationFlowRequest
|
|
*/
|
|
UpdateRegistrationFlow(ctx context.Context) FrontendAPIUpdateRegistrationFlowRequest
|
|
|
|
// UpdateRegistrationFlowExecute executes the request
|
|
// @return SuccessfulNativeRegistration
|
|
UpdateRegistrationFlowExecute(r FrontendAPIUpdateRegistrationFlowRequest) (*SuccessfulNativeRegistration, *http.Response, error)
|
|
|
|
/*
|
|
UpdateSettingsFlow Complete Settings Flow
|
|
|
|
Use this endpoint to complete a settings flow by sending an identity's updated password. This endpoint
|
|
behaves differently for API and browser flows.
|
|
|
|
API-initiated flows expect `application/json` to be sent in the body and respond with
|
|
HTTP 200 and an application/json body with the session token on success;
|
|
HTTP 303 redirect to a fresh settings flow if the original flow expired with the appropriate error messages set;
|
|
HTTP 400 on form validation errors.
|
|
HTTP 401 when the endpoint is called without a valid session token.
|
|
HTTP 403 when `selfservice.flows.settings.privileged_session_max_age` was reached or the session's AAL is too low.
|
|
Implies that the user needs to re-authenticate.
|
|
|
|
Browser flows without HTTP Header `Accept` or with `Accept: text/*` respond with
|
|
a HTTP 303 redirect to the post/after settings URL or the `return_to` value if it was set and if the flow succeeded;
|
|
a HTTP 303 redirect to the Settings UI URL with the flow ID containing the validation errors otherwise.
|
|
a HTTP 303 redirect to the login endpoint when `selfservice.flows.settings.privileged_session_max_age` was reached or the session's AAL is too low.
|
|
|
|
Browser flows with HTTP Header `Accept: application/json` respond with
|
|
HTTP 200 and a application/json body with the signed in identity and a `Set-Cookie` header on success;
|
|
HTTP 303 redirect to a fresh login flow if the original flow expired with the appropriate error messages set;
|
|
HTTP 401 when the endpoint is called without a valid session cookie.
|
|
HTTP 403 when the page is accessed without a session cookie or the session's AAL is too low.
|
|
HTTP 400 on form validation errors.
|
|
|
|
Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator
|
|
Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn
|
|
credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user
|
|
to sign in with the second factor (happens automatically for server-side browser flows) or change the configuration.
|
|
|
|
If this endpoint is called with a `Accept: application/json` HTTP header, the response contains the flow without a redirect. In the
|
|
case of an error, the `error.id` of the JSON response body can be one of:
|
|
|
|
`session_refresh_required`: The identity requested to change something that needs a privileged session. Redirect
|
|
the identity to the login init endpoint with query parameters `?refresh=true&return_to=<the-current-browser-url>`,
|
|
or initiate a refresh login flow otherwise.
|
|
`security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred.
|
|
`session_inactive`: No Ory Session was found - sign in a user first.
|
|
`security_identity_mismatch`: The flow was interrupted with `session_refresh_required` but apparently some other
|
|
identity logged in instead.
|
|
`security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration!
|
|
`browser_location_change_required`: Usually sent when an AJAX request indicates that the browser needs to open a specific URL.
|
|
Most likely used in Social Sign In flows.
|
|
|
|
More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPIUpdateSettingsFlowRequest
|
|
*/
|
|
UpdateSettingsFlow(ctx context.Context) FrontendAPIUpdateSettingsFlowRequest
|
|
|
|
// UpdateSettingsFlowExecute executes the request
|
|
// @return SettingsFlow
|
|
UpdateSettingsFlowExecute(r FrontendAPIUpdateSettingsFlowRequest) (*SettingsFlow, *http.Response, error)
|
|
|
|
/*
|
|
UpdateVerificationFlow Complete Verification Flow
|
|
|
|
Use this endpoint to complete a verification flow. This endpoint
|
|
behaves differently for API and browser flows and has several states:
|
|
|
|
`choose_method` expects `flow` (in the URL query) and `email` (in the body) to be sent
|
|
and works with API- and Browser-initiated flows.
|
|
For API clients and Browser clients with HTTP Header `Accept: application/json` it either returns a HTTP 200 OK when the form is valid and HTTP 400 OK when the form is invalid
|
|
and a HTTP 303 See Other redirect with a fresh verification flow if the flow was otherwise invalid (e.g. expired).
|
|
For Browser clients without HTTP Header `Accept` or with `Accept: text/*` it returns a HTTP 303 See Other redirect to the Verification UI URL with the Verification Flow ID appended.
|
|
`sent_email` is the success state after `choose_method` when using the `link` method and allows the user to request another verification email. It
|
|
works for both API and Browser-initiated flows and returns the same responses as the flow in `choose_method` state.
|
|
`passed_challenge` expects a `token` to be sent in the URL query and given the nature of the flow ("sending a verification link")
|
|
does not have any API capabilities. The server responds with a HTTP 303 See Other redirect either to the Settings UI URL
|
|
(if the link was valid) and instructs the user to update their password, or a redirect to the Verification UI URL with
|
|
a new Verification Flow ID which contains an error message that the verification link was invalid.
|
|
|
|
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).
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPIUpdateVerificationFlowRequest
|
|
*/
|
|
UpdateVerificationFlow(ctx context.Context) FrontendAPIUpdateVerificationFlowRequest
|
|
|
|
// UpdateVerificationFlowExecute executes the request
|
|
// @return VerificationFlow
|
|
UpdateVerificationFlowExecute(r FrontendAPIUpdateVerificationFlowRequest) (*VerificationFlow, *http.Response, error)
|
|
}
|
|
|
|
// FrontendAPIService FrontendAPI service
|
|
type FrontendAPIService service
|
|
|
|
type FrontendAPICreateBrowserLoginFlowRequest struct {
|
|
ctx context.Context
|
|
ApiService FrontendAPI
|
|
refresh *bool
|
|
aal *string
|
|
returnTo *string
|
|
cookie *string
|
|
loginChallenge *string
|
|
organization *string
|
|
via *string
|
|
identitySchema *string
|
|
}
|
|
|
|
// 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.
|
|
func (r FrontendAPICreateBrowserLoginFlowRequest) Refresh(refresh bool) FrontendAPICreateBrowserLoginFlowRequest {
|
|
r.refresh = &refresh
|
|
return r
|
|
}
|
|
|
|
// 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\".
|
|
func (r FrontendAPICreateBrowserLoginFlowRequest) Aal(aal string) FrontendAPICreateBrowserLoginFlowRequest {
|
|
r.aal = &aal
|
|
return r
|
|
}
|
|
|
|
// The URL to return the browser to after the flow was completed.
|
|
func (r FrontendAPICreateBrowserLoginFlowRequest) ReturnTo(returnTo string) FrontendAPICreateBrowserLoginFlowRequest {
|
|
r.returnTo = &returnTo
|
|
return r
|
|
}
|
|
|
|
// 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.
|
|
func (r FrontendAPICreateBrowserLoginFlowRequest) Cookie(cookie string) FrontendAPICreateBrowserLoginFlowRequest {
|
|
r.cookie = &cookie
|
|
return r
|
|
}
|
|
|
|
// 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`).
|
|
func (r FrontendAPICreateBrowserLoginFlowRequest) LoginChallenge(loginChallenge string) FrontendAPICreateBrowserLoginFlowRequest {
|
|
r.loginChallenge = &loginChallenge
|
|
return r
|
|
}
|
|
|
|
// An optional organization ID that should be used for logging this user in. This parameter is only effective in the Ory Network.
|
|
func (r FrontendAPICreateBrowserLoginFlowRequest) Organization(organization string) FrontendAPICreateBrowserLoginFlowRequest {
|
|
r.organization = &organization
|
|
return r
|
|
}
|
|
|
|
// Via should contain the identity's credential the code should be sent to. Only relevant in aal2 flows. DEPRECATED: This field is deprecated. Please remove it from your requests. The user will now see a choice of MFA credentials to choose from to perform the second factor instead.
|
|
func (r FrontendAPICreateBrowserLoginFlowRequest) Via(via string) FrontendAPICreateBrowserLoginFlowRequest {
|
|
r.via = &via
|
|
return r
|
|
}
|
|
|
|
// An optional identity schema to use for the login flow.
|
|
func (r FrontendAPICreateBrowserLoginFlowRequest) IdentitySchema(identitySchema string) FrontendAPICreateBrowserLoginFlowRequest {
|
|
r.identitySchema = &identitySchema
|
|
return r
|
|
}
|
|
|
|
func (r FrontendAPICreateBrowserLoginFlowRequest) Execute() (*LoginFlow, *http.Response, error) {
|
|
return r.ApiService.CreateBrowserLoginFlowExecute(r)
|
|
}
|
|
|
|
/*
|
|
CreateBrowserLoginFlow 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).
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPICreateBrowserLoginFlowRequest
|
|
*/
|
|
func (a *FrontendAPIService) CreateBrowserLoginFlow(ctx context.Context) FrontendAPICreateBrowserLoginFlowRequest {
|
|
return FrontendAPICreateBrowserLoginFlowRequest{
|
|
ApiService: a,
|
|
ctx: ctx,
|
|
}
|
|
}
|
|
|
|
// Execute executes the request
|
|
//
|
|
// @return LoginFlow
|
|
func (a *FrontendAPIService) CreateBrowserLoginFlowExecute(r FrontendAPICreateBrowserLoginFlowRequest) (*LoginFlow, *http.Response, error) {
|
|
var (
|
|
localVarHTTPMethod = http.MethodGet
|
|
localVarPostBody interface{}
|
|
formFiles []formFile
|
|
localVarReturnValue *LoginFlow
|
|
)
|
|
|
|
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FrontendAPIService.CreateBrowserLoginFlow")
|
|
if err != nil {
|
|
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
|
|
}
|
|
|
|
localVarPath := localBasePath + "/self-service/login/browser"
|
|
|
|
localVarHeaderParams := make(map[string]string)
|
|
localVarQueryParams := url.Values{}
|
|
localVarFormParams := url.Values{}
|
|
|
|
if r.refresh != nil {
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "refresh", r.refresh, "form", "")
|
|
}
|
|
if r.aal != nil {
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "aal", r.aal, "form", "")
|
|
}
|
|
if r.returnTo != nil {
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "return_to", r.returnTo, "form", "")
|
|
}
|
|
if r.loginChallenge != nil {
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "login_challenge", r.loginChallenge, "form", "")
|
|
}
|
|
if r.organization != nil {
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "organization", r.organization, "form", "")
|
|
}
|
|
if r.via != nil {
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "via", r.via, "form", "")
|
|
}
|
|
if r.identitySchema != nil {
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "identity_schema", r.identitySchema, "form", "")
|
|
}
|
|
// to determine the Content-Type header
|
|
localVarHTTPContentTypes := []string{}
|
|
|
|
// set Content-Type header
|
|
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
|
|
if localVarHTTPContentType != "" {
|
|
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
|
|
}
|
|
|
|
// to determine the Accept header
|
|
localVarHTTPHeaderAccepts := []string{"application/json"}
|
|
|
|
// set Accept header
|
|
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
|
|
if localVarHTTPHeaderAccept != "" {
|
|
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
|
|
}
|
|
if r.cookie != nil {
|
|
parameterAddToHeaderOrQuery(localVarHeaderParams, "Cookie", r.cookie, "simple", "")
|
|
}
|
|
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
|
|
if err != nil {
|
|
return localVarReturnValue, nil, err
|
|
}
|
|
|
|
localVarHTTPResponse, err := a.client.callAPI(req)
|
|
if err != nil || localVarHTTPResponse == nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
|
|
localVarHTTPResponse.Body.Close()
|
|
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
|
|
if err != nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
if localVarHTTPResponse.StatusCode >= 300 {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: localVarHTTPResponse.Status,
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 400 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: err.Error(),
|
|
}
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
return localVarReturnValue, localVarHTTPResponse, nil
|
|
}
|
|
|
|
type FrontendAPICreateBrowserLogoutFlowRequest struct {
|
|
ctx context.Context
|
|
ApiService FrontendAPI
|
|
cookie *string
|
|
returnTo *string
|
|
}
|
|
|
|
// HTTP Cookies If you call this endpoint from a backend, please include the original Cookie header in the request.
|
|
func (r FrontendAPICreateBrowserLogoutFlowRequest) Cookie(cookie string) FrontendAPICreateBrowserLogoutFlowRequest {
|
|
r.cookie = &cookie
|
|
return r
|
|
}
|
|
|
|
// Return to URL The URL to which the browser should be redirected to after the logout has been performed.
|
|
func (r FrontendAPICreateBrowserLogoutFlowRequest) ReturnTo(returnTo string) FrontendAPICreateBrowserLogoutFlowRequest {
|
|
r.returnTo = &returnTo
|
|
return r
|
|
}
|
|
|
|
func (r FrontendAPICreateBrowserLogoutFlowRequest) Execute() (*LogoutFlow, *http.Response, error) {
|
|
return r.ApiService.CreateBrowserLogoutFlowExecute(r)
|
|
}
|
|
|
|
/*
|
|
CreateBrowserLogoutFlow 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.
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPICreateBrowserLogoutFlowRequest
|
|
*/
|
|
func (a *FrontendAPIService) CreateBrowserLogoutFlow(ctx context.Context) FrontendAPICreateBrowserLogoutFlowRequest {
|
|
return FrontendAPICreateBrowserLogoutFlowRequest{
|
|
ApiService: a,
|
|
ctx: ctx,
|
|
}
|
|
}
|
|
|
|
// Execute executes the request
|
|
//
|
|
// @return LogoutFlow
|
|
func (a *FrontendAPIService) CreateBrowserLogoutFlowExecute(r FrontendAPICreateBrowserLogoutFlowRequest) (*LogoutFlow, *http.Response, error) {
|
|
var (
|
|
localVarHTTPMethod = http.MethodGet
|
|
localVarPostBody interface{}
|
|
formFiles []formFile
|
|
localVarReturnValue *LogoutFlow
|
|
)
|
|
|
|
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FrontendAPIService.CreateBrowserLogoutFlow")
|
|
if err != nil {
|
|
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
|
|
}
|
|
|
|
localVarPath := localBasePath + "/self-service/logout/browser"
|
|
|
|
localVarHeaderParams := make(map[string]string)
|
|
localVarQueryParams := url.Values{}
|
|
localVarFormParams := url.Values{}
|
|
|
|
if r.returnTo != nil {
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "return_to", r.returnTo, "form", "")
|
|
}
|
|
// to determine the Content-Type header
|
|
localVarHTTPContentTypes := []string{}
|
|
|
|
// set Content-Type header
|
|
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
|
|
if localVarHTTPContentType != "" {
|
|
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
|
|
}
|
|
|
|
// to determine the Accept header
|
|
localVarHTTPHeaderAccepts := []string{"application/json"}
|
|
|
|
// set Accept header
|
|
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
|
|
if localVarHTTPHeaderAccept != "" {
|
|
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
|
|
}
|
|
if r.cookie != nil {
|
|
parameterAddToHeaderOrQuery(localVarHeaderParams, "cookie", r.cookie, "simple", "")
|
|
}
|
|
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
|
|
if err != nil {
|
|
return localVarReturnValue, nil, err
|
|
}
|
|
|
|
localVarHTTPResponse, err := a.client.callAPI(req)
|
|
if err != nil || localVarHTTPResponse == nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
|
|
localVarHTTPResponse.Body.Close()
|
|
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
|
|
if err != nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
if localVarHTTPResponse.StatusCode >= 300 {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: localVarHTTPResponse.Status,
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 400 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 401 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 500 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
}
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: err.Error(),
|
|
}
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
return localVarReturnValue, localVarHTTPResponse, nil
|
|
}
|
|
|
|
type FrontendAPICreateBrowserRecoveryFlowRequest struct {
|
|
ctx context.Context
|
|
ApiService FrontendAPI
|
|
returnTo *string
|
|
}
|
|
|
|
// The URL to return the browser to after the flow was completed.
|
|
func (r FrontendAPICreateBrowserRecoveryFlowRequest) ReturnTo(returnTo string) FrontendAPICreateBrowserRecoveryFlowRequest {
|
|
r.returnTo = &returnTo
|
|
return r
|
|
}
|
|
|
|
func (r FrontendAPICreateBrowserRecoveryFlowRequest) Execute() (*RecoveryFlow, *http.Response, error) {
|
|
return r.ApiService.CreateBrowserRecoveryFlowExecute(r)
|
|
}
|
|
|
|
/*
|
|
CreateBrowserRecoveryFlow 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).
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPICreateBrowserRecoveryFlowRequest
|
|
*/
|
|
func (a *FrontendAPIService) CreateBrowserRecoveryFlow(ctx context.Context) FrontendAPICreateBrowserRecoveryFlowRequest {
|
|
return FrontendAPICreateBrowserRecoveryFlowRequest{
|
|
ApiService: a,
|
|
ctx: ctx,
|
|
}
|
|
}
|
|
|
|
// Execute executes the request
|
|
//
|
|
// @return RecoveryFlow
|
|
func (a *FrontendAPIService) CreateBrowserRecoveryFlowExecute(r FrontendAPICreateBrowserRecoveryFlowRequest) (*RecoveryFlow, *http.Response, error) {
|
|
var (
|
|
localVarHTTPMethod = http.MethodGet
|
|
localVarPostBody interface{}
|
|
formFiles []formFile
|
|
localVarReturnValue *RecoveryFlow
|
|
)
|
|
|
|
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FrontendAPIService.CreateBrowserRecoveryFlow")
|
|
if err != nil {
|
|
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
|
|
}
|
|
|
|
localVarPath := localBasePath + "/self-service/recovery/browser"
|
|
|
|
localVarHeaderParams := make(map[string]string)
|
|
localVarQueryParams := url.Values{}
|
|
localVarFormParams := url.Values{}
|
|
|
|
if r.returnTo != nil {
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "return_to", r.returnTo, "form", "")
|
|
}
|
|
// to determine the Content-Type header
|
|
localVarHTTPContentTypes := []string{}
|
|
|
|
// set Content-Type header
|
|
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
|
|
if localVarHTTPContentType != "" {
|
|
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
|
|
}
|
|
|
|
// to determine the Accept header
|
|
localVarHTTPHeaderAccepts := []string{"application/json"}
|
|
|
|
// set Accept header
|
|
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
|
|
if localVarHTTPHeaderAccept != "" {
|
|
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
|
|
}
|
|
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
|
|
if err != nil {
|
|
return localVarReturnValue, nil, err
|
|
}
|
|
|
|
localVarHTTPResponse, err := a.client.callAPI(req)
|
|
if err != nil || localVarHTTPResponse == nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
|
|
localVarHTTPResponse.Body.Close()
|
|
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
|
|
if err != nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
if localVarHTTPResponse.StatusCode >= 300 {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: localVarHTTPResponse.Status,
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 400 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: err.Error(),
|
|
}
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
return localVarReturnValue, localVarHTTPResponse, nil
|
|
}
|
|
|
|
type FrontendAPICreateBrowserRegistrationFlowRequest struct {
|
|
ctx context.Context
|
|
ApiService FrontendAPI
|
|
returnTo *string
|
|
loginChallenge *string
|
|
afterVerificationReturnTo *string
|
|
organization *string
|
|
identitySchema *string
|
|
}
|
|
|
|
// The URL to return the browser to after the flow was completed.
|
|
func (r FrontendAPICreateBrowserRegistrationFlowRequest) ReturnTo(returnTo string) FrontendAPICreateBrowserRegistrationFlowRequest {
|
|
r.returnTo = &returnTo
|
|
return r
|
|
}
|
|
|
|
// 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.
|
|
func (r FrontendAPICreateBrowserRegistrationFlowRequest) LoginChallenge(loginChallenge string) FrontendAPICreateBrowserRegistrationFlowRequest {
|
|
r.loginChallenge = &loginChallenge
|
|
return r
|
|
}
|
|
|
|
// 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.
|
|
func (r FrontendAPICreateBrowserRegistrationFlowRequest) AfterVerificationReturnTo(afterVerificationReturnTo string) FrontendAPICreateBrowserRegistrationFlowRequest {
|
|
r.afterVerificationReturnTo = &afterVerificationReturnTo
|
|
return r
|
|
}
|
|
|
|
// An optional organization ID that should be used to register this user. This parameter is only effective in the Ory Network.
|
|
func (r FrontendAPICreateBrowserRegistrationFlowRequest) Organization(organization string) FrontendAPICreateBrowserRegistrationFlowRequest {
|
|
r.organization = &organization
|
|
return r
|
|
}
|
|
|
|
// An optional identity schema to use for the registration flow.
|
|
func (r FrontendAPICreateBrowserRegistrationFlowRequest) IdentitySchema(identitySchema string) FrontendAPICreateBrowserRegistrationFlowRequest {
|
|
r.identitySchema = &identitySchema
|
|
return r
|
|
}
|
|
|
|
func (r FrontendAPICreateBrowserRegistrationFlowRequest) Execute() (*RegistrationFlow, *http.Response, error) {
|
|
return r.ApiService.CreateBrowserRegistrationFlowExecute(r)
|
|
}
|
|
|
|
/*
|
|
CreateBrowserRegistrationFlow 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).
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPICreateBrowserRegistrationFlowRequest
|
|
*/
|
|
func (a *FrontendAPIService) CreateBrowserRegistrationFlow(ctx context.Context) FrontendAPICreateBrowserRegistrationFlowRequest {
|
|
return FrontendAPICreateBrowserRegistrationFlowRequest{
|
|
ApiService: a,
|
|
ctx: ctx,
|
|
}
|
|
}
|
|
|
|
// Execute executes the request
|
|
//
|
|
// @return RegistrationFlow
|
|
func (a *FrontendAPIService) CreateBrowserRegistrationFlowExecute(r FrontendAPICreateBrowserRegistrationFlowRequest) (*RegistrationFlow, *http.Response, error) {
|
|
var (
|
|
localVarHTTPMethod = http.MethodGet
|
|
localVarPostBody interface{}
|
|
formFiles []formFile
|
|
localVarReturnValue *RegistrationFlow
|
|
)
|
|
|
|
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FrontendAPIService.CreateBrowserRegistrationFlow")
|
|
if err != nil {
|
|
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
|
|
}
|
|
|
|
localVarPath := localBasePath + "/self-service/registration/browser"
|
|
|
|
localVarHeaderParams := make(map[string]string)
|
|
localVarQueryParams := url.Values{}
|
|
localVarFormParams := url.Values{}
|
|
|
|
if r.returnTo != nil {
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "return_to", r.returnTo, "form", "")
|
|
}
|
|
if r.loginChallenge != nil {
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "login_challenge", r.loginChallenge, "form", "")
|
|
}
|
|
if r.afterVerificationReturnTo != nil {
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "after_verification_return_to", r.afterVerificationReturnTo, "form", "")
|
|
}
|
|
if r.organization != nil {
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "organization", r.organization, "form", "")
|
|
}
|
|
if r.identitySchema != nil {
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "identity_schema", r.identitySchema, "form", "")
|
|
}
|
|
// to determine the Content-Type header
|
|
localVarHTTPContentTypes := []string{}
|
|
|
|
// set Content-Type header
|
|
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
|
|
if localVarHTTPContentType != "" {
|
|
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
|
|
}
|
|
|
|
// to determine the Accept header
|
|
localVarHTTPHeaderAccepts := []string{"application/json"}
|
|
|
|
// set Accept header
|
|
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
|
|
if localVarHTTPHeaderAccept != "" {
|
|
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
|
|
}
|
|
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
|
|
if err != nil {
|
|
return localVarReturnValue, nil, err
|
|
}
|
|
|
|
localVarHTTPResponse, err := a.client.callAPI(req)
|
|
if err != nil || localVarHTTPResponse == nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
|
|
localVarHTTPResponse.Body.Close()
|
|
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
|
|
if err != nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
if localVarHTTPResponse.StatusCode >= 300 {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: localVarHTTPResponse.Status,
|
|
}
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: err.Error(),
|
|
}
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
return localVarReturnValue, localVarHTTPResponse, nil
|
|
}
|
|
|
|
type FrontendAPICreateBrowserSettingsFlowRequest struct {
|
|
ctx context.Context
|
|
ApiService FrontendAPI
|
|
returnTo *string
|
|
cookie *string
|
|
}
|
|
|
|
// The URL to return the browser to after the flow was completed.
|
|
func (r FrontendAPICreateBrowserSettingsFlowRequest) ReturnTo(returnTo string) FrontendAPICreateBrowserSettingsFlowRequest {
|
|
r.returnTo = &returnTo
|
|
return r
|
|
}
|
|
|
|
// 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.
|
|
func (r FrontendAPICreateBrowserSettingsFlowRequest) Cookie(cookie string) FrontendAPICreateBrowserSettingsFlowRequest {
|
|
r.cookie = &cookie
|
|
return r
|
|
}
|
|
|
|
func (r FrontendAPICreateBrowserSettingsFlowRequest) Execute() (*SettingsFlow, *http.Response, error) {
|
|
return r.ApiService.CreateBrowserSettingsFlowExecute(r)
|
|
}
|
|
|
|
/*
|
|
CreateBrowserSettingsFlow 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).
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPICreateBrowserSettingsFlowRequest
|
|
*/
|
|
func (a *FrontendAPIService) CreateBrowserSettingsFlow(ctx context.Context) FrontendAPICreateBrowserSettingsFlowRequest {
|
|
return FrontendAPICreateBrowserSettingsFlowRequest{
|
|
ApiService: a,
|
|
ctx: ctx,
|
|
}
|
|
}
|
|
|
|
// Execute executes the request
|
|
//
|
|
// @return SettingsFlow
|
|
func (a *FrontendAPIService) CreateBrowserSettingsFlowExecute(r FrontendAPICreateBrowserSettingsFlowRequest) (*SettingsFlow, *http.Response, error) {
|
|
var (
|
|
localVarHTTPMethod = http.MethodGet
|
|
localVarPostBody interface{}
|
|
formFiles []formFile
|
|
localVarReturnValue *SettingsFlow
|
|
)
|
|
|
|
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FrontendAPIService.CreateBrowserSettingsFlow")
|
|
if err != nil {
|
|
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
|
|
}
|
|
|
|
localVarPath := localBasePath + "/self-service/settings/browser"
|
|
|
|
localVarHeaderParams := make(map[string]string)
|
|
localVarQueryParams := url.Values{}
|
|
localVarFormParams := url.Values{}
|
|
|
|
if r.returnTo != nil {
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "return_to", r.returnTo, "form", "")
|
|
}
|
|
// to determine the Content-Type header
|
|
localVarHTTPContentTypes := []string{}
|
|
|
|
// set Content-Type header
|
|
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
|
|
if localVarHTTPContentType != "" {
|
|
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
|
|
}
|
|
|
|
// to determine the Accept header
|
|
localVarHTTPHeaderAccepts := []string{"application/json"}
|
|
|
|
// set Accept header
|
|
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
|
|
if localVarHTTPHeaderAccept != "" {
|
|
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
|
|
}
|
|
if r.cookie != nil {
|
|
parameterAddToHeaderOrQuery(localVarHeaderParams, "Cookie", r.cookie, "simple", "")
|
|
}
|
|
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
|
|
if err != nil {
|
|
return localVarReturnValue, nil, err
|
|
}
|
|
|
|
localVarHTTPResponse, err := a.client.callAPI(req)
|
|
if err != nil || localVarHTTPResponse == nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
|
|
localVarHTTPResponse.Body.Close()
|
|
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
|
|
if err != nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
if localVarHTTPResponse.StatusCode >= 300 {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: localVarHTTPResponse.Status,
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 400 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 401 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 403 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: err.Error(),
|
|
}
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
return localVarReturnValue, localVarHTTPResponse, nil
|
|
}
|
|
|
|
type FrontendAPICreateBrowserVerificationFlowRequest struct {
|
|
ctx context.Context
|
|
ApiService FrontendAPI
|
|
returnTo *string
|
|
}
|
|
|
|
// The URL to return the browser to after the flow was completed.
|
|
func (r FrontendAPICreateBrowserVerificationFlowRequest) ReturnTo(returnTo string) FrontendAPICreateBrowserVerificationFlowRequest {
|
|
r.returnTo = &returnTo
|
|
return r
|
|
}
|
|
|
|
func (r FrontendAPICreateBrowserVerificationFlowRequest) Execute() (*VerificationFlow, *http.Response, error) {
|
|
return r.ApiService.CreateBrowserVerificationFlowExecute(r)
|
|
}
|
|
|
|
/*
|
|
CreateBrowserVerificationFlow 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).
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPICreateBrowserVerificationFlowRequest
|
|
*/
|
|
func (a *FrontendAPIService) CreateBrowserVerificationFlow(ctx context.Context) FrontendAPICreateBrowserVerificationFlowRequest {
|
|
return FrontendAPICreateBrowserVerificationFlowRequest{
|
|
ApiService: a,
|
|
ctx: ctx,
|
|
}
|
|
}
|
|
|
|
// Execute executes the request
|
|
//
|
|
// @return VerificationFlow
|
|
func (a *FrontendAPIService) CreateBrowserVerificationFlowExecute(r FrontendAPICreateBrowserVerificationFlowRequest) (*VerificationFlow, *http.Response, error) {
|
|
var (
|
|
localVarHTTPMethod = http.MethodGet
|
|
localVarPostBody interface{}
|
|
formFiles []formFile
|
|
localVarReturnValue *VerificationFlow
|
|
)
|
|
|
|
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FrontendAPIService.CreateBrowserVerificationFlow")
|
|
if err != nil {
|
|
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
|
|
}
|
|
|
|
localVarPath := localBasePath + "/self-service/verification/browser"
|
|
|
|
localVarHeaderParams := make(map[string]string)
|
|
localVarQueryParams := url.Values{}
|
|
localVarFormParams := url.Values{}
|
|
|
|
if r.returnTo != nil {
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "return_to", r.returnTo, "form", "")
|
|
}
|
|
// to determine the Content-Type header
|
|
localVarHTTPContentTypes := []string{}
|
|
|
|
// set Content-Type header
|
|
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
|
|
if localVarHTTPContentType != "" {
|
|
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
|
|
}
|
|
|
|
// to determine the Accept header
|
|
localVarHTTPHeaderAccepts := []string{"application/json"}
|
|
|
|
// set Accept header
|
|
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
|
|
if localVarHTTPHeaderAccept != "" {
|
|
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
|
|
}
|
|
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
|
|
if err != nil {
|
|
return localVarReturnValue, nil, err
|
|
}
|
|
|
|
localVarHTTPResponse, err := a.client.callAPI(req)
|
|
if err != nil || localVarHTTPResponse == nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
|
|
localVarHTTPResponse.Body.Close()
|
|
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
|
|
if err != nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
if localVarHTTPResponse.StatusCode >= 300 {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: localVarHTTPResponse.Status,
|
|
}
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: err.Error(),
|
|
}
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
return localVarReturnValue, localVarHTTPResponse, nil
|
|
}
|
|
|
|
type FrontendAPICreateFedcmFlowRequest struct {
|
|
ctx context.Context
|
|
ApiService FrontendAPI
|
|
}
|
|
|
|
func (r FrontendAPICreateFedcmFlowRequest) Execute() (*CreateFedcmFlowResponse, *http.Response, error) {
|
|
return r.ApiService.CreateFedcmFlowExecute(r)
|
|
}
|
|
|
|
/*
|
|
CreateFedcmFlow Get FedCM Parameters
|
|
|
|
This endpoint returns a list of all available FedCM providers. It is only supported on the Ory Network.
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPICreateFedcmFlowRequest
|
|
*/
|
|
func (a *FrontendAPIService) CreateFedcmFlow(ctx context.Context) FrontendAPICreateFedcmFlowRequest {
|
|
return FrontendAPICreateFedcmFlowRequest{
|
|
ApiService: a,
|
|
ctx: ctx,
|
|
}
|
|
}
|
|
|
|
// Execute executes the request
|
|
//
|
|
// @return CreateFedcmFlowResponse
|
|
func (a *FrontendAPIService) CreateFedcmFlowExecute(r FrontendAPICreateFedcmFlowRequest) (*CreateFedcmFlowResponse, *http.Response, error) {
|
|
var (
|
|
localVarHTTPMethod = http.MethodGet
|
|
localVarPostBody interface{}
|
|
formFiles []formFile
|
|
localVarReturnValue *CreateFedcmFlowResponse
|
|
)
|
|
|
|
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FrontendAPIService.CreateFedcmFlow")
|
|
if err != nil {
|
|
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
|
|
}
|
|
|
|
localVarPath := localBasePath + "/self-service/fed-cm/parameters"
|
|
|
|
localVarHeaderParams := make(map[string]string)
|
|
localVarQueryParams := url.Values{}
|
|
localVarFormParams := url.Values{}
|
|
|
|
// to determine the Content-Type header
|
|
localVarHTTPContentTypes := []string{}
|
|
|
|
// set Content-Type header
|
|
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
|
|
if localVarHTTPContentType != "" {
|
|
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
|
|
}
|
|
|
|
// to determine the Accept header
|
|
localVarHTTPHeaderAccepts := []string{"application/json"}
|
|
|
|
// set Accept header
|
|
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
|
|
if localVarHTTPHeaderAccept != "" {
|
|
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
|
|
}
|
|
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
|
|
if err != nil {
|
|
return localVarReturnValue, nil, err
|
|
}
|
|
|
|
localVarHTTPResponse, err := a.client.callAPI(req)
|
|
if err != nil || localVarHTTPResponse == nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
|
|
localVarHTTPResponse.Body.Close()
|
|
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
|
|
if err != nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
if localVarHTTPResponse.StatusCode >= 300 {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: localVarHTTPResponse.Status,
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 400 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: err.Error(),
|
|
}
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
return localVarReturnValue, localVarHTTPResponse, nil
|
|
}
|
|
|
|
type FrontendAPICreateNativeLoginFlowRequest struct {
|
|
ctx context.Context
|
|
ApiService FrontendAPI
|
|
refresh *bool
|
|
aal *string
|
|
xSessionToken *string
|
|
returnSessionTokenExchangeCode *bool
|
|
returnTo *string
|
|
organization *string
|
|
via *string
|
|
identitySchema *string
|
|
}
|
|
|
|
// 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.
|
|
func (r FrontendAPICreateNativeLoginFlowRequest) Refresh(refresh bool) FrontendAPICreateNativeLoginFlowRequest {
|
|
r.refresh = &refresh
|
|
return r
|
|
}
|
|
|
|
// 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\".
|
|
func (r FrontendAPICreateNativeLoginFlowRequest) Aal(aal string) FrontendAPICreateNativeLoginFlowRequest {
|
|
r.aal = &aal
|
|
return r
|
|
}
|
|
|
|
// The Session Token of the Identity performing the settings flow.
|
|
func (r FrontendAPICreateNativeLoginFlowRequest) XSessionToken(xSessionToken string) FrontendAPICreateNativeLoginFlowRequest {
|
|
r.xSessionToken = &xSessionToken
|
|
return r
|
|
}
|
|
|
|
// 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.
|
|
func (r FrontendAPICreateNativeLoginFlowRequest) ReturnSessionTokenExchangeCode(returnSessionTokenExchangeCode bool) FrontendAPICreateNativeLoginFlowRequest {
|
|
r.returnSessionTokenExchangeCode = &returnSessionTokenExchangeCode
|
|
return r
|
|
}
|
|
|
|
// The URL to return the browser to after the flow was completed.
|
|
func (r FrontendAPICreateNativeLoginFlowRequest) ReturnTo(returnTo string) FrontendAPICreateNativeLoginFlowRequest {
|
|
r.returnTo = &returnTo
|
|
return r
|
|
}
|
|
|
|
// An optional organization ID that should be used for logging this user in. This parameter is only effective in the Ory Network.
|
|
func (r FrontendAPICreateNativeLoginFlowRequest) Organization(organization string) FrontendAPICreateNativeLoginFlowRequest {
|
|
r.organization = &organization
|
|
return r
|
|
}
|
|
|
|
// Via should contain the identity's credential the code should be sent to. Only relevant in aal2 flows. DEPRECATED: This field is deprecated. Please remove it from your requests. The user will now see a choice of MFA credentials to choose from to perform the second factor instead.
|
|
func (r FrontendAPICreateNativeLoginFlowRequest) Via(via string) FrontendAPICreateNativeLoginFlowRequest {
|
|
r.via = &via
|
|
return r
|
|
}
|
|
|
|
// An optional identity schema to use for the login flow.
|
|
func (r FrontendAPICreateNativeLoginFlowRequest) IdentitySchema(identitySchema string) FrontendAPICreateNativeLoginFlowRequest {
|
|
r.identitySchema = &identitySchema
|
|
return r
|
|
}
|
|
|
|
func (r FrontendAPICreateNativeLoginFlowRequest) Execute() (*LoginFlow, *http.Response, error) {
|
|
return r.ApiService.CreateNativeLoginFlowExecute(r)
|
|
}
|
|
|
|
/*
|
|
CreateNativeLoginFlow 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=<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, 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).
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPICreateNativeLoginFlowRequest
|
|
*/
|
|
func (a *FrontendAPIService) CreateNativeLoginFlow(ctx context.Context) FrontendAPICreateNativeLoginFlowRequest {
|
|
return FrontendAPICreateNativeLoginFlowRequest{
|
|
ApiService: a,
|
|
ctx: ctx,
|
|
}
|
|
}
|
|
|
|
// Execute executes the request
|
|
//
|
|
// @return LoginFlow
|
|
func (a *FrontendAPIService) CreateNativeLoginFlowExecute(r FrontendAPICreateNativeLoginFlowRequest) (*LoginFlow, *http.Response, error) {
|
|
var (
|
|
localVarHTTPMethod = http.MethodGet
|
|
localVarPostBody interface{}
|
|
formFiles []formFile
|
|
localVarReturnValue *LoginFlow
|
|
)
|
|
|
|
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FrontendAPIService.CreateNativeLoginFlow")
|
|
if err != nil {
|
|
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
|
|
}
|
|
|
|
localVarPath := localBasePath + "/self-service/login/api"
|
|
|
|
localVarHeaderParams := make(map[string]string)
|
|
localVarQueryParams := url.Values{}
|
|
localVarFormParams := url.Values{}
|
|
|
|
if r.refresh != nil {
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "refresh", r.refresh, "form", "")
|
|
}
|
|
if r.aal != nil {
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "aal", r.aal, "form", "")
|
|
}
|
|
if r.returnSessionTokenExchangeCode != nil {
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "return_session_token_exchange_code", r.returnSessionTokenExchangeCode, "form", "")
|
|
}
|
|
if r.returnTo != nil {
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "return_to", r.returnTo, "form", "")
|
|
}
|
|
if r.organization != nil {
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "organization", r.organization, "form", "")
|
|
}
|
|
if r.via != nil {
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "via", r.via, "form", "")
|
|
}
|
|
if r.identitySchema != nil {
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "identity_schema", r.identitySchema, "form", "")
|
|
}
|
|
// to determine the Content-Type header
|
|
localVarHTTPContentTypes := []string{}
|
|
|
|
// set Content-Type header
|
|
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
|
|
if localVarHTTPContentType != "" {
|
|
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
|
|
}
|
|
|
|
// to determine the Accept header
|
|
localVarHTTPHeaderAccepts := []string{"application/json"}
|
|
|
|
// set Accept header
|
|
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
|
|
if localVarHTTPHeaderAccept != "" {
|
|
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
|
|
}
|
|
if r.xSessionToken != nil {
|
|
parameterAddToHeaderOrQuery(localVarHeaderParams, "X-Session-Token", r.xSessionToken, "simple", "")
|
|
}
|
|
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
|
|
if err != nil {
|
|
return localVarReturnValue, nil, err
|
|
}
|
|
|
|
localVarHTTPResponse, err := a.client.callAPI(req)
|
|
if err != nil || localVarHTTPResponse == nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
|
|
localVarHTTPResponse.Body.Close()
|
|
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
|
|
if err != nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
if localVarHTTPResponse.StatusCode >= 300 {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: localVarHTTPResponse.Status,
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 400 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: err.Error(),
|
|
}
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
return localVarReturnValue, localVarHTTPResponse, nil
|
|
}
|
|
|
|
type FrontendAPICreateNativeRecoveryFlowRequest struct {
|
|
ctx context.Context
|
|
ApiService FrontendAPI
|
|
}
|
|
|
|
func (r FrontendAPICreateNativeRecoveryFlowRequest) Execute() (*RecoveryFlow, *http.Response, error) {
|
|
return r.ApiService.CreateNativeRecoveryFlowExecute(r)
|
|
}
|
|
|
|
/*
|
|
CreateNativeRecoveryFlow 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).
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPICreateNativeRecoveryFlowRequest
|
|
*/
|
|
func (a *FrontendAPIService) CreateNativeRecoveryFlow(ctx context.Context) FrontendAPICreateNativeRecoveryFlowRequest {
|
|
return FrontendAPICreateNativeRecoveryFlowRequest{
|
|
ApiService: a,
|
|
ctx: ctx,
|
|
}
|
|
}
|
|
|
|
// Execute executes the request
|
|
//
|
|
// @return RecoveryFlow
|
|
func (a *FrontendAPIService) CreateNativeRecoveryFlowExecute(r FrontendAPICreateNativeRecoveryFlowRequest) (*RecoveryFlow, *http.Response, error) {
|
|
var (
|
|
localVarHTTPMethod = http.MethodGet
|
|
localVarPostBody interface{}
|
|
formFiles []formFile
|
|
localVarReturnValue *RecoveryFlow
|
|
)
|
|
|
|
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FrontendAPIService.CreateNativeRecoveryFlow")
|
|
if err != nil {
|
|
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
|
|
}
|
|
|
|
localVarPath := localBasePath + "/self-service/recovery/api"
|
|
|
|
localVarHeaderParams := make(map[string]string)
|
|
localVarQueryParams := url.Values{}
|
|
localVarFormParams := url.Values{}
|
|
|
|
// to determine the Content-Type header
|
|
localVarHTTPContentTypes := []string{}
|
|
|
|
// set Content-Type header
|
|
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
|
|
if localVarHTTPContentType != "" {
|
|
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
|
|
}
|
|
|
|
// to determine the Accept header
|
|
localVarHTTPHeaderAccepts := []string{"application/json"}
|
|
|
|
// set Accept header
|
|
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
|
|
if localVarHTTPHeaderAccept != "" {
|
|
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
|
|
}
|
|
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
|
|
if err != nil {
|
|
return localVarReturnValue, nil, err
|
|
}
|
|
|
|
localVarHTTPResponse, err := a.client.callAPI(req)
|
|
if err != nil || localVarHTTPResponse == nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
|
|
localVarHTTPResponse.Body.Close()
|
|
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
|
|
if err != nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
if localVarHTTPResponse.StatusCode >= 300 {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: localVarHTTPResponse.Status,
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 400 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: err.Error(),
|
|
}
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
return localVarReturnValue, localVarHTTPResponse, nil
|
|
}
|
|
|
|
type FrontendAPICreateNativeRegistrationFlowRequest struct {
|
|
ctx context.Context
|
|
ApiService FrontendAPI
|
|
returnSessionTokenExchangeCode *bool
|
|
returnTo *string
|
|
organization *string
|
|
identitySchema *string
|
|
}
|
|
|
|
// 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.
|
|
func (r FrontendAPICreateNativeRegistrationFlowRequest) ReturnSessionTokenExchangeCode(returnSessionTokenExchangeCode bool) FrontendAPICreateNativeRegistrationFlowRequest {
|
|
r.returnSessionTokenExchangeCode = &returnSessionTokenExchangeCode
|
|
return r
|
|
}
|
|
|
|
// The URL to return the browser to after the flow was completed.
|
|
func (r FrontendAPICreateNativeRegistrationFlowRequest) ReturnTo(returnTo string) FrontendAPICreateNativeRegistrationFlowRequest {
|
|
r.returnTo = &returnTo
|
|
return r
|
|
}
|
|
|
|
// An optional organization ID that should be used to register this user. This parameter is only effective in the Ory Network.
|
|
func (r FrontendAPICreateNativeRegistrationFlowRequest) Organization(organization string) FrontendAPICreateNativeRegistrationFlowRequest {
|
|
r.organization = &organization
|
|
return r
|
|
}
|
|
|
|
// An optional identity schema to use for the registration flow.
|
|
func (r FrontendAPICreateNativeRegistrationFlowRequest) IdentitySchema(identitySchema string) FrontendAPICreateNativeRegistrationFlowRequest {
|
|
r.identitySchema = &identitySchema
|
|
return r
|
|
}
|
|
|
|
func (r FrontendAPICreateNativeRegistrationFlowRequest) Execute() (*RegistrationFlow, *http.Response, error) {
|
|
return r.ApiService.CreateNativeRegistrationFlowExecute(r)
|
|
}
|
|
|
|
/*
|
|
CreateNativeRegistrationFlow 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 ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPICreateNativeRegistrationFlowRequest
|
|
*/
|
|
func (a *FrontendAPIService) CreateNativeRegistrationFlow(ctx context.Context) FrontendAPICreateNativeRegistrationFlowRequest {
|
|
return FrontendAPICreateNativeRegistrationFlowRequest{
|
|
ApiService: a,
|
|
ctx: ctx,
|
|
}
|
|
}
|
|
|
|
// Execute executes the request
|
|
//
|
|
// @return RegistrationFlow
|
|
func (a *FrontendAPIService) CreateNativeRegistrationFlowExecute(r FrontendAPICreateNativeRegistrationFlowRequest) (*RegistrationFlow, *http.Response, error) {
|
|
var (
|
|
localVarHTTPMethod = http.MethodGet
|
|
localVarPostBody interface{}
|
|
formFiles []formFile
|
|
localVarReturnValue *RegistrationFlow
|
|
)
|
|
|
|
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FrontendAPIService.CreateNativeRegistrationFlow")
|
|
if err != nil {
|
|
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
|
|
}
|
|
|
|
localVarPath := localBasePath + "/self-service/registration/api"
|
|
|
|
localVarHeaderParams := make(map[string]string)
|
|
localVarQueryParams := url.Values{}
|
|
localVarFormParams := url.Values{}
|
|
|
|
if r.returnSessionTokenExchangeCode != nil {
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "return_session_token_exchange_code", r.returnSessionTokenExchangeCode, "form", "")
|
|
}
|
|
if r.returnTo != nil {
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "return_to", r.returnTo, "form", "")
|
|
}
|
|
if r.organization != nil {
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "organization", r.organization, "form", "")
|
|
}
|
|
if r.identitySchema != nil {
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "identity_schema", r.identitySchema, "form", "")
|
|
}
|
|
// to determine the Content-Type header
|
|
localVarHTTPContentTypes := []string{}
|
|
|
|
// set Content-Type header
|
|
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
|
|
if localVarHTTPContentType != "" {
|
|
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
|
|
}
|
|
|
|
// to determine the Accept header
|
|
localVarHTTPHeaderAccepts := []string{"application/json"}
|
|
|
|
// set Accept header
|
|
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
|
|
if localVarHTTPHeaderAccept != "" {
|
|
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
|
|
}
|
|
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
|
|
if err != nil {
|
|
return localVarReturnValue, nil, err
|
|
}
|
|
|
|
localVarHTTPResponse, err := a.client.callAPI(req)
|
|
if err != nil || localVarHTTPResponse == nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
|
|
localVarHTTPResponse.Body.Close()
|
|
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
|
|
if err != nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
if localVarHTTPResponse.StatusCode >= 300 {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: localVarHTTPResponse.Status,
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 400 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: err.Error(),
|
|
}
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
return localVarReturnValue, localVarHTTPResponse, nil
|
|
}
|
|
|
|
type FrontendAPICreateNativeSettingsFlowRequest struct {
|
|
ctx context.Context
|
|
ApiService FrontendAPI
|
|
xSessionToken *string
|
|
}
|
|
|
|
// The Session Token of the Identity performing the settings flow.
|
|
func (r FrontendAPICreateNativeSettingsFlowRequest) XSessionToken(xSessionToken string) FrontendAPICreateNativeSettingsFlowRequest {
|
|
r.xSessionToken = &xSessionToken
|
|
return r
|
|
}
|
|
|
|
func (r FrontendAPICreateNativeSettingsFlowRequest) Execute() (*SettingsFlow, *http.Response, error) {
|
|
return r.ApiService.CreateNativeSettingsFlowExecute(r)
|
|
}
|
|
|
|
/*
|
|
CreateNativeSettingsFlow Create Settings Flow for Native Apps
|
|
|
|
This endpoint initiates a settings flow for API clients such as mobile devices, smart TVs, and so on.
|
|
You must provide a valid Ory Kratos Session Token for this endpoint to respond with HTTP 200 OK.
|
|
|
|
To fetch an existing settings flow call `/self-service/settings/flows?flow=<flow_id>`.
|
|
|
|
You MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server
|
|
Pages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make
|
|
you vulnerable to a variety of CSRF attacks.
|
|
|
|
Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator
|
|
Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn
|
|
credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user
|
|
to sign in with the second factor or change the configuration.
|
|
|
|
In the case of an error, the `error.id` of the JSON response body can be one of:
|
|
|
|
`security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred.
|
|
`session_inactive`: No Ory Session was found - sign in a user first.
|
|
|
|
This endpoint MUST ONLY be used in scenarios such as native mobile apps (React Native, Objective C, Swift, Java, ...).
|
|
|
|
More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPICreateNativeSettingsFlowRequest
|
|
*/
|
|
func (a *FrontendAPIService) CreateNativeSettingsFlow(ctx context.Context) FrontendAPICreateNativeSettingsFlowRequest {
|
|
return FrontendAPICreateNativeSettingsFlowRequest{
|
|
ApiService: a,
|
|
ctx: ctx,
|
|
}
|
|
}
|
|
|
|
// Execute executes the request
|
|
//
|
|
// @return SettingsFlow
|
|
func (a *FrontendAPIService) CreateNativeSettingsFlowExecute(r FrontendAPICreateNativeSettingsFlowRequest) (*SettingsFlow, *http.Response, error) {
|
|
var (
|
|
localVarHTTPMethod = http.MethodGet
|
|
localVarPostBody interface{}
|
|
formFiles []formFile
|
|
localVarReturnValue *SettingsFlow
|
|
)
|
|
|
|
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FrontendAPIService.CreateNativeSettingsFlow")
|
|
if err != nil {
|
|
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
|
|
}
|
|
|
|
localVarPath := localBasePath + "/self-service/settings/api"
|
|
|
|
localVarHeaderParams := make(map[string]string)
|
|
localVarQueryParams := url.Values{}
|
|
localVarFormParams := url.Values{}
|
|
|
|
// to determine the Content-Type header
|
|
localVarHTTPContentTypes := []string{}
|
|
|
|
// set Content-Type header
|
|
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
|
|
if localVarHTTPContentType != "" {
|
|
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
|
|
}
|
|
|
|
// to determine the Accept header
|
|
localVarHTTPHeaderAccepts := []string{"application/json"}
|
|
|
|
// set Accept header
|
|
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
|
|
if localVarHTTPHeaderAccept != "" {
|
|
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
|
|
}
|
|
if r.xSessionToken != nil {
|
|
parameterAddToHeaderOrQuery(localVarHeaderParams, "X-Session-Token", r.xSessionToken, "simple", "")
|
|
}
|
|
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
|
|
if err != nil {
|
|
return localVarReturnValue, nil, err
|
|
}
|
|
|
|
localVarHTTPResponse, err := a.client.callAPI(req)
|
|
if err != nil || localVarHTTPResponse == nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
|
|
localVarHTTPResponse.Body.Close()
|
|
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
|
|
if err != nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
if localVarHTTPResponse.StatusCode >= 300 {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: localVarHTTPResponse.Status,
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 400 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: err.Error(),
|
|
}
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
return localVarReturnValue, localVarHTTPResponse, nil
|
|
}
|
|
|
|
type FrontendAPICreateNativeVerificationFlowRequest struct {
|
|
ctx context.Context
|
|
ApiService FrontendAPI
|
|
returnTo *string
|
|
}
|
|
|
|
// A URL contained in the return_to key of the verification flow. This piece of data has no effect on the actual logic of the flow and is purely informational.
|
|
func (r FrontendAPICreateNativeVerificationFlowRequest) ReturnTo(returnTo string) FrontendAPICreateNativeVerificationFlowRequest {
|
|
r.returnTo = &returnTo
|
|
return r
|
|
}
|
|
|
|
func (r FrontendAPICreateNativeVerificationFlowRequest) Execute() (*VerificationFlow, *http.Response, error) {
|
|
return r.ApiService.CreateNativeVerificationFlowExecute(r)
|
|
}
|
|
|
|
/*
|
|
CreateNativeVerificationFlow 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=<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.
|
|
|
|
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).
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPICreateNativeVerificationFlowRequest
|
|
*/
|
|
func (a *FrontendAPIService) CreateNativeVerificationFlow(ctx context.Context) FrontendAPICreateNativeVerificationFlowRequest {
|
|
return FrontendAPICreateNativeVerificationFlowRequest{
|
|
ApiService: a,
|
|
ctx: ctx,
|
|
}
|
|
}
|
|
|
|
// Execute executes the request
|
|
//
|
|
// @return VerificationFlow
|
|
func (a *FrontendAPIService) CreateNativeVerificationFlowExecute(r FrontendAPICreateNativeVerificationFlowRequest) (*VerificationFlow, *http.Response, error) {
|
|
var (
|
|
localVarHTTPMethod = http.MethodGet
|
|
localVarPostBody interface{}
|
|
formFiles []formFile
|
|
localVarReturnValue *VerificationFlow
|
|
)
|
|
|
|
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FrontendAPIService.CreateNativeVerificationFlow")
|
|
if err != nil {
|
|
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
|
|
}
|
|
|
|
localVarPath := localBasePath + "/self-service/verification/api"
|
|
|
|
localVarHeaderParams := make(map[string]string)
|
|
localVarQueryParams := url.Values{}
|
|
localVarFormParams := url.Values{}
|
|
|
|
if r.returnTo != nil {
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "return_to", r.returnTo, "form", "")
|
|
}
|
|
// to determine the Content-Type header
|
|
localVarHTTPContentTypes := []string{}
|
|
|
|
// set Content-Type header
|
|
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
|
|
if localVarHTTPContentType != "" {
|
|
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
|
|
}
|
|
|
|
// to determine the Accept header
|
|
localVarHTTPHeaderAccepts := []string{"application/json"}
|
|
|
|
// set Accept header
|
|
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
|
|
if localVarHTTPHeaderAccept != "" {
|
|
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
|
|
}
|
|
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
|
|
if err != nil {
|
|
return localVarReturnValue, nil, err
|
|
}
|
|
|
|
localVarHTTPResponse, err := a.client.callAPI(req)
|
|
if err != nil || localVarHTTPResponse == nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
|
|
localVarHTTPResponse.Body.Close()
|
|
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
|
|
if err != nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
if localVarHTTPResponse.StatusCode >= 300 {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: localVarHTTPResponse.Status,
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 400 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: err.Error(),
|
|
}
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
return localVarReturnValue, localVarHTTPResponse, nil
|
|
}
|
|
|
|
type FrontendAPIDisableMyOtherSessionsRequest struct {
|
|
ctx context.Context
|
|
ApiService FrontendAPI
|
|
xSessionToken *string
|
|
cookie *string
|
|
}
|
|
|
|
// Set the Session Token when calling from non-browser clients. A session token has a format of `MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj`.
|
|
func (r FrontendAPIDisableMyOtherSessionsRequest) XSessionToken(xSessionToken string) FrontendAPIDisableMyOtherSessionsRequest {
|
|
r.xSessionToken = &xSessionToken
|
|
return r
|
|
}
|
|
|
|
// 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.
|
|
func (r FrontendAPIDisableMyOtherSessionsRequest) Cookie(cookie string) FrontendAPIDisableMyOtherSessionsRequest {
|
|
r.cookie = &cookie
|
|
return r
|
|
}
|
|
|
|
func (r FrontendAPIDisableMyOtherSessionsRequest) Execute() (*DeleteMySessionsCount, *http.Response, error) {
|
|
return r.ApiService.DisableMyOtherSessionsExecute(r)
|
|
}
|
|
|
|
/*
|
|
DisableMyOtherSessions 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.
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPIDisableMyOtherSessionsRequest
|
|
*/
|
|
func (a *FrontendAPIService) DisableMyOtherSessions(ctx context.Context) FrontendAPIDisableMyOtherSessionsRequest {
|
|
return FrontendAPIDisableMyOtherSessionsRequest{
|
|
ApiService: a,
|
|
ctx: ctx,
|
|
}
|
|
}
|
|
|
|
// Execute executes the request
|
|
//
|
|
// @return DeleteMySessionsCount
|
|
func (a *FrontendAPIService) DisableMyOtherSessionsExecute(r FrontendAPIDisableMyOtherSessionsRequest) (*DeleteMySessionsCount, *http.Response, error) {
|
|
var (
|
|
localVarHTTPMethod = http.MethodDelete
|
|
localVarPostBody interface{}
|
|
formFiles []formFile
|
|
localVarReturnValue *DeleteMySessionsCount
|
|
)
|
|
|
|
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FrontendAPIService.DisableMyOtherSessions")
|
|
if err != nil {
|
|
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
|
|
}
|
|
|
|
localVarPath := localBasePath + "/sessions"
|
|
|
|
localVarHeaderParams := make(map[string]string)
|
|
localVarQueryParams := url.Values{}
|
|
localVarFormParams := url.Values{}
|
|
|
|
// to determine the Content-Type header
|
|
localVarHTTPContentTypes := []string{}
|
|
|
|
// set Content-Type header
|
|
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
|
|
if localVarHTTPContentType != "" {
|
|
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
|
|
}
|
|
|
|
// to determine the Accept header
|
|
localVarHTTPHeaderAccepts := []string{"application/json"}
|
|
|
|
// set Accept header
|
|
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
|
|
if localVarHTTPHeaderAccept != "" {
|
|
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
|
|
}
|
|
if r.xSessionToken != nil {
|
|
parameterAddToHeaderOrQuery(localVarHeaderParams, "X-Session-Token", r.xSessionToken, "simple", "")
|
|
}
|
|
if r.cookie != nil {
|
|
parameterAddToHeaderOrQuery(localVarHeaderParams, "Cookie", r.cookie, "simple", "")
|
|
}
|
|
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
|
|
if err != nil {
|
|
return localVarReturnValue, nil, err
|
|
}
|
|
|
|
localVarHTTPResponse, err := a.client.callAPI(req)
|
|
if err != nil || localVarHTTPResponse == nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
|
|
localVarHTTPResponse.Body.Close()
|
|
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
|
|
if err != nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
if localVarHTTPResponse.StatusCode >= 300 {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: localVarHTTPResponse.Status,
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 400 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 401 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: err.Error(),
|
|
}
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
return localVarReturnValue, localVarHTTPResponse, nil
|
|
}
|
|
|
|
type FrontendAPIDisableMySessionRequest struct {
|
|
ctx context.Context
|
|
ApiService FrontendAPI
|
|
id string
|
|
xSessionToken *string
|
|
cookie *string
|
|
}
|
|
|
|
// Set the Session Token when calling from non-browser clients. A session token has a format of `MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj`.
|
|
func (r FrontendAPIDisableMySessionRequest) XSessionToken(xSessionToken string) FrontendAPIDisableMySessionRequest {
|
|
r.xSessionToken = &xSessionToken
|
|
return r
|
|
}
|
|
|
|
// 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.
|
|
func (r FrontendAPIDisableMySessionRequest) Cookie(cookie string) FrontendAPIDisableMySessionRequest {
|
|
r.cookie = &cookie
|
|
return r
|
|
}
|
|
|
|
func (r FrontendAPIDisableMySessionRequest) Execute() (*http.Response, error) {
|
|
return r.ApiService.DisableMySessionExecute(r)
|
|
}
|
|
|
|
/*
|
|
DisableMySession Disable one of my sessions
|
|
|
|
Calling this endpoint invalidates the specified session. The current session cannot be revoked.
|
|
Session data are not deleted.
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@param id ID is the session's ID.
|
|
@return FrontendAPIDisableMySessionRequest
|
|
*/
|
|
func (a *FrontendAPIService) DisableMySession(ctx context.Context, id string) FrontendAPIDisableMySessionRequest {
|
|
return FrontendAPIDisableMySessionRequest{
|
|
ApiService: a,
|
|
ctx: ctx,
|
|
id: id,
|
|
}
|
|
}
|
|
|
|
// Execute executes the request
|
|
func (a *FrontendAPIService) DisableMySessionExecute(r FrontendAPIDisableMySessionRequest) (*http.Response, error) {
|
|
var (
|
|
localVarHTTPMethod = http.MethodDelete
|
|
localVarPostBody interface{}
|
|
formFiles []formFile
|
|
)
|
|
|
|
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FrontendAPIService.DisableMySession")
|
|
if err != nil {
|
|
return nil, &GenericOpenAPIError{error: err.Error()}
|
|
}
|
|
|
|
localVarPath := localBasePath + "/sessions/{id}"
|
|
localVarPath = strings.Replace(localVarPath, "{"+"id"+"}", url.PathEscape(parameterValueToString(r.id, "id")), -1)
|
|
|
|
localVarHeaderParams := make(map[string]string)
|
|
localVarQueryParams := url.Values{}
|
|
localVarFormParams := url.Values{}
|
|
|
|
// to determine the Content-Type header
|
|
localVarHTTPContentTypes := []string{}
|
|
|
|
// set Content-Type header
|
|
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
|
|
if localVarHTTPContentType != "" {
|
|
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
|
|
}
|
|
|
|
// to determine the Accept header
|
|
localVarHTTPHeaderAccepts := []string{"application/json"}
|
|
|
|
// set Accept header
|
|
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
|
|
if localVarHTTPHeaderAccept != "" {
|
|
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
|
|
}
|
|
if r.xSessionToken != nil {
|
|
parameterAddToHeaderOrQuery(localVarHeaderParams, "X-Session-Token", r.xSessionToken, "simple", "")
|
|
}
|
|
if r.cookie != nil {
|
|
parameterAddToHeaderOrQuery(localVarHeaderParams, "Cookie", r.cookie, "simple", "")
|
|
}
|
|
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
localVarHTTPResponse, err := a.client.callAPI(req)
|
|
if err != nil || localVarHTTPResponse == nil {
|
|
return localVarHTTPResponse, err
|
|
}
|
|
|
|
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
|
|
localVarHTTPResponse.Body.Close()
|
|
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
|
|
if err != nil {
|
|
return localVarHTTPResponse, err
|
|
}
|
|
|
|
if localVarHTTPResponse.StatusCode >= 300 {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: localVarHTTPResponse.Status,
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 400 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarHTTPResponse, newErr
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 401 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarHTTPResponse, newErr
|
|
}
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarHTTPResponse, newErr
|
|
}
|
|
|
|
return localVarHTTPResponse, nil
|
|
}
|
|
|
|
type FrontendAPIExchangeSessionTokenRequest struct {
|
|
ctx context.Context
|
|
ApiService FrontendAPI
|
|
initCode *string
|
|
returnToCode *string
|
|
}
|
|
|
|
// The part of the code return when initializing the flow.
|
|
func (r FrontendAPIExchangeSessionTokenRequest) InitCode(initCode string) FrontendAPIExchangeSessionTokenRequest {
|
|
r.initCode = &initCode
|
|
return r
|
|
}
|
|
|
|
// The part of the code returned by the return_to URL.
|
|
func (r FrontendAPIExchangeSessionTokenRequest) ReturnToCode(returnToCode string) FrontendAPIExchangeSessionTokenRequest {
|
|
r.returnToCode = &returnToCode
|
|
return r
|
|
}
|
|
|
|
func (r FrontendAPIExchangeSessionTokenRequest) Execute() (*SuccessfulNativeLogin, *http.Response, error) {
|
|
return r.ApiService.ExchangeSessionTokenExecute(r)
|
|
}
|
|
|
|
/*
|
|
ExchangeSessionToken Exchange Session Token
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPIExchangeSessionTokenRequest
|
|
*/
|
|
func (a *FrontendAPIService) ExchangeSessionToken(ctx context.Context) FrontendAPIExchangeSessionTokenRequest {
|
|
return FrontendAPIExchangeSessionTokenRequest{
|
|
ApiService: a,
|
|
ctx: ctx,
|
|
}
|
|
}
|
|
|
|
// Execute executes the request
|
|
//
|
|
// @return SuccessfulNativeLogin
|
|
func (a *FrontendAPIService) ExchangeSessionTokenExecute(r FrontendAPIExchangeSessionTokenRequest) (*SuccessfulNativeLogin, *http.Response, error) {
|
|
var (
|
|
localVarHTTPMethod = http.MethodGet
|
|
localVarPostBody interface{}
|
|
formFiles []formFile
|
|
localVarReturnValue *SuccessfulNativeLogin
|
|
)
|
|
|
|
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FrontendAPIService.ExchangeSessionToken")
|
|
if err != nil {
|
|
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
|
|
}
|
|
|
|
localVarPath := localBasePath + "/sessions/token-exchange"
|
|
|
|
localVarHeaderParams := make(map[string]string)
|
|
localVarQueryParams := url.Values{}
|
|
localVarFormParams := url.Values{}
|
|
if r.initCode == nil {
|
|
return localVarReturnValue, nil, reportError("initCode is required and must be specified")
|
|
}
|
|
if r.returnToCode == nil {
|
|
return localVarReturnValue, nil, reportError("returnToCode is required and must be specified")
|
|
}
|
|
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "init_code", r.initCode, "form", "")
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "return_to_code", r.returnToCode, "form", "")
|
|
// to determine the Content-Type header
|
|
localVarHTTPContentTypes := []string{}
|
|
|
|
// set Content-Type header
|
|
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
|
|
if localVarHTTPContentType != "" {
|
|
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
|
|
}
|
|
|
|
// to determine the Accept header
|
|
localVarHTTPHeaderAccepts := []string{"application/json"}
|
|
|
|
// set Accept header
|
|
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
|
|
if localVarHTTPHeaderAccept != "" {
|
|
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
|
|
}
|
|
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
|
|
if err != nil {
|
|
return localVarReturnValue, nil, err
|
|
}
|
|
|
|
localVarHTTPResponse, err := a.client.callAPI(req)
|
|
if err != nil || localVarHTTPResponse == nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
|
|
localVarHTTPResponse.Body.Close()
|
|
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
|
|
if err != nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
if localVarHTTPResponse.StatusCode >= 300 {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: localVarHTTPResponse.Status,
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 403 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 404 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 410 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: err.Error(),
|
|
}
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
return localVarReturnValue, localVarHTTPResponse, nil
|
|
}
|
|
|
|
type FrontendAPIGetFlowErrorRequest struct {
|
|
ctx context.Context
|
|
ApiService FrontendAPI
|
|
id *string
|
|
}
|
|
|
|
// Error is the error's ID
|
|
func (r FrontendAPIGetFlowErrorRequest) Id(id string) FrontendAPIGetFlowErrorRequest {
|
|
r.id = &id
|
|
return r
|
|
}
|
|
|
|
func (r FrontendAPIGetFlowErrorRequest) Execute() (*FlowError, *http.Response, error) {
|
|
return r.ApiService.GetFlowErrorExecute(r)
|
|
}
|
|
|
|
/*
|
|
GetFlowError 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 ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPIGetFlowErrorRequest
|
|
*/
|
|
func (a *FrontendAPIService) GetFlowError(ctx context.Context) FrontendAPIGetFlowErrorRequest {
|
|
return FrontendAPIGetFlowErrorRequest{
|
|
ApiService: a,
|
|
ctx: ctx,
|
|
}
|
|
}
|
|
|
|
// Execute executes the request
|
|
//
|
|
// @return FlowError
|
|
func (a *FrontendAPIService) GetFlowErrorExecute(r FrontendAPIGetFlowErrorRequest) (*FlowError, *http.Response, error) {
|
|
var (
|
|
localVarHTTPMethod = http.MethodGet
|
|
localVarPostBody interface{}
|
|
formFiles []formFile
|
|
localVarReturnValue *FlowError
|
|
)
|
|
|
|
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FrontendAPIService.GetFlowError")
|
|
if err != nil {
|
|
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
|
|
}
|
|
|
|
localVarPath := localBasePath + "/self-service/errors"
|
|
|
|
localVarHeaderParams := make(map[string]string)
|
|
localVarQueryParams := url.Values{}
|
|
localVarFormParams := url.Values{}
|
|
if r.id == nil {
|
|
return localVarReturnValue, nil, reportError("id is required and must be specified")
|
|
}
|
|
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "id", r.id, "form", "")
|
|
// to determine the Content-Type header
|
|
localVarHTTPContentTypes := []string{}
|
|
|
|
// set Content-Type header
|
|
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
|
|
if localVarHTTPContentType != "" {
|
|
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
|
|
}
|
|
|
|
// to determine the Accept header
|
|
localVarHTTPHeaderAccepts := []string{"application/json"}
|
|
|
|
// set Accept header
|
|
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
|
|
if localVarHTTPHeaderAccept != "" {
|
|
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
|
|
}
|
|
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
|
|
if err != nil {
|
|
return localVarReturnValue, nil, err
|
|
}
|
|
|
|
localVarHTTPResponse, err := a.client.callAPI(req)
|
|
if err != nil || localVarHTTPResponse == nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
|
|
localVarHTTPResponse.Body.Close()
|
|
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
|
|
if err != nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
if localVarHTTPResponse.StatusCode >= 300 {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: localVarHTTPResponse.Status,
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 403 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 404 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 500 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
}
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: err.Error(),
|
|
}
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
return localVarReturnValue, localVarHTTPResponse, nil
|
|
}
|
|
|
|
type FrontendAPIGetLoginFlowRequest struct {
|
|
ctx context.Context
|
|
ApiService FrontendAPI
|
|
id *string
|
|
cookie *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`).
|
|
func (r FrontendAPIGetLoginFlowRequest) Id(id string) FrontendAPIGetLoginFlowRequest {
|
|
r.id = &id
|
|
return r
|
|
}
|
|
|
|
// 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.
|
|
func (r FrontendAPIGetLoginFlowRequest) Cookie(cookie string) FrontendAPIGetLoginFlowRequest {
|
|
r.cookie = &cookie
|
|
return r
|
|
}
|
|
|
|
func (r FrontendAPIGetLoginFlowRequest) Execute() (*LoginFlow, *http.Response, error) {
|
|
return r.ApiService.GetLoginFlowExecute(r)
|
|
}
|
|
|
|
/*
|
|
GetLoginFlow 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).
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPIGetLoginFlowRequest
|
|
*/
|
|
func (a *FrontendAPIService) GetLoginFlow(ctx context.Context) FrontendAPIGetLoginFlowRequest {
|
|
return FrontendAPIGetLoginFlowRequest{
|
|
ApiService: a,
|
|
ctx: ctx,
|
|
}
|
|
}
|
|
|
|
// Execute executes the request
|
|
//
|
|
// @return LoginFlow
|
|
func (a *FrontendAPIService) GetLoginFlowExecute(r FrontendAPIGetLoginFlowRequest) (*LoginFlow, *http.Response, error) {
|
|
var (
|
|
localVarHTTPMethod = http.MethodGet
|
|
localVarPostBody interface{}
|
|
formFiles []formFile
|
|
localVarReturnValue *LoginFlow
|
|
)
|
|
|
|
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FrontendAPIService.GetLoginFlow")
|
|
if err != nil {
|
|
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
|
|
}
|
|
|
|
localVarPath := localBasePath + "/self-service/login/flows"
|
|
|
|
localVarHeaderParams := make(map[string]string)
|
|
localVarQueryParams := url.Values{}
|
|
localVarFormParams := url.Values{}
|
|
if r.id == nil {
|
|
return localVarReturnValue, nil, reportError("id is required and must be specified")
|
|
}
|
|
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "id", r.id, "form", "")
|
|
// to determine the Content-Type header
|
|
localVarHTTPContentTypes := []string{}
|
|
|
|
// set Content-Type header
|
|
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
|
|
if localVarHTTPContentType != "" {
|
|
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
|
|
}
|
|
|
|
// to determine the Accept header
|
|
localVarHTTPHeaderAccepts := []string{"application/json"}
|
|
|
|
// set Accept header
|
|
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
|
|
if localVarHTTPHeaderAccept != "" {
|
|
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
|
|
}
|
|
if r.cookie != nil {
|
|
parameterAddToHeaderOrQuery(localVarHeaderParams, "Cookie", r.cookie, "simple", "")
|
|
}
|
|
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
|
|
if err != nil {
|
|
return localVarReturnValue, nil, err
|
|
}
|
|
|
|
localVarHTTPResponse, err := a.client.callAPI(req)
|
|
if err != nil || localVarHTTPResponse == nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
|
|
localVarHTTPResponse.Body.Close()
|
|
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
|
|
if err != nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
if localVarHTTPResponse.StatusCode >= 300 {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: localVarHTTPResponse.Status,
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 403 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 404 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 410 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: err.Error(),
|
|
}
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
return localVarReturnValue, localVarHTTPResponse, nil
|
|
}
|
|
|
|
type FrontendAPIGetRecoveryFlowRequest struct {
|
|
ctx context.Context
|
|
ApiService FrontendAPI
|
|
id *string
|
|
cookie *string
|
|
}
|
|
|
|
// The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/recovery?flow=abcde`).
|
|
func (r FrontendAPIGetRecoveryFlowRequest) Id(id string) FrontendAPIGetRecoveryFlowRequest {
|
|
r.id = &id
|
|
return r
|
|
}
|
|
|
|
// 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.
|
|
func (r FrontendAPIGetRecoveryFlowRequest) Cookie(cookie string) FrontendAPIGetRecoveryFlowRequest {
|
|
r.cookie = &cookie
|
|
return r
|
|
}
|
|
|
|
func (r FrontendAPIGetRecoveryFlowRequest) Execute() (*RecoveryFlow, *http.Response, error) {
|
|
return r.ApiService.GetRecoveryFlowExecute(r)
|
|
}
|
|
|
|
/*
|
|
GetRecoveryFlow 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).
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPIGetRecoveryFlowRequest
|
|
*/
|
|
func (a *FrontendAPIService) GetRecoveryFlow(ctx context.Context) FrontendAPIGetRecoveryFlowRequest {
|
|
return FrontendAPIGetRecoveryFlowRequest{
|
|
ApiService: a,
|
|
ctx: ctx,
|
|
}
|
|
}
|
|
|
|
// Execute executes the request
|
|
//
|
|
// @return RecoveryFlow
|
|
func (a *FrontendAPIService) GetRecoveryFlowExecute(r FrontendAPIGetRecoveryFlowRequest) (*RecoveryFlow, *http.Response, error) {
|
|
var (
|
|
localVarHTTPMethod = http.MethodGet
|
|
localVarPostBody interface{}
|
|
formFiles []formFile
|
|
localVarReturnValue *RecoveryFlow
|
|
)
|
|
|
|
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FrontendAPIService.GetRecoveryFlow")
|
|
if err != nil {
|
|
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
|
|
}
|
|
|
|
localVarPath := localBasePath + "/self-service/recovery/flows"
|
|
|
|
localVarHeaderParams := make(map[string]string)
|
|
localVarQueryParams := url.Values{}
|
|
localVarFormParams := url.Values{}
|
|
if r.id == nil {
|
|
return localVarReturnValue, nil, reportError("id is required and must be specified")
|
|
}
|
|
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "id", r.id, "form", "")
|
|
// to determine the Content-Type header
|
|
localVarHTTPContentTypes := []string{}
|
|
|
|
// set Content-Type header
|
|
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
|
|
if localVarHTTPContentType != "" {
|
|
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
|
|
}
|
|
|
|
// to determine the Accept header
|
|
localVarHTTPHeaderAccepts := []string{"application/json"}
|
|
|
|
// set Accept header
|
|
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
|
|
if localVarHTTPHeaderAccept != "" {
|
|
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
|
|
}
|
|
if r.cookie != nil {
|
|
parameterAddToHeaderOrQuery(localVarHeaderParams, "Cookie", r.cookie, "simple", "")
|
|
}
|
|
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
|
|
if err != nil {
|
|
return localVarReturnValue, nil, err
|
|
}
|
|
|
|
localVarHTTPResponse, err := a.client.callAPI(req)
|
|
if err != nil || localVarHTTPResponse == nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
|
|
localVarHTTPResponse.Body.Close()
|
|
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
|
|
if err != nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
if localVarHTTPResponse.StatusCode >= 300 {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: localVarHTTPResponse.Status,
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 404 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 410 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: err.Error(),
|
|
}
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
return localVarReturnValue, localVarHTTPResponse, nil
|
|
}
|
|
|
|
type FrontendAPIGetRegistrationFlowRequest struct {
|
|
ctx context.Context
|
|
ApiService FrontendAPI
|
|
id *string
|
|
cookie *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`).
|
|
func (r FrontendAPIGetRegistrationFlowRequest) Id(id string) FrontendAPIGetRegistrationFlowRequest {
|
|
r.id = &id
|
|
return r
|
|
}
|
|
|
|
// 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.
|
|
func (r FrontendAPIGetRegistrationFlowRequest) Cookie(cookie string) FrontendAPIGetRegistrationFlowRequest {
|
|
r.cookie = &cookie
|
|
return r
|
|
}
|
|
|
|
func (r FrontendAPIGetRegistrationFlowRequest) Execute() (*RegistrationFlow, *http.Response, error) {
|
|
return r.ApiService.GetRegistrationFlowExecute(r)
|
|
}
|
|
|
|
/*
|
|
GetRegistrationFlow 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).
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPIGetRegistrationFlowRequest
|
|
*/
|
|
func (a *FrontendAPIService) GetRegistrationFlow(ctx context.Context) FrontendAPIGetRegistrationFlowRequest {
|
|
return FrontendAPIGetRegistrationFlowRequest{
|
|
ApiService: a,
|
|
ctx: ctx,
|
|
}
|
|
}
|
|
|
|
// Execute executes the request
|
|
//
|
|
// @return RegistrationFlow
|
|
func (a *FrontendAPIService) GetRegistrationFlowExecute(r FrontendAPIGetRegistrationFlowRequest) (*RegistrationFlow, *http.Response, error) {
|
|
var (
|
|
localVarHTTPMethod = http.MethodGet
|
|
localVarPostBody interface{}
|
|
formFiles []formFile
|
|
localVarReturnValue *RegistrationFlow
|
|
)
|
|
|
|
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FrontendAPIService.GetRegistrationFlow")
|
|
if err != nil {
|
|
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
|
|
}
|
|
|
|
localVarPath := localBasePath + "/self-service/registration/flows"
|
|
|
|
localVarHeaderParams := make(map[string]string)
|
|
localVarQueryParams := url.Values{}
|
|
localVarFormParams := url.Values{}
|
|
if r.id == nil {
|
|
return localVarReturnValue, nil, reportError("id is required and must be specified")
|
|
}
|
|
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "id", r.id, "form", "")
|
|
// to determine the Content-Type header
|
|
localVarHTTPContentTypes := []string{}
|
|
|
|
// set Content-Type header
|
|
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
|
|
if localVarHTTPContentType != "" {
|
|
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
|
|
}
|
|
|
|
// to determine the Accept header
|
|
localVarHTTPHeaderAccepts := []string{"application/json"}
|
|
|
|
// set Accept header
|
|
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
|
|
if localVarHTTPHeaderAccept != "" {
|
|
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
|
|
}
|
|
if r.cookie != nil {
|
|
parameterAddToHeaderOrQuery(localVarHeaderParams, "Cookie", r.cookie, "simple", "")
|
|
}
|
|
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
|
|
if err != nil {
|
|
return localVarReturnValue, nil, err
|
|
}
|
|
|
|
localVarHTTPResponse, err := a.client.callAPI(req)
|
|
if err != nil || localVarHTTPResponse == nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
|
|
localVarHTTPResponse.Body.Close()
|
|
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
|
|
if err != nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
if localVarHTTPResponse.StatusCode >= 300 {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: localVarHTTPResponse.Status,
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 403 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 404 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 410 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: err.Error(),
|
|
}
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
return localVarReturnValue, localVarHTTPResponse, nil
|
|
}
|
|
|
|
type FrontendAPIGetSettingsFlowRequest struct {
|
|
ctx context.Context
|
|
ApiService FrontendAPI
|
|
id *string
|
|
xSessionToken *string
|
|
cookie *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`).
|
|
func (r FrontendAPIGetSettingsFlowRequest) Id(id string) FrontendAPIGetSettingsFlowRequest {
|
|
r.id = &id
|
|
return r
|
|
}
|
|
|
|
// The Session Token When using the SDK in an app without a browser, please include the session token here.
|
|
func (r FrontendAPIGetSettingsFlowRequest) XSessionToken(xSessionToken string) FrontendAPIGetSettingsFlowRequest {
|
|
r.xSessionToken = &xSessionToken
|
|
return r
|
|
}
|
|
|
|
// 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.
|
|
func (r FrontendAPIGetSettingsFlowRequest) Cookie(cookie string) FrontendAPIGetSettingsFlowRequest {
|
|
r.cookie = &cookie
|
|
return r
|
|
}
|
|
|
|
func (r FrontendAPIGetSettingsFlowRequest) Execute() (*SettingsFlow, *http.Response, error) {
|
|
return r.ApiService.GetSettingsFlowExecute(r)
|
|
}
|
|
|
|
/*
|
|
GetSettingsFlow 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).
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPIGetSettingsFlowRequest
|
|
*/
|
|
func (a *FrontendAPIService) GetSettingsFlow(ctx context.Context) FrontendAPIGetSettingsFlowRequest {
|
|
return FrontendAPIGetSettingsFlowRequest{
|
|
ApiService: a,
|
|
ctx: ctx,
|
|
}
|
|
}
|
|
|
|
// Execute executes the request
|
|
//
|
|
// @return SettingsFlow
|
|
func (a *FrontendAPIService) GetSettingsFlowExecute(r FrontendAPIGetSettingsFlowRequest) (*SettingsFlow, *http.Response, error) {
|
|
var (
|
|
localVarHTTPMethod = http.MethodGet
|
|
localVarPostBody interface{}
|
|
formFiles []formFile
|
|
localVarReturnValue *SettingsFlow
|
|
)
|
|
|
|
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FrontendAPIService.GetSettingsFlow")
|
|
if err != nil {
|
|
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
|
|
}
|
|
|
|
localVarPath := localBasePath + "/self-service/settings/flows"
|
|
|
|
localVarHeaderParams := make(map[string]string)
|
|
localVarQueryParams := url.Values{}
|
|
localVarFormParams := url.Values{}
|
|
if r.id == nil {
|
|
return localVarReturnValue, nil, reportError("id is required and must be specified")
|
|
}
|
|
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "id", r.id, "form", "")
|
|
// to determine the Content-Type header
|
|
localVarHTTPContentTypes := []string{}
|
|
|
|
// set Content-Type header
|
|
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
|
|
if localVarHTTPContentType != "" {
|
|
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
|
|
}
|
|
|
|
// to determine the Accept header
|
|
localVarHTTPHeaderAccepts := []string{"application/json"}
|
|
|
|
// set Accept header
|
|
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
|
|
if localVarHTTPHeaderAccept != "" {
|
|
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
|
|
}
|
|
if r.xSessionToken != nil {
|
|
parameterAddToHeaderOrQuery(localVarHeaderParams, "X-Session-Token", r.xSessionToken, "simple", "")
|
|
}
|
|
if r.cookie != nil {
|
|
parameterAddToHeaderOrQuery(localVarHeaderParams, "Cookie", r.cookie, "simple", "")
|
|
}
|
|
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
|
|
if err != nil {
|
|
return localVarReturnValue, nil, err
|
|
}
|
|
|
|
localVarHTTPResponse, err := a.client.callAPI(req)
|
|
if err != nil || localVarHTTPResponse == nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
|
|
localVarHTTPResponse.Body.Close()
|
|
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
|
|
if err != nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
if localVarHTTPResponse.StatusCode >= 300 {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: localVarHTTPResponse.Status,
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 401 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 403 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 404 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 410 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: err.Error(),
|
|
}
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
return localVarReturnValue, localVarHTTPResponse, nil
|
|
}
|
|
|
|
type FrontendAPIGetVerificationFlowRequest struct {
|
|
ctx context.Context
|
|
ApiService FrontendAPI
|
|
id *string
|
|
cookie *string
|
|
}
|
|
|
|
// The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verification?flow=abcde`).
|
|
func (r FrontendAPIGetVerificationFlowRequest) Id(id string) FrontendAPIGetVerificationFlowRequest {
|
|
r.id = &id
|
|
return r
|
|
}
|
|
|
|
// HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here.
|
|
func (r FrontendAPIGetVerificationFlowRequest) Cookie(cookie string) FrontendAPIGetVerificationFlowRequest {
|
|
r.cookie = &cookie
|
|
return r
|
|
}
|
|
|
|
func (r FrontendAPIGetVerificationFlowRequest) Execute() (*VerificationFlow, *http.Response, error) {
|
|
return r.ApiService.GetVerificationFlowExecute(r)
|
|
}
|
|
|
|
/*
|
|
GetVerificationFlow 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).
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPIGetVerificationFlowRequest
|
|
*/
|
|
func (a *FrontendAPIService) GetVerificationFlow(ctx context.Context) FrontendAPIGetVerificationFlowRequest {
|
|
return FrontendAPIGetVerificationFlowRequest{
|
|
ApiService: a,
|
|
ctx: ctx,
|
|
}
|
|
}
|
|
|
|
// Execute executes the request
|
|
//
|
|
// @return VerificationFlow
|
|
func (a *FrontendAPIService) GetVerificationFlowExecute(r FrontendAPIGetVerificationFlowRequest) (*VerificationFlow, *http.Response, error) {
|
|
var (
|
|
localVarHTTPMethod = http.MethodGet
|
|
localVarPostBody interface{}
|
|
formFiles []formFile
|
|
localVarReturnValue *VerificationFlow
|
|
)
|
|
|
|
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FrontendAPIService.GetVerificationFlow")
|
|
if err != nil {
|
|
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
|
|
}
|
|
|
|
localVarPath := localBasePath + "/self-service/verification/flows"
|
|
|
|
localVarHeaderParams := make(map[string]string)
|
|
localVarQueryParams := url.Values{}
|
|
localVarFormParams := url.Values{}
|
|
if r.id == nil {
|
|
return localVarReturnValue, nil, reportError("id is required and must be specified")
|
|
}
|
|
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "id", r.id, "form", "")
|
|
// to determine the Content-Type header
|
|
localVarHTTPContentTypes := []string{}
|
|
|
|
// set Content-Type header
|
|
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
|
|
if localVarHTTPContentType != "" {
|
|
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
|
|
}
|
|
|
|
// to determine the Accept header
|
|
localVarHTTPHeaderAccepts := []string{"application/json"}
|
|
|
|
// set Accept header
|
|
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
|
|
if localVarHTTPHeaderAccept != "" {
|
|
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
|
|
}
|
|
if r.cookie != nil {
|
|
parameterAddToHeaderOrQuery(localVarHeaderParams, "cookie", r.cookie, "simple", "")
|
|
}
|
|
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
|
|
if err != nil {
|
|
return localVarReturnValue, nil, err
|
|
}
|
|
|
|
localVarHTTPResponse, err := a.client.callAPI(req)
|
|
if err != nil || localVarHTTPResponse == nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
|
|
localVarHTTPResponse.Body.Close()
|
|
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
|
|
if err != nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
if localVarHTTPResponse.StatusCode >= 300 {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: localVarHTTPResponse.Status,
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 403 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 404 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: err.Error(),
|
|
}
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
return localVarReturnValue, localVarHTTPResponse, nil
|
|
}
|
|
|
|
type FrontendAPIGetWebAuthnJavaScriptRequest struct {
|
|
ctx context.Context
|
|
ApiService FrontendAPI
|
|
}
|
|
|
|
func (r FrontendAPIGetWebAuthnJavaScriptRequest) Execute() (string, *http.Response, error) {
|
|
return r.ApiService.GetWebAuthnJavaScriptExecute(r)
|
|
}
|
|
|
|
/*
|
|
GetWebAuthnJavaScript 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
|
|
<script src="https://public-kratos.example.org/.well-known/ory/webauthn.js" type="script" async />
|
|
```
|
|
|
|
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 ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPIGetWebAuthnJavaScriptRequest
|
|
*/
|
|
func (a *FrontendAPIService) GetWebAuthnJavaScript(ctx context.Context) FrontendAPIGetWebAuthnJavaScriptRequest {
|
|
return FrontendAPIGetWebAuthnJavaScriptRequest{
|
|
ApiService: a,
|
|
ctx: ctx,
|
|
}
|
|
}
|
|
|
|
// Execute executes the request
|
|
//
|
|
// @return string
|
|
func (a *FrontendAPIService) GetWebAuthnJavaScriptExecute(r FrontendAPIGetWebAuthnJavaScriptRequest) (string, *http.Response, error) {
|
|
var (
|
|
localVarHTTPMethod = http.MethodGet
|
|
localVarPostBody interface{}
|
|
formFiles []formFile
|
|
localVarReturnValue string
|
|
)
|
|
|
|
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FrontendAPIService.GetWebAuthnJavaScript")
|
|
if err != nil {
|
|
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
|
|
}
|
|
|
|
localVarPath := localBasePath + "/.well-known/ory/webauthn.js"
|
|
|
|
localVarHeaderParams := make(map[string]string)
|
|
localVarQueryParams := url.Values{}
|
|
localVarFormParams := url.Values{}
|
|
|
|
// to determine the Content-Type header
|
|
localVarHTTPContentTypes := []string{}
|
|
|
|
// set Content-Type header
|
|
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
|
|
if localVarHTTPContentType != "" {
|
|
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
|
|
}
|
|
|
|
// to determine the Accept header
|
|
localVarHTTPHeaderAccepts := []string{"application/json"}
|
|
|
|
// set Accept header
|
|
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
|
|
if localVarHTTPHeaderAccept != "" {
|
|
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
|
|
}
|
|
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
|
|
if err != nil {
|
|
return localVarReturnValue, nil, err
|
|
}
|
|
|
|
localVarHTTPResponse, err := a.client.callAPI(req)
|
|
if err != nil || localVarHTTPResponse == nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
|
|
localVarHTTPResponse.Body.Close()
|
|
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
|
|
if err != nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
if localVarHTTPResponse.StatusCode >= 300 {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: localVarHTTPResponse.Status,
|
|
}
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: err.Error(),
|
|
}
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
return localVarReturnValue, localVarHTTPResponse, nil
|
|
}
|
|
|
|
type FrontendAPIListMySessionsRequest struct {
|
|
ctx context.Context
|
|
ApiService FrontendAPI
|
|
perPage *int64
|
|
page *int64
|
|
pageSize *int64
|
|
pageToken *string
|
|
xSessionToken *string
|
|
cookie *string
|
|
}
|
|
|
|
// Deprecated Items per Page DEPRECATED: Please use `page_token` instead. This parameter will be removed in the future. This is the number of items per page.
|
|
func (r FrontendAPIListMySessionsRequest) PerPage(perPage int64) FrontendAPIListMySessionsRequest {
|
|
r.perPage = &perPage
|
|
return r
|
|
}
|
|
|
|
// Deprecated Pagination Page DEPRECATED: Please use `page_token` instead. This parameter will be removed in the future. This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list. For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist. The first page can be retrieved by omitting this parameter. Following page pointers will be returned in the `Link` header.
|
|
func (r FrontendAPIListMySessionsRequest) Page(page int64) FrontendAPIListMySessionsRequest {
|
|
r.page = &page
|
|
return r
|
|
}
|
|
|
|
// Page Size This is the number of items per page to return. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).
|
|
func (r FrontendAPIListMySessionsRequest) PageSize(pageSize int64) FrontendAPIListMySessionsRequest {
|
|
r.pageSize = &pageSize
|
|
return r
|
|
}
|
|
|
|
// Next Page Token The next page token. For details on pagination please head over to the [pagination documentation](https://www.ory.sh/docs/ecosystem/api-design#pagination).
|
|
func (r FrontendAPIListMySessionsRequest) PageToken(pageToken string) FrontendAPIListMySessionsRequest {
|
|
r.pageToken = &pageToken
|
|
return r
|
|
}
|
|
|
|
// Set the Session Token when calling from non-browser clients. A session token has a format of `MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj`.
|
|
func (r FrontendAPIListMySessionsRequest) XSessionToken(xSessionToken string) FrontendAPIListMySessionsRequest {
|
|
r.xSessionToken = &xSessionToken
|
|
return r
|
|
}
|
|
|
|
// 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.
|
|
func (r FrontendAPIListMySessionsRequest) Cookie(cookie string) FrontendAPIListMySessionsRequest {
|
|
r.cookie = &cookie
|
|
return r
|
|
}
|
|
|
|
func (r FrontendAPIListMySessionsRequest) Execute() ([]Session, *http.Response, error) {
|
|
return r.ApiService.ListMySessionsExecute(r)
|
|
}
|
|
|
|
/*
|
|
ListMySessions Get My Active Sessions
|
|
|
|
This endpoints returns all other active sessions that belong to the logged-in user.
|
|
The current session can be retrieved by calling the `/sessions/whoami` endpoint.
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPIListMySessionsRequest
|
|
*/
|
|
func (a *FrontendAPIService) ListMySessions(ctx context.Context) FrontendAPIListMySessionsRequest {
|
|
return FrontendAPIListMySessionsRequest{
|
|
ApiService: a,
|
|
ctx: ctx,
|
|
}
|
|
}
|
|
|
|
// Execute executes the request
|
|
//
|
|
// @return []Session
|
|
func (a *FrontendAPIService) ListMySessionsExecute(r FrontendAPIListMySessionsRequest) ([]Session, *http.Response, error) {
|
|
var (
|
|
localVarHTTPMethod = http.MethodGet
|
|
localVarPostBody interface{}
|
|
formFiles []formFile
|
|
localVarReturnValue []Session
|
|
)
|
|
|
|
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FrontendAPIService.ListMySessions")
|
|
if err != nil {
|
|
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
|
|
}
|
|
|
|
localVarPath := localBasePath + "/sessions"
|
|
|
|
localVarHeaderParams := make(map[string]string)
|
|
localVarQueryParams := url.Values{}
|
|
localVarFormParams := url.Values{}
|
|
|
|
if r.perPage != nil {
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "per_page", r.perPage, "form", "")
|
|
} else {
|
|
var defaultValue int64 = 250
|
|
r.perPage = &defaultValue
|
|
}
|
|
if r.page != nil {
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "page", r.page, "form", "")
|
|
}
|
|
if r.pageSize != nil {
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "page_size", r.pageSize, "form", "")
|
|
} else {
|
|
var defaultValue int64 = 250
|
|
r.pageSize = &defaultValue
|
|
}
|
|
if r.pageToken != nil {
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "page_token", r.pageToken, "form", "")
|
|
} else {
|
|
var defaultValue string = "1"
|
|
r.pageToken = &defaultValue
|
|
}
|
|
// to determine the Content-Type header
|
|
localVarHTTPContentTypes := []string{}
|
|
|
|
// set Content-Type header
|
|
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
|
|
if localVarHTTPContentType != "" {
|
|
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
|
|
}
|
|
|
|
// to determine the Accept header
|
|
localVarHTTPHeaderAccepts := []string{"application/json"}
|
|
|
|
// set Accept header
|
|
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
|
|
if localVarHTTPHeaderAccept != "" {
|
|
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
|
|
}
|
|
if r.xSessionToken != nil {
|
|
parameterAddToHeaderOrQuery(localVarHeaderParams, "X-Session-Token", r.xSessionToken, "simple", "")
|
|
}
|
|
if r.cookie != nil {
|
|
parameterAddToHeaderOrQuery(localVarHeaderParams, "Cookie", r.cookie, "simple", "")
|
|
}
|
|
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
|
|
if err != nil {
|
|
return localVarReturnValue, nil, err
|
|
}
|
|
|
|
localVarHTTPResponse, err := a.client.callAPI(req)
|
|
if err != nil || localVarHTTPResponse == nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
|
|
localVarHTTPResponse.Body.Close()
|
|
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
|
|
if err != nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
if localVarHTTPResponse.StatusCode >= 300 {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: localVarHTTPResponse.Status,
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 400 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 401 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: err.Error(),
|
|
}
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
return localVarReturnValue, localVarHTTPResponse, nil
|
|
}
|
|
|
|
type FrontendAPIPerformNativeLogoutRequest struct {
|
|
ctx context.Context
|
|
ApiService FrontendAPI
|
|
performNativeLogoutBody *PerformNativeLogoutBody
|
|
}
|
|
|
|
func (r FrontendAPIPerformNativeLogoutRequest) PerformNativeLogoutBody(performNativeLogoutBody PerformNativeLogoutBody) FrontendAPIPerformNativeLogoutRequest {
|
|
r.performNativeLogoutBody = &performNativeLogoutBody
|
|
return r
|
|
}
|
|
|
|
func (r FrontendAPIPerformNativeLogoutRequest) Execute() (*http.Response, error) {
|
|
return r.ApiService.PerformNativeLogoutExecute(r)
|
|
}
|
|
|
|
/*
|
|
PerformNativeLogout Perform Logout for Native Apps
|
|
|
|
Use this endpoint to log out an identity using an Ory Session Token. If the Ory Session Token was successfully
|
|
revoked, the server returns a 204 No Content response. A 204 No Content response is also sent when
|
|
the Ory Session Token has been revoked already before.
|
|
|
|
If the Ory Session Token is malformed or does not exist a 403 Forbidden response will be returned.
|
|
|
|
This endpoint does not remove any HTTP
|
|
Cookies - use the Browser-Based Self-Service Logout Flow instead.
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPIPerformNativeLogoutRequest
|
|
*/
|
|
func (a *FrontendAPIService) PerformNativeLogout(ctx context.Context) FrontendAPIPerformNativeLogoutRequest {
|
|
return FrontendAPIPerformNativeLogoutRequest{
|
|
ApiService: a,
|
|
ctx: ctx,
|
|
}
|
|
}
|
|
|
|
// Execute executes the request
|
|
func (a *FrontendAPIService) PerformNativeLogoutExecute(r FrontendAPIPerformNativeLogoutRequest) (*http.Response, error) {
|
|
var (
|
|
localVarHTTPMethod = http.MethodDelete
|
|
localVarPostBody interface{}
|
|
formFiles []formFile
|
|
)
|
|
|
|
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FrontendAPIService.PerformNativeLogout")
|
|
if err != nil {
|
|
return nil, &GenericOpenAPIError{error: err.Error()}
|
|
}
|
|
|
|
localVarPath := localBasePath + "/self-service/logout/api"
|
|
|
|
localVarHeaderParams := make(map[string]string)
|
|
localVarQueryParams := url.Values{}
|
|
localVarFormParams := url.Values{}
|
|
if r.performNativeLogoutBody == nil {
|
|
return nil, reportError("performNativeLogoutBody is required and must be specified")
|
|
}
|
|
|
|
// to determine the Content-Type header
|
|
localVarHTTPContentTypes := []string{"application/json"}
|
|
|
|
// set Content-Type header
|
|
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
|
|
if localVarHTTPContentType != "" {
|
|
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
|
|
}
|
|
|
|
// to determine the Accept header
|
|
localVarHTTPHeaderAccepts := []string{"application/json"}
|
|
|
|
// set Accept header
|
|
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
|
|
if localVarHTTPHeaderAccept != "" {
|
|
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
|
|
}
|
|
// body params
|
|
localVarPostBody = r.performNativeLogoutBody
|
|
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
localVarHTTPResponse, err := a.client.callAPI(req)
|
|
if err != nil || localVarHTTPResponse == nil {
|
|
return localVarHTTPResponse, err
|
|
}
|
|
|
|
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
|
|
localVarHTTPResponse.Body.Close()
|
|
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
|
|
if err != nil {
|
|
return localVarHTTPResponse, err
|
|
}
|
|
|
|
if localVarHTTPResponse.StatusCode >= 300 {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: localVarHTTPResponse.Status,
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 400 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarHTTPResponse, newErr
|
|
}
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarHTTPResponse, newErr
|
|
}
|
|
|
|
return localVarHTTPResponse, nil
|
|
}
|
|
|
|
type FrontendAPIToSessionRequest struct {
|
|
ctx context.Context
|
|
ApiService FrontendAPI
|
|
xSessionToken *string
|
|
cookie *string
|
|
tokenizeAs *string
|
|
}
|
|
|
|
// Set the Session Token when calling from non-browser clients. A session token has a format of `MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj`.
|
|
func (r FrontendAPIToSessionRequest) XSessionToken(xSessionToken string) FrontendAPIToSessionRequest {
|
|
r.xSessionToken = &xSessionToken
|
|
return r
|
|
}
|
|
|
|
// 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.
|
|
func (r FrontendAPIToSessionRequest) Cookie(cookie string) FrontendAPIToSessionRequest {
|
|
r.cookie = &cookie
|
|
return r
|
|
}
|
|
|
|
// Returns the session additionally as a token (such as a JWT) The value of this parameter has to be a valid, configured Ory Session token template. For more information head over to [the documentation](http://ory.sh/docs/identities/session-to-jwt-cors).
|
|
func (r FrontendAPIToSessionRequest) TokenizeAs(tokenizeAs string) FrontendAPIToSessionRequest {
|
|
r.tokenizeAs = &tokenizeAs
|
|
return r
|
|
}
|
|
|
|
func (r FrontendAPIToSessionRequest) Execute() (*Session, *http.Response, error) {
|
|
return r.ApiService.ToSessionExecute(r)
|
|
}
|
|
|
|
/*
|
|
ToSession Check Who the Current HTTP Session Belongs To
|
|
|
|
Uses the HTTP Headers in the GET request to determine (e.g. by using checking the cookies) who is authenticated.
|
|
Returns a session object in the body or 401 if the credentials are invalid or no credentials were sent.
|
|
When the request it successful it adds the user ID to the 'X-Kratos-Authenticated-Identity-Id' header
|
|
in the response.
|
|
|
|
If you call this endpoint from a server-side application, you must forward the HTTP Cookie Header to this endpoint:
|
|
|
|
```js
|
|
pseudo-code example
|
|
router.get('/protected-endpoint', async function (req, res) {
|
|
const session = await client.toSession(undefined, req.header('cookie'))
|
|
|
|
console.log(session)
|
|
})
|
|
```
|
|
|
|
When calling this endpoint from a non-browser application (e.g. mobile app) you must include the session token:
|
|
|
|
```js
|
|
pseudo-code example
|
|
...
|
|
const session = await client.toSession("the-session-token")
|
|
|
|
console.log(session)
|
|
```
|
|
|
|
When using a token template, the token is included in the `tokenized` field of the session.
|
|
|
|
```js
|
|
pseudo-code example
|
|
...
|
|
const session = await client.toSession("the-session-token", { tokenize_as: "example-jwt-template" })
|
|
|
|
console.log(session.tokenized) // The JWT
|
|
```
|
|
|
|
Depending on your configuration this endpoint might return a 403 status code if the session has a lower Authenticator
|
|
Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn
|
|
credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user
|
|
to sign in with the second factor or change the configuration.
|
|
|
|
This endpoint is useful for:
|
|
|
|
AJAX calls. Remember to send credentials and set up CORS correctly!
|
|
Reverse proxies and API Gateways
|
|
Server-side calls - use the `X-Session-Token` header!
|
|
|
|
This endpoint authenticates users by checking:
|
|
|
|
if the `Cookie` HTTP header was set containing an Ory Kratos Session Cookie;
|
|
if the `Authorization: bearer <ory-session-token>` HTTP header was set with a valid Ory Kratos Session Token;
|
|
if the `X-Session-Token` HTTP header was set with a valid Ory Kratos Session Token.
|
|
|
|
If none of these headers are set or the cookie or token are invalid, the endpoint returns a HTTP 401 status code.
|
|
|
|
As explained above, this request may fail due to several reasons. The `error.id` can be one of:
|
|
|
|
`session_inactive`: No active session was found in the request (e.g. no Ory Session Cookie / Ory Session Token).
|
|
`session_aal2_required`: An active session was found but it does not fulfil the Authenticator Assurance Level, implying that the session must (e.g.) authenticate the second factor.
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPIToSessionRequest
|
|
*/
|
|
func (a *FrontendAPIService) ToSession(ctx context.Context) FrontendAPIToSessionRequest {
|
|
return FrontendAPIToSessionRequest{
|
|
ApiService: a,
|
|
ctx: ctx,
|
|
}
|
|
}
|
|
|
|
// Execute executes the request
|
|
//
|
|
// @return Session
|
|
func (a *FrontendAPIService) ToSessionExecute(r FrontendAPIToSessionRequest) (*Session, *http.Response, error) {
|
|
var (
|
|
localVarHTTPMethod = http.MethodGet
|
|
localVarPostBody interface{}
|
|
formFiles []formFile
|
|
localVarReturnValue *Session
|
|
)
|
|
|
|
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FrontendAPIService.ToSession")
|
|
if err != nil {
|
|
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
|
|
}
|
|
|
|
localVarPath := localBasePath + "/sessions/whoami"
|
|
|
|
localVarHeaderParams := make(map[string]string)
|
|
localVarQueryParams := url.Values{}
|
|
localVarFormParams := url.Values{}
|
|
|
|
if r.tokenizeAs != nil {
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "tokenize_as", r.tokenizeAs, "form", "")
|
|
}
|
|
// to determine the Content-Type header
|
|
localVarHTTPContentTypes := []string{}
|
|
|
|
// set Content-Type header
|
|
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
|
|
if localVarHTTPContentType != "" {
|
|
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
|
|
}
|
|
|
|
// to determine the Accept header
|
|
localVarHTTPHeaderAccepts := []string{"application/json"}
|
|
|
|
// set Accept header
|
|
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
|
|
if localVarHTTPHeaderAccept != "" {
|
|
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
|
|
}
|
|
if r.xSessionToken != nil {
|
|
parameterAddToHeaderOrQuery(localVarHeaderParams, "X-Session-Token", r.xSessionToken, "simple", "")
|
|
}
|
|
if r.cookie != nil {
|
|
parameterAddToHeaderOrQuery(localVarHeaderParams, "Cookie", r.cookie, "simple", "")
|
|
}
|
|
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
|
|
if err != nil {
|
|
return localVarReturnValue, nil, err
|
|
}
|
|
|
|
localVarHTTPResponse, err := a.client.callAPI(req)
|
|
if err != nil || localVarHTTPResponse == nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
|
|
localVarHTTPResponse.Body.Close()
|
|
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
|
|
if err != nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
if localVarHTTPResponse.StatusCode >= 300 {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: localVarHTTPResponse.Status,
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 401 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 403 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: err.Error(),
|
|
}
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
return localVarReturnValue, localVarHTTPResponse, nil
|
|
}
|
|
|
|
type FrontendAPIUpdateFedcmFlowRequest struct {
|
|
ctx context.Context
|
|
ApiService FrontendAPI
|
|
updateFedcmFlowBody *UpdateFedcmFlowBody
|
|
}
|
|
|
|
func (r FrontendAPIUpdateFedcmFlowRequest) UpdateFedcmFlowBody(updateFedcmFlowBody UpdateFedcmFlowBody) FrontendAPIUpdateFedcmFlowRequest {
|
|
r.updateFedcmFlowBody = &updateFedcmFlowBody
|
|
return r
|
|
}
|
|
|
|
func (r FrontendAPIUpdateFedcmFlowRequest) Execute() (*SuccessfulNativeLogin, *http.Response, error) {
|
|
return r.ApiService.UpdateFedcmFlowExecute(r)
|
|
}
|
|
|
|
/*
|
|
UpdateFedcmFlow Submit a FedCM token
|
|
|
|
Use this endpoint to submit a token from a FedCM provider through
|
|
`navigator.credentials.get` and log the user in. The parameters from
|
|
`navigator.credentials.get` must have come from `GET
|
|
self-service/fed-cm/parameters`.
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPIUpdateFedcmFlowRequest
|
|
*/
|
|
func (a *FrontendAPIService) UpdateFedcmFlow(ctx context.Context) FrontendAPIUpdateFedcmFlowRequest {
|
|
return FrontendAPIUpdateFedcmFlowRequest{
|
|
ApiService: a,
|
|
ctx: ctx,
|
|
}
|
|
}
|
|
|
|
// Execute executes the request
|
|
//
|
|
// @return SuccessfulNativeLogin
|
|
func (a *FrontendAPIService) UpdateFedcmFlowExecute(r FrontendAPIUpdateFedcmFlowRequest) (*SuccessfulNativeLogin, *http.Response, error) {
|
|
var (
|
|
localVarHTTPMethod = http.MethodPost
|
|
localVarPostBody interface{}
|
|
formFiles []formFile
|
|
localVarReturnValue *SuccessfulNativeLogin
|
|
)
|
|
|
|
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FrontendAPIService.UpdateFedcmFlow")
|
|
if err != nil {
|
|
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
|
|
}
|
|
|
|
localVarPath := localBasePath + "/self-service/fed-cm/token"
|
|
|
|
localVarHeaderParams := make(map[string]string)
|
|
localVarQueryParams := url.Values{}
|
|
localVarFormParams := url.Values{}
|
|
if r.updateFedcmFlowBody == nil {
|
|
return localVarReturnValue, nil, reportError("updateFedcmFlowBody is required and must be specified")
|
|
}
|
|
|
|
// to determine the Content-Type header
|
|
localVarHTTPContentTypes := []string{"application/json", "application/x-www-form-urlencoded"}
|
|
|
|
// set Content-Type header
|
|
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
|
|
if localVarHTTPContentType != "" {
|
|
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
|
|
}
|
|
|
|
// to determine the Accept header
|
|
localVarHTTPHeaderAccepts := []string{"application/json"}
|
|
|
|
// set Accept header
|
|
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
|
|
if localVarHTTPHeaderAccept != "" {
|
|
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
|
|
}
|
|
// body params
|
|
localVarPostBody = r.updateFedcmFlowBody
|
|
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
|
|
if err != nil {
|
|
return localVarReturnValue, nil, err
|
|
}
|
|
|
|
localVarHTTPResponse, err := a.client.callAPI(req)
|
|
if err != nil || localVarHTTPResponse == nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
|
|
localVarHTTPResponse.Body.Close()
|
|
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
|
|
if err != nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
if localVarHTTPResponse.StatusCode >= 300 {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: localVarHTTPResponse.Status,
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 400 {
|
|
var v LoginFlow
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 410 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 422 {
|
|
var v ErrorBrowserLocationChangeRequired
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: err.Error(),
|
|
}
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
return localVarReturnValue, localVarHTTPResponse, nil
|
|
}
|
|
|
|
type FrontendAPIUpdateLoginFlowRequest struct {
|
|
ctx context.Context
|
|
ApiService FrontendAPI
|
|
flow *string
|
|
updateLoginFlowBody *UpdateLoginFlowBody
|
|
xSessionToken *string
|
|
cookie *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`).
|
|
func (r FrontendAPIUpdateLoginFlowRequest) Flow(flow string) FrontendAPIUpdateLoginFlowRequest {
|
|
r.flow = &flow
|
|
return r
|
|
}
|
|
|
|
func (r FrontendAPIUpdateLoginFlowRequest) UpdateLoginFlowBody(updateLoginFlowBody UpdateLoginFlowBody) FrontendAPIUpdateLoginFlowRequest {
|
|
r.updateLoginFlowBody = &updateLoginFlowBody
|
|
return r
|
|
}
|
|
|
|
// The Session Token of the Identity performing the settings flow.
|
|
func (r FrontendAPIUpdateLoginFlowRequest) XSessionToken(xSessionToken string) FrontendAPIUpdateLoginFlowRequest {
|
|
r.xSessionToken = &xSessionToken
|
|
return r
|
|
}
|
|
|
|
// 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.
|
|
func (r FrontendAPIUpdateLoginFlowRequest) Cookie(cookie string) FrontendAPIUpdateLoginFlowRequest {
|
|
r.cookie = &cookie
|
|
return r
|
|
}
|
|
|
|
func (r FrontendAPIUpdateLoginFlowRequest) Execute() (*SuccessfulNativeLogin, *http.Response, error) {
|
|
return r.ApiService.UpdateLoginFlowExecute(r)
|
|
}
|
|
|
|
/*
|
|
UpdateLoginFlow Submit a Login Flow
|
|
|
|
Use this endpoint to complete a login flow. This endpoint
|
|
behaves differently for API and browser flows.
|
|
|
|
API flows expect `application/json` to be sent in the body and responds with
|
|
HTTP 200 and a application/json body with the session token on success;
|
|
HTTP 410 if the original flow expired with the appropriate error messages set and optionally a `use_flow_id` parameter in the body;
|
|
HTTP 400 on form validation errors.
|
|
|
|
Browser flows expect a Content-Type of `application/x-www-form-urlencoded` or `application/json` to be sent in the body and respond with
|
|
a HTTP 303 redirect to the post/after login URL or the `return_to` value if it was set and if the login succeeded;
|
|
a HTTP 303 redirect to the login UI URL with the flow ID containing the validation errors otherwise.
|
|
|
|
Browser flows with an accept header of `application/json` will not redirect but instead respond with
|
|
HTTP 200 and a application/json body with the signed in identity and a `Set-Cookie` header on success;
|
|
HTTP 303 redirect to a fresh login flow if the original flow expired with the appropriate error messages set;
|
|
HTTP 400 on form validation errors.
|
|
|
|
If this endpoint is called with `Accept: application/json` in the header, the response contains the flow without a redirect. In the
|
|
case of an error, the `error.id` of the JSON response body can be one of:
|
|
|
|
`session_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!
|
|
`browser_location_change_required`: Usually sent when an AJAX request indicates that the browser needs to open a specific URL.
|
|
Most likely used in Social Sign In flows.
|
|
|
|
More information can be found at [Ory Kratos User 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 ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPIUpdateLoginFlowRequest
|
|
*/
|
|
func (a *FrontendAPIService) UpdateLoginFlow(ctx context.Context) FrontendAPIUpdateLoginFlowRequest {
|
|
return FrontendAPIUpdateLoginFlowRequest{
|
|
ApiService: a,
|
|
ctx: ctx,
|
|
}
|
|
}
|
|
|
|
// Execute executes the request
|
|
//
|
|
// @return SuccessfulNativeLogin
|
|
func (a *FrontendAPIService) UpdateLoginFlowExecute(r FrontendAPIUpdateLoginFlowRequest) (*SuccessfulNativeLogin, *http.Response, error) {
|
|
var (
|
|
localVarHTTPMethod = http.MethodPost
|
|
localVarPostBody interface{}
|
|
formFiles []formFile
|
|
localVarReturnValue *SuccessfulNativeLogin
|
|
)
|
|
|
|
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FrontendAPIService.UpdateLoginFlow")
|
|
if err != nil {
|
|
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
|
|
}
|
|
|
|
localVarPath := localBasePath + "/self-service/login"
|
|
|
|
localVarHeaderParams := make(map[string]string)
|
|
localVarQueryParams := url.Values{}
|
|
localVarFormParams := url.Values{}
|
|
if r.flow == nil {
|
|
return localVarReturnValue, nil, reportError("flow is required and must be specified")
|
|
}
|
|
if r.updateLoginFlowBody == nil {
|
|
return localVarReturnValue, nil, reportError("updateLoginFlowBody is required and must be specified")
|
|
}
|
|
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "flow", r.flow, "form", "")
|
|
// to determine the Content-Type header
|
|
localVarHTTPContentTypes := []string{"application/json", "application/x-www-form-urlencoded"}
|
|
|
|
// set Content-Type header
|
|
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
|
|
if localVarHTTPContentType != "" {
|
|
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
|
|
}
|
|
|
|
// to determine the Accept header
|
|
localVarHTTPHeaderAccepts := []string{"application/json"}
|
|
|
|
// set Accept header
|
|
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
|
|
if localVarHTTPHeaderAccept != "" {
|
|
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
|
|
}
|
|
if r.xSessionToken != nil {
|
|
parameterAddToHeaderOrQuery(localVarHeaderParams, "X-Session-Token", r.xSessionToken, "simple", "")
|
|
}
|
|
if r.cookie != nil {
|
|
parameterAddToHeaderOrQuery(localVarHeaderParams, "Cookie", r.cookie, "simple", "")
|
|
}
|
|
// body params
|
|
localVarPostBody = r.updateLoginFlowBody
|
|
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
|
|
if err != nil {
|
|
return localVarReturnValue, nil, err
|
|
}
|
|
|
|
localVarHTTPResponse, err := a.client.callAPI(req)
|
|
if err != nil || localVarHTTPResponse == nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
|
|
localVarHTTPResponse.Body.Close()
|
|
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
|
|
if err != nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
if localVarHTTPResponse.StatusCode >= 300 {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: localVarHTTPResponse.Status,
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 400 {
|
|
var v LoginFlow
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 410 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 422 {
|
|
var v ErrorBrowserLocationChangeRequired
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: err.Error(),
|
|
}
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
return localVarReturnValue, localVarHTTPResponse, nil
|
|
}
|
|
|
|
type FrontendAPIUpdateLogoutFlowRequest struct {
|
|
ctx context.Context
|
|
ApiService FrontendAPI
|
|
token *string
|
|
returnTo *string
|
|
cookie *string
|
|
}
|
|
|
|
// A Valid Logout Token If you do not have a logout token because you only have a session cookie, call `/self-service/logout/browser` to generate a URL for this endpoint.
|
|
func (r FrontendAPIUpdateLogoutFlowRequest) Token(token string) FrontendAPIUpdateLogoutFlowRequest {
|
|
r.token = &token
|
|
return r
|
|
}
|
|
|
|
// The URL to return to after the logout was completed.
|
|
func (r FrontendAPIUpdateLogoutFlowRequest) ReturnTo(returnTo string) FrontendAPIUpdateLogoutFlowRequest {
|
|
r.returnTo = &returnTo
|
|
return r
|
|
}
|
|
|
|
// 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.
|
|
func (r FrontendAPIUpdateLogoutFlowRequest) Cookie(cookie string) FrontendAPIUpdateLogoutFlowRequest {
|
|
r.cookie = &cookie
|
|
return r
|
|
}
|
|
|
|
func (r FrontendAPIUpdateLogoutFlowRequest) Execute() (*http.Response, error) {
|
|
return r.ApiService.UpdateLogoutFlowExecute(r)
|
|
}
|
|
|
|
/*
|
|
UpdateLogoutFlow Update Logout Flow
|
|
|
|
This endpoint logs out an identity in a self-service manner.
|
|
|
|
If the `Accept` HTTP header is not set to `application/json`, the browser will be redirected (HTTP 303 See Other)
|
|
to the `return_to` parameter of the initial request or fall back to `urls.default_return_to`.
|
|
|
|
If the `Accept` HTTP header is set to `application/json`, a 204 No Content response
|
|
will be sent on successful logout instead.
|
|
|
|
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.
|
|
|
|
More information can be found at [Ory Kratos User Logout Documentation](https://www.ory.sh/docs/next/kratos/self-service/flows/user-logout).
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPIUpdateLogoutFlowRequest
|
|
*/
|
|
func (a *FrontendAPIService) UpdateLogoutFlow(ctx context.Context) FrontendAPIUpdateLogoutFlowRequest {
|
|
return FrontendAPIUpdateLogoutFlowRequest{
|
|
ApiService: a,
|
|
ctx: ctx,
|
|
}
|
|
}
|
|
|
|
// Execute executes the request
|
|
func (a *FrontendAPIService) UpdateLogoutFlowExecute(r FrontendAPIUpdateLogoutFlowRequest) (*http.Response, error) {
|
|
var (
|
|
localVarHTTPMethod = http.MethodGet
|
|
localVarPostBody interface{}
|
|
formFiles []formFile
|
|
)
|
|
|
|
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FrontendAPIService.UpdateLogoutFlow")
|
|
if err != nil {
|
|
return nil, &GenericOpenAPIError{error: err.Error()}
|
|
}
|
|
|
|
localVarPath := localBasePath + "/self-service/logout"
|
|
|
|
localVarHeaderParams := make(map[string]string)
|
|
localVarQueryParams := url.Values{}
|
|
localVarFormParams := url.Values{}
|
|
|
|
if r.token != nil {
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "token", r.token, "form", "")
|
|
}
|
|
if r.returnTo != nil {
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "return_to", r.returnTo, "form", "")
|
|
}
|
|
// to determine the Content-Type header
|
|
localVarHTTPContentTypes := []string{}
|
|
|
|
// set Content-Type header
|
|
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
|
|
if localVarHTTPContentType != "" {
|
|
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
|
|
}
|
|
|
|
// to determine the Accept header
|
|
localVarHTTPHeaderAccepts := []string{"application/json"}
|
|
|
|
// set Accept header
|
|
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
|
|
if localVarHTTPHeaderAccept != "" {
|
|
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
|
|
}
|
|
if r.cookie != nil {
|
|
parameterAddToHeaderOrQuery(localVarHeaderParams, "Cookie", r.cookie, "simple", "")
|
|
}
|
|
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
localVarHTTPResponse, err := a.client.callAPI(req)
|
|
if err != nil || localVarHTTPResponse == nil {
|
|
return localVarHTTPResponse, err
|
|
}
|
|
|
|
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
|
|
localVarHTTPResponse.Body.Close()
|
|
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
|
|
if err != nil {
|
|
return localVarHTTPResponse, err
|
|
}
|
|
|
|
if localVarHTTPResponse.StatusCode >= 300 {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: localVarHTTPResponse.Status,
|
|
}
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarHTTPResponse, newErr
|
|
}
|
|
|
|
return localVarHTTPResponse, nil
|
|
}
|
|
|
|
type FrontendAPIUpdateRecoveryFlowRequest struct {
|
|
ctx context.Context
|
|
ApiService FrontendAPI
|
|
flow *string
|
|
updateRecoveryFlowBody *UpdateRecoveryFlowBody
|
|
token *string
|
|
cookie *string
|
|
}
|
|
|
|
// The Recovery Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/recovery?flow=abcde`).
|
|
func (r FrontendAPIUpdateRecoveryFlowRequest) Flow(flow string) FrontendAPIUpdateRecoveryFlowRequest {
|
|
r.flow = &flow
|
|
return r
|
|
}
|
|
|
|
func (r FrontendAPIUpdateRecoveryFlowRequest) UpdateRecoveryFlowBody(updateRecoveryFlowBody UpdateRecoveryFlowBody) FrontendAPIUpdateRecoveryFlowRequest {
|
|
r.updateRecoveryFlowBody = &updateRecoveryFlowBody
|
|
return r
|
|
}
|
|
|
|
// Recovery Token The recovery token which completes the recovery request. If the token is invalid (e.g. expired) an error will be shown to the end-user. This parameter is usually set in a link and not used by any direct API call.
|
|
func (r FrontendAPIUpdateRecoveryFlowRequest) Token(token string) FrontendAPIUpdateRecoveryFlowRequest {
|
|
r.token = &token
|
|
return r
|
|
}
|
|
|
|
// 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.
|
|
func (r FrontendAPIUpdateRecoveryFlowRequest) Cookie(cookie string) FrontendAPIUpdateRecoveryFlowRequest {
|
|
r.cookie = &cookie
|
|
return r
|
|
}
|
|
|
|
func (r FrontendAPIUpdateRecoveryFlowRequest) Execute() (*RecoveryFlow, *http.Response, error) {
|
|
return r.ApiService.UpdateRecoveryFlowExecute(r)
|
|
}
|
|
|
|
/*
|
|
UpdateRecoveryFlow Update Recovery Flow
|
|
|
|
Use this endpoint to update a recovery flow. This endpoint
|
|
behaves differently for API and browser flows and has several states:
|
|
|
|
`choose_method` expects `flow` (in the URL query) and `email` (in the body) to be sent
|
|
and works with API- and Browser-initiated flows.
|
|
For API clients and Browser clients with HTTP Header `Accept: application/json` it either returns a HTTP 200 OK when the form is valid and HTTP 400 OK when the form is invalid.
|
|
and a HTTP 303 See Other redirect with a fresh recovery flow if the flow was otherwise invalid (e.g. expired).
|
|
For Browser clients without HTTP Header `Accept` or with `Accept: text/*` it returns a HTTP 303 See Other redirect to the Recovery UI URL with the Recovery Flow ID appended.
|
|
`sent_email` is the success state after `choose_method` for the `link` method and allows the user to request another recovery email. It
|
|
works for both API and Browser-initiated flows and returns the same responses as the flow in `choose_method` state.
|
|
`passed_challenge` expects a `token` to be sent in the URL query and given the nature of the flow ("sending a recovery link")
|
|
does not have any API capabilities. The server responds with a HTTP 303 See Other redirect either to the Settings UI URL
|
|
(if the link was valid) and instructs the user to update their password, or a redirect to the Recover UI URL with
|
|
a new Recovery Flow ID which contains an error message that the recovery link was invalid.
|
|
|
|
More information can be found at [Ory Kratos Account Recovery Documentation](../self-service/flows/account-recovery).
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPIUpdateRecoveryFlowRequest
|
|
*/
|
|
func (a *FrontendAPIService) UpdateRecoveryFlow(ctx context.Context) FrontendAPIUpdateRecoveryFlowRequest {
|
|
return FrontendAPIUpdateRecoveryFlowRequest{
|
|
ApiService: a,
|
|
ctx: ctx,
|
|
}
|
|
}
|
|
|
|
// Execute executes the request
|
|
//
|
|
// @return RecoveryFlow
|
|
func (a *FrontendAPIService) UpdateRecoveryFlowExecute(r FrontendAPIUpdateRecoveryFlowRequest) (*RecoveryFlow, *http.Response, error) {
|
|
var (
|
|
localVarHTTPMethod = http.MethodPost
|
|
localVarPostBody interface{}
|
|
formFiles []formFile
|
|
localVarReturnValue *RecoveryFlow
|
|
)
|
|
|
|
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FrontendAPIService.UpdateRecoveryFlow")
|
|
if err != nil {
|
|
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
|
|
}
|
|
|
|
localVarPath := localBasePath + "/self-service/recovery"
|
|
|
|
localVarHeaderParams := make(map[string]string)
|
|
localVarQueryParams := url.Values{}
|
|
localVarFormParams := url.Values{}
|
|
if r.flow == nil {
|
|
return localVarReturnValue, nil, reportError("flow is required and must be specified")
|
|
}
|
|
if r.updateRecoveryFlowBody == nil {
|
|
return localVarReturnValue, nil, reportError("updateRecoveryFlowBody is required and must be specified")
|
|
}
|
|
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "flow", r.flow, "form", "")
|
|
if r.token != nil {
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "token", r.token, "form", "")
|
|
}
|
|
// to determine the Content-Type header
|
|
localVarHTTPContentTypes := []string{"application/json", "application/x-www-form-urlencoded"}
|
|
|
|
// set Content-Type header
|
|
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
|
|
if localVarHTTPContentType != "" {
|
|
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
|
|
}
|
|
|
|
// to determine the Accept header
|
|
localVarHTTPHeaderAccepts := []string{"application/json"}
|
|
|
|
// set Accept header
|
|
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
|
|
if localVarHTTPHeaderAccept != "" {
|
|
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
|
|
}
|
|
if r.cookie != nil {
|
|
parameterAddToHeaderOrQuery(localVarHeaderParams, "Cookie", r.cookie, "simple", "")
|
|
}
|
|
// body params
|
|
localVarPostBody = r.updateRecoveryFlowBody
|
|
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
|
|
if err != nil {
|
|
return localVarReturnValue, nil, err
|
|
}
|
|
|
|
localVarHTTPResponse, err := a.client.callAPI(req)
|
|
if err != nil || localVarHTTPResponse == nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
|
|
localVarHTTPResponse.Body.Close()
|
|
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
|
|
if err != nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
if localVarHTTPResponse.StatusCode >= 300 {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: localVarHTTPResponse.Status,
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 400 {
|
|
var v RecoveryFlow
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 410 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 422 {
|
|
var v ErrorBrowserLocationChangeRequired
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: err.Error(),
|
|
}
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
return localVarReturnValue, localVarHTTPResponse, nil
|
|
}
|
|
|
|
type FrontendAPIUpdateRegistrationFlowRequest struct {
|
|
ctx context.Context
|
|
ApiService FrontendAPI
|
|
flow *string
|
|
updateRegistrationFlowBody *UpdateRegistrationFlowBody
|
|
cookie *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`).
|
|
func (r FrontendAPIUpdateRegistrationFlowRequest) Flow(flow string) FrontendAPIUpdateRegistrationFlowRequest {
|
|
r.flow = &flow
|
|
return r
|
|
}
|
|
|
|
func (r FrontendAPIUpdateRegistrationFlowRequest) UpdateRegistrationFlowBody(updateRegistrationFlowBody UpdateRegistrationFlowBody) FrontendAPIUpdateRegistrationFlowRequest {
|
|
r.updateRegistrationFlowBody = &updateRegistrationFlowBody
|
|
return r
|
|
}
|
|
|
|
// 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.
|
|
func (r FrontendAPIUpdateRegistrationFlowRequest) Cookie(cookie string) FrontendAPIUpdateRegistrationFlowRequest {
|
|
r.cookie = &cookie
|
|
return r
|
|
}
|
|
|
|
func (r FrontendAPIUpdateRegistrationFlowRequest) Execute() (*SuccessfulNativeRegistration, *http.Response, error) {
|
|
return r.ApiService.UpdateRegistrationFlowExecute(r)
|
|
}
|
|
|
|
/*
|
|
UpdateRegistrationFlow Update Registration Flow
|
|
|
|
Use this endpoint to complete a registration flow by sending an identity's traits and password. This endpoint
|
|
behaves differently for API and browser flows.
|
|
|
|
API flows expect `application/json` to be sent in the body and respond with
|
|
HTTP 200 and a application/json body with the created identity success - if the session hook is configured the
|
|
`session` and `session_token` will also be included;
|
|
HTTP 410 if the original flow expired with the appropriate error messages set and optionally a `use_flow_id` parameter in the body;
|
|
HTTP 400 on form validation errors.
|
|
|
|
Browser flows expect a Content-Type of `application/x-www-form-urlencoded` or `application/json` to be sent in the body and respond with
|
|
a HTTP 303 redirect to the post/after registration URL or the `return_to` value if it was set and if the registration succeeded;
|
|
a HTTP 303 redirect to the registration UI URL with the flow ID containing the validation errors otherwise.
|
|
|
|
Browser flows with an accept header of `application/json` will not redirect but instead respond with
|
|
HTTP 200 and a application/json body with the signed in identity and a `Set-Cookie` header on success;
|
|
HTTP 303 redirect to a fresh login flow if the original flow expired with the appropriate error messages set;
|
|
HTTP 400 on form validation errors.
|
|
|
|
If this endpoint is called with `Accept: application/json` in the header, the response contains the flow without a redirect. In the
|
|
case of an error, the `error.id` of the JSON response body can be one of:
|
|
|
|
`session_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!
|
|
`browser_location_change_required`: Usually sent when an AJAX request indicates that the browser needs to open a specific URL.
|
|
Most likely used in Social Sign In flows.
|
|
|
|
More information can be found at [Ory Kratos User 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 ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPIUpdateRegistrationFlowRequest
|
|
*/
|
|
func (a *FrontendAPIService) UpdateRegistrationFlow(ctx context.Context) FrontendAPIUpdateRegistrationFlowRequest {
|
|
return FrontendAPIUpdateRegistrationFlowRequest{
|
|
ApiService: a,
|
|
ctx: ctx,
|
|
}
|
|
}
|
|
|
|
// Execute executes the request
|
|
//
|
|
// @return SuccessfulNativeRegistration
|
|
func (a *FrontendAPIService) UpdateRegistrationFlowExecute(r FrontendAPIUpdateRegistrationFlowRequest) (*SuccessfulNativeRegistration, *http.Response, error) {
|
|
var (
|
|
localVarHTTPMethod = http.MethodPost
|
|
localVarPostBody interface{}
|
|
formFiles []formFile
|
|
localVarReturnValue *SuccessfulNativeRegistration
|
|
)
|
|
|
|
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FrontendAPIService.UpdateRegistrationFlow")
|
|
if err != nil {
|
|
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
|
|
}
|
|
|
|
localVarPath := localBasePath + "/self-service/registration"
|
|
|
|
localVarHeaderParams := make(map[string]string)
|
|
localVarQueryParams := url.Values{}
|
|
localVarFormParams := url.Values{}
|
|
if r.flow == nil {
|
|
return localVarReturnValue, nil, reportError("flow is required and must be specified")
|
|
}
|
|
if r.updateRegistrationFlowBody == nil {
|
|
return localVarReturnValue, nil, reportError("updateRegistrationFlowBody is required and must be specified")
|
|
}
|
|
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "flow", r.flow, "form", "")
|
|
// to determine the Content-Type header
|
|
localVarHTTPContentTypes := []string{"application/json", "application/x-www-form-urlencoded"}
|
|
|
|
// set Content-Type header
|
|
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
|
|
if localVarHTTPContentType != "" {
|
|
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
|
|
}
|
|
|
|
// to determine the Accept header
|
|
localVarHTTPHeaderAccepts := []string{"application/json"}
|
|
|
|
// set Accept header
|
|
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
|
|
if localVarHTTPHeaderAccept != "" {
|
|
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
|
|
}
|
|
if r.cookie != nil {
|
|
parameterAddToHeaderOrQuery(localVarHeaderParams, "Cookie", r.cookie, "simple", "")
|
|
}
|
|
// body params
|
|
localVarPostBody = r.updateRegistrationFlowBody
|
|
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
|
|
if err != nil {
|
|
return localVarReturnValue, nil, err
|
|
}
|
|
|
|
localVarHTTPResponse, err := a.client.callAPI(req)
|
|
if err != nil || localVarHTTPResponse == nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
|
|
localVarHTTPResponse.Body.Close()
|
|
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
|
|
if err != nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
if localVarHTTPResponse.StatusCode >= 300 {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: localVarHTTPResponse.Status,
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 400 {
|
|
var v RegistrationFlow
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 410 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 422 {
|
|
var v ErrorBrowserLocationChangeRequired
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: err.Error(),
|
|
}
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
return localVarReturnValue, localVarHTTPResponse, nil
|
|
}
|
|
|
|
type FrontendAPIUpdateSettingsFlowRequest struct {
|
|
ctx context.Context
|
|
ApiService FrontendAPI
|
|
flow *string
|
|
updateSettingsFlowBody *UpdateSettingsFlowBody
|
|
xSessionToken *string
|
|
cookie *string
|
|
}
|
|
|
|
// The Settings Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/settings?flow=abcde`).
|
|
func (r FrontendAPIUpdateSettingsFlowRequest) Flow(flow string) FrontendAPIUpdateSettingsFlowRequest {
|
|
r.flow = &flow
|
|
return r
|
|
}
|
|
|
|
func (r FrontendAPIUpdateSettingsFlowRequest) UpdateSettingsFlowBody(updateSettingsFlowBody UpdateSettingsFlowBody) FrontendAPIUpdateSettingsFlowRequest {
|
|
r.updateSettingsFlowBody = &updateSettingsFlowBody
|
|
return r
|
|
}
|
|
|
|
// The Session Token of the Identity performing the settings flow.
|
|
func (r FrontendAPIUpdateSettingsFlowRequest) XSessionToken(xSessionToken string) FrontendAPIUpdateSettingsFlowRequest {
|
|
r.xSessionToken = &xSessionToken
|
|
return r
|
|
}
|
|
|
|
// 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.
|
|
func (r FrontendAPIUpdateSettingsFlowRequest) Cookie(cookie string) FrontendAPIUpdateSettingsFlowRequest {
|
|
r.cookie = &cookie
|
|
return r
|
|
}
|
|
|
|
func (r FrontendAPIUpdateSettingsFlowRequest) Execute() (*SettingsFlow, *http.Response, error) {
|
|
return r.ApiService.UpdateSettingsFlowExecute(r)
|
|
}
|
|
|
|
/*
|
|
UpdateSettingsFlow Complete Settings Flow
|
|
|
|
Use this endpoint to complete a settings flow by sending an identity's updated password. This endpoint
|
|
behaves differently for API and browser flows.
|
|
|
|
API-initiated flows expect `application/json` to be sent in the body and respond with
|
|
HTTP 200 and an application/json body with the session token on success;
|
|
HTTP 303 redirect to a fresh settings flow if the original flow expired with the appropriate error messages set;
|
|
HTTP 400 on form validation errors.
|
|
HTTP 401 when the endpoint is called without a valid session token.
|
|
HTTP 403 when `selfservice.flows.settings.privileged_session_max_age` was reached or the session's AAL is too low.
|
|
Implies that the user needs to re-authenticate.
|
|
|
|
Browser flows without HTTP Header `Accept` or with `Accept: text/*` respond with
|
|
a HTTP 303 redirect to the post/after settings URL or the `return_to` value if it was set and if the flow succeeded;
|
|
a HTTP 303 redirect to the Settings UI URL with the flow ID containing the validation errors otherwise.
|
|
a HTTP 303 redirect to the login endpoint when `selfservice.flows.settings.privileged_session_max_age` was reached or the session's AAL is too low.
|
|
|
|
Browser flows with HTTP Header `Accept: application/json` respond with
|
|
HTTP 200 and a application/json body with the signed in identity and a `Set-Cookie` header on success;
|
|
HTTP 303 redirect to a fresh login flow if the original flow expired with the appropriate error messages set;
|
|
HTTP 401 when the endpoint is called without a valid session cookie.
|
|
HTTP 403 when the page is accessed without a session cookie or the session's AAL is too low.
|
|
HTTP 400 on form validation errors.
|
|
|
|
Depending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator
|
|
Assurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn
|
|
credentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user
|
|
to sign in with the second factor (happens automatically for server-side browser flows) or change the configuration.
|
|
|
|
If this endpoint is called with a `Accept: application/json` HTTP header, the response contains the flow without a redirect. In the
|
|
case of an error, the `error.id` of the JSON response body can be one of:
|
|
|
|
`session_refresh_required`: The identity requested to change something that needs a privileged session. Redirect
|
|
the identity to the login init endpoint with query parameters `?refresh=true&return_to=<the-current-browser-url>`,
|
|
or initiate a refresh login flow otherwise.
|
|
`security_csrf_violation`: Unable to fetch the flow because a CSRF violation occurred.
|
|
`session_inactive`: No Ory Session was found - sign in a user first.
|
|
`security_identity_mismatch`: The flow was interrupted with `session_refresh_required` but apparently some other
|
|
identity logged in instead.
|
|
`security_identity_mismatch`: The requested `?return_to` address is not allowed to be used. Adjust this in the configuration!
|
|
`browser_location_change_required`: Usually sent when an AJAX request indicates that the browser needs to open a specific URL.
|
|
Most likely used in Social Sign In flows.
|
|
|
|
More information can be found at [Ory Kratos User Settings & Profile Management Documentation](../self-service/flows/user-settings).
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPIUpdateSettingsFlowRequest
|
|
*/
|
|
func (a *FrontendAPIService) UpdateSettingsFlow(ctx context.Context) FrontendAPIUpdateSettingsFlowRequest {
|
|
return FrontendAPIUpdateSettingsFlowRequest{
|
|
ApiService: a,
|
|
ctx: ctx,
|
|
}
|
|
}
|
|
|
|
// Execute executes the request
|
|
//
|
|
// @return SettingsFlow
|
|
func (a *FrontendAPIService) UpdateSettingsFlowExecute(r FrontendAPIUpdateSettingsFlowRequest) (*SettingsFlow, *http.Response, error) {
|
|
var (
|
|
localVarHTTPMethod = http.MethodPost
|
|
localVarPostBody interface{}
|
|
formFiles []formFile
|
|
localVarReturnValue *SettingsFlow
|
|
)
|
|
|
|
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FrontendAPIService.UpdateSettingsFlow")
|
|
if err != nil {
|
|
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
|
|
}
|
|
|
|
localVarPath := localBasePath + "/self-service/settings"
|
|
|
|
localVarHeaderParams := make(map[string]string)
|
|
localVarQueryParams := url.Values{}
|
|
localVarFormParams := url.Values{}
|
|
if r.flow == nil {
|
|
return localVarReturnValue, nil, reportError("flow is required and must be specified")
|
|
}
|
|
if r.updateSettingsFlowBody == nil {
|
|
return localVarReturnValue, nil, reportError("updateSettingsFlowBody is required and must be specified")
|
|
}
|
|
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "flow", r.flow, "form", "")
|
|
// to determine the Content-Type header
|
|
localVarHTTPContentTypes := []string{"application/json", "application/x-www-form-urlencoded"}
|
|
|
|
// set Content-Type header
|
|
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
|
|
if localVarHTTPContentType != "" {
|
|
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
|
|
}
|
|
|
|
// to determine the Accept header
|
|
localVarHTTPHeaderAccepts := []string{"application/json"}
|
|
|
|
// set Accept header
|
|
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
|
|
if localVarHTTPHeaderAccept != "" {
|
|
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
|
|
}
|
|
if r.xSessionToken != nil {
|
|
parameterAddToHeaderOrQuery(localVarHeaderParams, "X-Session-Token", r.xSessionToken, "simple", "")
|
|
}
|
|
if r.cookie != nil {
|
|
parameterAddToHeaderOrQuery(localVarHeaderParams, "Cookie", r.cookie, "simple", "")
|
|
}
|
|
// body params
|
|
localVarPostBody = r.updateSettingsFlowBody
|
|
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
|
|
if err != nil {
|
|
return localVarReturnValue, nil, err
|
|
}
|
|
|
|
localVarHTTPResponse, err := a.client.callAPI(req)
|
|
if err != nil || localVarHTTPResponse == nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
|
|
localVarHTTPResponse.Body.Close()
|
|
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
|
|
if err != nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
if localVarHTTPResponse.StatusCode >= 300 {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: localVarHTTPResponse.Status,
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 400 {
|
|
var v SettingsFlow
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 401 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 403 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 410 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 422 {
|
|
var v ErrorBrowserLocationChangeRequired
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: err.Error(),
|
|
}
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
return localVarReturnValue, localVarHTTPResponse, nil
|
|
}
|
|
|
|
type FrontendAPIUpdateVerificationFlowRequest struct {
|
|
ctx context.Context
|
|
ApiService FrontendAPI
|
|
flow *string
|
|
updateVerificationFlowBody *UpdateVerificationFlowBody
|
|
token *string
|
|
cookie *string
|
|
}
|
|
|
|
// The Verification Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/verification?flow=abcde`).
|
|
func (r FrontendAPIUpdateVerificationFlowRequest) Flow(flow string) FrontendAPIUpdateVerificationFlowRequest {
|
|
r.flow = &flow
|
|
return r
|
|
}
|
|
|
|
func (r FrontendAPIUpdateVerificationFlowRequest) UpdateVerificationFlowBody(updateVerificationFlowBody UpdateVerificationFlowBody) FrontendAPIUpdateVerificationFlowRequest {
|
|
r.updateVerificationFlowBody = &updateVerificationFlowBody
|
|
return r
|
|
}
|
|
|
|
// Verification Token The verification token which completes the verification request. If the token is invalid (e.g. expired) an error will be shown to the end-user. This parameter is usually set in a link and not used by any direct API call.
|
|
func (r FrontendAPIUpdateVerificationFlowRequest) Token(token string) FrontendAPIUpdateVerificationFlowRequest {
|
|
r.token = &token
|
|
return r
|
|
}
|
|
|
|
// 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.
|
|
func (r FrontendAPIUpdateVerificationFlowRequest) Cookie(cookie string) FrontendAPIUpdateVerificationFlowRequest {
|
|
r.cookie = &cookie
|
|
return r
|
|
}
|
|
|
|
func (r FrontendAPIUpdateVerificationFlowRequest) Execute() (*VerificationFlow, *http.Response, error) {
|
|
return r.ApiService.UpdateVerificationFlowExecute(r)
|
|
}
|
|
|
|
/*
|
|
UpdateVerificationFlow Complete Verification Flow
|
|
|
|
Use this endpoint to complete a verification flow. This endpoint
|
|
behaves differently for API and browser flows and has several states:
|
|
|
|
`choose_method` expects `flow` (in the URL query) and `email` (in the body) to be sent
|
|
and works with API- and Browser-initiated flows.
|
|
For API clients and Browser clients with HTTP Header `Accept: application/json` it either returns a HTTP 200 OK when the form is valid and HTTP 400 OK when the form is invalid
|
|
and a HTTP 303 See Other redirect with a fresh verification flow if the flow was otherwise invalid (e.g. expired).
|
|
For Browser clients without HTTP Header `Accept` or with `Accept: text/*` it returns a HTTP 303 See Other redirect to the Verification UI URL with the Verification Flow ID appended.
|
|
`sent_email` is the success state after `choose_method` when using the `link` method and allows the user to request another verification email. It
|
|
works for both API and Browser-initiated flows and returns the same responses as the flow in `choose_method` state.
|
|
`passed_challenge` expects a `token` to be sent in the URL query and given the nature of the flow ("sending a verification link")
|
|
does not have any API capabilities. The server responds with a HTTP 303 See Other redirect either to the Settings UI URL
|
|
(if the link was valid) and instructs the user to update their password, or a redirect to the Verification UI URL with
|
|
a new Verification Flow ID which contains an error message that the verification link was invalid.
|
|
|
|
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).
|
|
|
|
@param ctx context.Context - for authentication, logging, cancellation, deadlines, tracing, etc. Passed from http.Request or context.Background().
|
|
@return FrontendAPIUpdateVerificationFlowRequest
|
|
*/
|
|
func (a *FrontendAPIService) UpdateVerificationFlow(ctx context.Context) FrontendAPIUpdateVerificationFlowRequest {
|
|
return FrontendAPIUpdateVerificationFlowRequest{
|
|
ApiService: a,
|
|
ctx: ctx,
|
|
}
|
|
}
|
|
|
|
// Execute executes the request
|
|
//
|
|
// @return VerificationFlow
|
|
func (a *FrontendAPIService) UpdateVerificationFlowExecute(r FrontendAPIUpdateVerificationFlowRequest) (*VerificationFlow, *http.Response, error) {
|
|
var (
|
|
localVarHTTPMethod = http.MethodPost
|
|
localVarPostBody interface{}
|
|
formFiles []formFile
|
|
localVarReturnValue *VerificationFlow
|
|
)
|
|
|
|
localBasePath, err := a.client.cfg.ServerURLWithContext(r.ctx, "FrontendAPIService.UpdateVerificationFlow")
|
|
if err != nil {
|
|
return localVarReturnValue, nil, &GenericOpenAPIError{error: err.Error()}
|
|
}
|
|
|
|
localVarPath := localBasePath + "/self-service/verification"
|
|
|
|
localVarHeaderParams := make(map[string]string)
|
|
localVarQueryParams := url.Values{}
|
|
localVarFormParams := url.Values{}
|
|
if r.flow == nil {
|
|
return localVarReturnValue, nil, reportError("flow is required and must be specified")
|
|
}
|
|
if r.updateVerificationFlowBody == nil {
|
|
return localVarReturnValue, nil, reportError("updateVerificationFlowBody is required and must be specified")
|
|
}
|
|
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "flow", r.flow, "form", "")
|
|
if r.token != nil {
|
|
parameterAddToHeaderOrQuery(localVarQueryParams, "token", r.token, "form", "")
|
|
}
|
|
// to determine the Content-Type header
|
|
localVarHTTPContentTypes := []string{"application/json", "application/x-www-form-urlencoded"}
|
|
|
|
// set Content-Type header
|
|
localVarHTTPContentType := selectHeaderContentType(localVarHTTPContentTypes)
|
|
if localVarHTTPContentType != "" {
|
|
localVarHeaderParams["Content-Type"] = localVarHTTPContentType
|
|
}
|
|
|
|
// to determine the Accept header
|
|
localVarHTTPHeaderAccepts := []string{"application/json"}
|
|
|
|
// set Accept header
|
|
localVarHTTPHeaderAccept := selectHeaderAccept(localVarHTTPHeaderAccepts)
|
|
if localVarHTTPHeaderAccept != "" {
|
|
localVarHeaderParams["Accept"] = localVarHTTPHeaderAccept
|
|
}
|
|
if r.cookie != nil {
|
|
parameterAddToHeaderOrQuery(localVarHeaderParams, "Cookie", r.cookie, "simple", "")
|
|
}
|
|
// body params
|
|
localVarPostBody = r.updateVerificationFlowBody
|
|
req, err := a.client.prepareRequest(r.ctx, localVarPath, localVarHTTPMethod, localVarPostBody, localVarHeaderParams, localVarQueryParams, localVarFormParams, formFiles)
|
|
if err != nil {
|
|
return localVarReturnValue, nil, err
|
|
}
|
|
|
|
localVarHTTPResponse, err := a.client.callAPI(req)
|
|
if err != nil || localVarHTTPResponse == nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
localVarBody, err := io.ReadAll(localVarHTTPResponse.Body)
|
|
localVarHTTPResponse.Body.Close()
|
|
localVarHTTPResponse.Body = io.NopCloser(bytes.NewBuffer(localVarBody))
|
|
if err != nil {
|
|
return localVarReturnValue, localVarHTTPResponse, err
|
|
}
|
|
|
|
if localVarHTTPResponse.StatusCode >= 300 {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: localVarHTTPResponse.Status,
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 400 {
|
|
var v VerificationFlow
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
if localVarHTTPResponse.StatusCode == 410 {
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
var v ErrorGeneric
|
|
err = a.client.decode(&v, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr.error = err.Error()
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
newErr.error = formatErrorMessage(localVarHTTPResponse.Status, &v)
|
|
newErr.model = v
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
err = a.client.decode(&localVarReturnValue, localVarBody, localVarHTTPResponse.Header.Get("Content-Type"))
|
|
if err != nil {
|
|
newErr := &GenericOpenAPIError{
|
|
body: localVarBody,
|
|
error: err.Error(),
|
|
}
|
|
return localVarReturnValue, localVarHTTPResponse, newErr
|
|
}
|
|
|
|
return localVarReturnValue, localVarHTTPResponse, nil
|
|
}
|