Search code, repositories, users, issues, pull requests...

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

adminCreateSelfServiceRecoveryLink

SelfServiceRecoveryLink adminCreateSelfServiceRecoveryLink(adminCreateSelfServiceRecoveryLinkBody)

Create a Recovery Link

This endpoint creates a recovery link which should be given to the user in order for them to recover (or activate) their account.

Example

import 'package:kratos_api_dart/api.dart';

final api = KratosApiDart().getV0alpha2Api();
final AdminCreateSelfServiceRecoveryLinkBody adminCreateSelfServiceRecoveryLinkBody = ; // AdminCreateSelfServiceRecoveryLinkBody | 

try {
    final response = api.adminCreateSelfServiceRecoveryLink(adminCreateSelfServiceRecoveryLinkBody);
    print(response);
} catch on DioError (e) {
    print('Exception when calling V0alpha2Api->adminCreateSelfServiceRecoveryLink: $e\n');
}

Parameters

Name	Type	Description	Notes
adminCreateSelfServiceRecoveryLinkBody	AdminCreateSelfServiceRecoveryLinkBody		[optional]

Return type

SelfServiceRecoveryLink

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

adminDeleteIdentity

adminDeleteIdentity(id)

Delete an Identity

Calling this endpoint irrecoverably and permanently deletes the identity given its ID. This action can not be undone. This endpoint returns 204 when the identity was deleted or when the identity was not found, in which case it is assumed that is has been deleted already. Learn how identities work in Ory Kratos' User And Identity Model Documentation.

Example

import 'package:kratos_api_dart/api.dart';
// TODO Configure API key authorization: oryAccessToken
//defaultApiClient.getAuthentication<ApiKeyAuth>('oryAccessToken').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('oryAccessToken').apiKeyPrefix = 'Bearer';

final api = KratosApiDart().getV0alpha2Api();
final String id = id_example; // String | ID is the identity's ID.

try {
    api.adminDeleteIdentity(id);
} catch on DioError (e) {
    print('Exception when calling V0alpha2Api->adminDeleteIdentity: $e\n');
}

Parameters

Name	Type	Description	Notes
id	String	ID is the identity's ID.

Return type

void (empty response body)

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

adminDeleteIdentitySessions

adminDeleteIdentitySessions(id)

Calling this endpoint irrecoverably and permanently deletes and invalidates all sessions that belong to the given Identity.

This endpoint is useful for: To forcefully logout Identity from all devices and sessions

Example

import 'package:kratos_api_dart/api.dart';
// TODO Configure API key authorization: oryAccessToken
//defaultApiClient.getAuthentication<ApiKeyAuth>('oryAccessToken').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('oryAccessToken').apiKeyPrefix = 'Bearer';

final api = KratosApiDart().getV0alpha2Api();
final String id = id_example; // String | ID is the identity's ID.

try {
    api.adminDeleteIdentitySessions(id);
} catch on DioError (e) {
    print('Exception when calling V0alpha2Api->adminDeleteIdentitySessions: $e\n');
}

Parameters

Name	Type	Description	Notes
id	String	ID is the identity's ID.

Return type

void (empty response body)

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

adminGetIdentity

Identity adminGetIdentity(id, includeCredential)

Get an Identity

Learn how identities work in Ory Kratos' User And Identity Model Documentation.

Example

import 'package:kratos_api_dart/api.dart';
// TODO Configure API key authorization: oryAccessToken
//defaultApiClient.getAuthentication<ApiKeyAuth>('oryAccessToken').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('oryAccessToken').apiKeyPrefix = 'Bearer';

final api = KratosApiDart().getV0alpha2Api();
final String id = id_example; // String | ID must be set to the ID of identity you want to get
final BuiltList<String> includeCredential = ; // BuiltList<String> | DeclassifyCredentials will declassify one or more identity's credentials  Currently, only `oidc` is supported. This will return the initial OAuth 2.0 Access, Refresh and (optionally) OpenID Connect ID Token.

try {
    final response = api.adminGetIdentity(id, includeCredential);
    print(response);
} catch on DioError (e) {
    print('Exception when calling V0alpha2Api->adminGetIdentity: $e\n');
}

Parameters

Name	Type	Description	Notes
id	String	ID must be set to the ID of identity you want to get
includeCredential	BuiltList<String>	DeclassifyCredentials will declassify one or more identity's credentials Currently, only `oidc` is supported. This will return the initial OAuth 2.0 Access, Refresh and (optionally) OpenID Connect ID Token.	[optional]

Return type

Identity

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

adminListIdentities

BuiltList adminListIdentities(perPage, page)

List Identities

Lists all identities. Does not support search at the moment. Learn how identities work in Ory Kratos' User And Identity Model Documentation.

Example

import 'package:kratos_api_dart/api.dart';
// TODO Configure API key authorization: oryAccessToken
//defaultApiClient.getAuthentication<ApiKeyAuth>('oryAccessToken').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('oryAccessToken').apiKeyPrefix = 'Bearer';

final api = KratosApiDart().getV0alpha2Api();
final int perPage = 789; // int | Items per Page  This is the number of items per page.
final int page = 789; // int | Pagination Page

try {
    final response = api.adminListIdentities(perPage, page);
    print(response);
} catch on DioError (e) {
    print('Exception when calling V0alpha2Api->adminListIdentities: $e\n');
}

Parameters

Name	Type	Description	Notes
perPage	int	Items per Page This is the number of items per page.	[optional] [default to 100]
page	int	Pagination Page	[optional] [default to 0]

Return type

BuiltList<Identity>

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: Not defined
Accept: application/json

adminUpdateIdentity

Identity adminUpdateIdentity(id, adminUpdateIdentityBody)

Update an Identity

This endpoint updates an identity. It is NOT possible to set an identity's credentials (password, ...) using this method! A way to achieve that will be introduced in the future. The full identity payload (except credentials) is expected. This endpoint does not support patching. Learn how identities work in Ory Kratos' User And Identity Model Documentation.

Example

import 'package:kratos_api_dart/api.dart';
// TODO Configure API key authorization: oryAccessToken
//defaultApiClient.getAuthentication<ApiKeyAuth>('oryAccessToken').apiKey = 'YOUR_API_KEY';
// uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//defaultApiClient.getAuthentication<ApiKeyAuth>('oryAccessToken').apiKeyPrefix = 'Bearer';

final api = KratosApiDart().getV0alpha2Api();
final String id = id_example; // String | ID must be set to the ID of identity you want to update
final AdminUpdateIdentityBody adminUpdateIdentityBody = ; // AdminUpdateIdentityBody | 

try {
    final response = api.adminUpdateIdentity(id, adminUpdateIdentityBody);
    print(response);
} catch on DioError (e) {
    print('Exception when calling V0alpha2Api->adminUpdateIdentity: $e\n');
}

Parameters

Name	Type	Description	Notes
id	String	ID must be set to the ID of identity you want to update
adminUpdateIdentityBody	AdminUpdateIdentityBody		[optional]

Return type

Identity

Authorization

[Back to top] [Back to API list] [Back to Model list] [Back to README]

HTTP request headers

Content-Type: application/json
Accept: application/json

createSelfServiceLogoutFlowUrlForBrowsers

SelfServiceLogoutUrl createSelfServiceLogoutFlowUrlForBrowsers(cookie)

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.

Example

import 'package:kratos_api_dart/api.dart';

final api = KratosApiDart().getV0alpha2Api();
final String cookie = cookie_example; // String | HTTP Cookies  If you call this endpoint from a backend, please include the original Cookie header in the request.

try {
    final response = api.createSelfServiceLogoutFlowUrlForBrowsers(cookie);
    print(response);
} catch on DioError (e) {
    print('Exception when calling V0alpha2Api->createSelfServiceLogoutFlowUrlForBrowsers: $e\n');
}

Parameters

Name	Type	Description	Notes
cookie	String	HTTP Cookies If you call this endpoint from a backend, please include the original Cookie header in the request.	[optional]

Return type

SelfServiceLogoutUrl

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getJsonSchema

JsonObject getJsonSchema(id)

Get a JSON Schema

Example

import 'package:kratos_api_dart/api.dart';

final api = KratosApiDart().getV0alpha2Api();
final String id = id_example; // String | ID must be set to the ID of schema you want to get

try {
    final response = api.getJsonSchema(id);
    print(response);
} catch on DioError (e) {
    print('Exception when calling V0alpha2Api->getJsonSchema: $e\n');
}

Parameters

Name	Type	Description	Notes
id	String	ID must be set to the ID of schema you want to get

Return type

JsonObject

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSelfServiceError

SelfServiceError getSelfServiceError(id)

Get Self-Service 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.

Example

import 'package:kratos_api_dart/api.dart';

final api = KratosApiDart().getV0alpha2Api();
final String id = id_example; // String | Error is the error's ID

try {
    final response = api.getSelfServiceError(id);
    print(response);
} catch on DioError (e) {
    print('Exception when calling V0alpha2Api->getSelfServiceError: $e\n');
}

Parameters

Name	Type	Description	Notes
id	String	Error is the error's ID

Return type

SelfServiceError

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSelfServiceLoginFlow

SelfServiceLoginFlow getSelfServiceLoginFlow(id, cookie)

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.getSelfServiceLoginFlow(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 and User Registration Documentation.

Example

import 'package:kratos_api_dart/api.dart';

final api = KratosApiDart().getV0alpha2Api();
final String id = id_example; // String | The Login Flow ID  The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/login?flow=abcde`).
final String cookie = cookie_example; // String | HTTP Cookies  When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here.

try {
    final response = api.getSelfServiceLoginFlow(id, cookie);
    print(response);
} catch on DioError (e) {
    print('Exception when calling V0alpha2Api->getSelfServiceLoginFlow: $e\n');
}

Parameters

Name	Type	Description	Notes
id	String	The Login Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/login?flow=abcde`).
cookie	String	HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here.	[optional]

Return type

SelfServiceLoginFlow

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSelfServiceRecoveryFlow

SelfServiceRecoveryFlow getSelfServiceRecoveryFlow(id, cookie)

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.getSelfServiceRecoveryFlow(req.header('Cookie'), req.query['flow']) res.render('recovery', flow) }) More information can be found at Ory Kratos Account Recovery Documentation.

Example

import 'package:kratos_api_dart/api.dart';

final api = KratosApiDart().getV0alpha2Api();
final String id = id_example; // String | The Flow ID  The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/recovery?flow=abcde`).
final String cookie = cookie_example; // String | HTTP Cookies  When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here.

try {
    final response = api.getSelfServiceRecoveryFlow(id, cookie);
    print(response);
} catch on DioError (e) {
    print('Exception when calling V0alpha2Api->getSelfServiceRecoveryFlow: $e\n');
}

Parameters

Name	Type	Description	Notes
id	String	The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/recovery?flow=abcde`).
cookie	String	HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here.	[optional]

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

getSelfServiceRegistrationFlow

SelfServiceRegistrationFlow getSelfServiceRegistrationFlow(id, cookie)

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.getSelfServiceRegistrationFlow(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 and User Registration Documentation.

Example

import 'package:kratos_api_dart/api.dart';

final api = KratosApiDart().getV0alpha2Api();
final String id = id_example; // String | The Registration Flow ID  The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/registration?flow=abcde`).
final String cookie = cookie_example; // String | HTTP Cookies  When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here.

try {
    final response = api.getSelfServiceRegistrationFlow(id, cookie);
    print(response);
} catch on DioError (e) {
    print('Exception when calling V0alpha2Api->getSelfServiceRegistrationFlow: $e\n');
}

Parameters

Name	Type	Description	Notes
id	String	The Registration Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/registration?flow=abcde`).
cookie	String	HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here.	[optional]

Return type

SelfServiceRegistrationFlow

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getSelfServiceSettingsFlow

SelfServiceSettingsFlow getSelfServiceSettingsFlow(id, xSessionToken, cookie)

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.

Example

import 'package:kratos_api_dart/api.dart';

final api = KratosApiDart().getV0alpha2Api();
final String id = id_example; // String | ID is the Settings Flow ID  The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/settings?flow=abcde`).
final String xSessionToken = xSessionToken_example; // String | The Session Token  When using the SDK in an app without a browser, please include the session token here.
final String cookie = cookie_example; // String | HTTP Cookies  When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here. You only need to do this for browser- based flows.

try {
    final response = api.getSelfServiceSettingsFlow(id, xSessionToken, cookie);
    print(response);
} catch on DioError (e) {
    print('Exception when calling V0alpha2Api->getSelfServiceSettingsFlow: $e\n');
}

Parameters

Name	Type	Description	Notes
id	String	ID is the Settings Flow ID The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/settings?flow=abcde`).
xSessionToken	String	The Session Token When using the SDK in an app without a browser, please include the session token here.	[optional]
cookie	String	HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here. You only need to do this for browser- based flows.	[optional]

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

getSelfServiceVerificationFlow

SelfServiceVerificationFlow getSelfServiceVerificationFlow(id, cookie)

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.getSelfServiceVerificationFlow(req.header('cookie'), req.query['flow']) res.render('verification', flow) }) More information can be found at Ory Kratos Email and Phone Verification Documentation.

Example

import 'package:kratos_api_dart/api.dart';

final api = KratosApiDart().getV0alpha2Api();
final String id = id_example; // String | The Flow ID  The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verification?flow=abcde`).
final String cookie = cookie_example; // String | HTTP Cookies  When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here.

try {
    final response = api.getSelfServiceVerificationFlow(id, cookie);
    print(response);
} catch on DioError (e) {
    print('Exception when calling V0alpha2Api->getSelfServiceVerificationFlow: $e\n');
}

Parameters

Name	Type	Description	Notes
id	String	The Flow ID The value for this parameter comes from `request` URL Query parameter sent to your application (e.g. `/verification?flow=abcde`).
cookie	String	HTTP Cookies When using the SDK on the server side you must include the HTTP Cookie Header originally sent to your HTTP handler here.	[optional]

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

getWebAuthnJavaScript

String 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 and User Registration Documentation.

Example

import 'package:kratos_api_dart/api.dart';

final api = KratosApiDart().getV0alpha2Api();

try {
    final response = api.getWebAuthnJavaScript();
    print(response);
} catch on DioError (e) {
    print('Exception when calling V0alpha2Api->getWebAuthnJavaScript: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

String

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

initializeSelfServiceLoginFlowForBrowsers

SelfServiceLoginFlow initializeSelfServiceLoginFlowForBrowsers(refresh, aal, returnTo)

Initialize 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! 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 and User Registration Documentation.

Example

import 'package:kratos_api_dart/api.dart';

final api = KratosApiDart().getV0alpha2Api();
final bool refresh = true; // bool | 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.
final String aal = aal_example; // String | Request a Specific AuthenticationMethod Assurance Level  Use this parameter to upgrade an existing session's authenticator assurance level (AAL). This allows you to ask for multi-factor authentication. When an identity sign in using e.g. username+password, the AAL is 1. If you wish to \"upgrade\" the session's security by asking the user to perform TOTP / WebAuth/ ... you would set this to \"aal2\".
final String returnTo = returnTo_example; // String | The URL to return the browser to after the flow was completed.

try {
    final response = api.initializeSelfServiceLoginFlowForBrowsers(refresh, aal, returnTo);
    print(response);
} catch on DioError (e) {
    print('Exception when calling V0alpha2Api->initializeSelfServiceLoginFlowForBrowsers: $e\n');
}

Parameters

Name	Type	Description	Notes
refresh	bool	Refresh a login session If set to true, this will refresh an existing login session by asking the user to sign in again. This will reset the authenticated_at time of the session.	[optional]
aal	String	Request a Specific AuthenticationMethod Assurance Level Use this parameter to upgrade an existing session's authenticator assurance level (AAL). This allows you to ask for multi-factor authentication. When an identity sign in using e.g. username+password, the AAL is 1. If you wish to "upgrade" the session's security by asking the user to perform TOTP / WebAuth/ ... you would set this to "aal2".	[optional]
returnTo	String	The URL to return the browser to after the flow was completed.	[optional]

Return type

SelfServiceLoginFlow

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

initializeSelfServiceLoginFlowWithoutBrowser

SelfServiceLoginFlow initializeSelfServiceLoginFlowWithoutBrowser(refresh, aal, xSessionToken)

Initialize Login Flow for APIs, Services, Apps, ...

This endpoint initiates a login flow for API clients 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 and User Registration Documentation.

Example

import 'package:kratos_api_dart/api.dart';

final api = KratosApiDart().getV0alpha2Api();
final bool refresh = true; // bool | 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.
final String aal = aal_example; // String | Request a Specific AuthenticationMethod Assurance Level  Use this parameter to upgrade an existing session's authenticator assurance level (AAL). This allows you to ask for multi-factor authentication. When an identity sign in using e.g. username+password, the AAL is 1. If you wish to \"upgrade\" the session's security by asking the user to perform TOTP / WebAuth/ ... you would set this to \"aal2\".
final String xSessionToken = xSessionToken_example; // String | The Session Token of the Identity performing the settings flow.

try {
    final response = api.initializeSelfServiceLoginFlowWithoutBrowser(refresh, aal, xSessionToken);
    print(response);
} catch on DioError (e) {
    print('Exception when calling V0alpha2Api->initializeSelfServiceLoginFlowWithoutBrowser: $e\n');
}

Parameters

Name	Type	Description	Notes
refresh	bool	Refresh a login session If set to true, this will refresh an existing login session by asking the user to sign in again. This will reset the authenticated_at time of the session.	[optional]
aal	String	Request a Specific AuthenticationMethod Assurance Level Use this parameter to upgrade an existing session's authenticator assurance level (AAL). This allows you to ask for multi-factor authentication. When an identity sign in using e.g. username+password, the AAL is 1. If you wish to "upgrade" the session's security by asking the user to perform TOTP / WebAuth/ ... you would set this to "aal2".	[optional]
xSessionToken	String	The Session Token of the Identity performing the settings flow.	[optional]

Return type

SelfServiceLoginFlow

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

initializeSelfServiceRecoveryFlowForBrowsers

SelfServiceRecoveryFlow initializeSelfServiceRecoveryFlowForBrowsers(returnTo)

Initialize 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.

Example

import 'package:kratos_api_dart/api.dart';

final api = KratosApiDart().getV0alpha2Api();
final String returnTo = returnTo_example; // String | The URL to return the browser to after the flow was completed.

try {
    final response = api.initializeSelfServiceRecoveryFlowForBrowsers(returnTo);
    print(response);
} catch on DioError (e) {
    print('Exception when calling V0alpha2Api->initializeSelfServiceRecoveryFlowForBrowsers: $e\n');
}

Parameters

Name	Type	Description	Notes
returnTo	String	The URL to return the browser to after the flow was completed.	[optional]

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

initializeSelfServiceRecoveryFlowWithoutBrowser

SelfServiceRecoveryFlow initializeSelfServiceRecoveryFlowWithoutBrowser()

Initialize Recovery Flow for APIs, Services, 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. To fetch an existing recovery flow call /self-service/recovery/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 Kratos Account Recovery Documentation.

Example

import 'package:kratos_api_dart/api.dart';

final api = KratosApiDart().getV0alpha2Api();

try {
    final response = api.initializeSelfServiceRecoveryFlowWithoutBrowser();
    print(response);
} catch on DioError (e) {
    print('Exception when calling V0alpha2Api->initializeSelfServiceRecoveryFlowWithoutBrowser: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

initializeSelfServiceRegistrationFlowForBrowsers

SelfServiceRegistrationFlow initializeSelfServiceRegistrationFlowForBrowsers(returnTo)

Initialize 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. :::info This endpoint is EXPERIMENTAL and subject to potential breaking changes in the future. ::: 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 and User Registration Documentation.

Example

import 'package:kratos_api_dart/api.dart';

final api = KratosApiDart().getV0alpha2Api();
final String returnTo = returnTo_example; // String | The URL to return the browser to after the flow was completed.

try {
    final response = api.initializeSelfServiceRegistrationFlowForBrowsers(returnTo);
    print(response);
} catch on DioError (e) {
    print('Exception when calling V0alpha2Api->initializeSelfServiceRegistrationFlowForBrowsers: $e\n');
}

Parameters

Name	Type	Description	Notes
returnTo	String	The URL to return the browser to after the flow was completed.	[optional]

Return type

SelfServiceRegistrationFlow

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

initializeSelfServiceRegistrationFlowWithoutBrowser

SelfServiceRegistrationFlow initializeSelfServiceRegistrationFlowWithoutBrowser()

Initialize Registration Flow for APIs, Services, 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 and User Registration Documentation.

Example

import 'package:kratos_api_dart/api.dart';

final api = KratosApiDart().getV0alpha2Api();

try {
    final response = api.initializeSelfServiceRegistrationFlowWithoutBrowser();
    print(response);
} catch on DioError (e) {
    print('Exception when calling V0alpha2Api->initializeSelfServiceRegistrationFlowWithoutBrowser: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

SelfServiceRegistrationFlow

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

initializeSelfServiceSettingsFlowForBrowsers

SelfServiceSettingsFlow initializeSelfServiceSettingsFlowForBrowsers(returnTo)

Initialize 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.

Example

import 'package:kratos_api_dart/api.dart';

final api = KratosApiDart().getV0alpha2Api();
final String returnTo = returnTo_example; // String | The URL to return the browser to after the flow was completed.

try {
    final response = api.initializeSelfServiceSettingsFlowForBrowsers(returnTo);
    print(response);
} catch on DioError (e) {
    print('Exception when calling V0alpha2Api->initializeSelfServiceSettingsFlowForBrowsers: $e\n');
}

Parameters

Name	Type	Description	Notes
returnTo	String	The URL to return the browser to after the flow was completed.	[optional]

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

initializeSelfServiceSettingsFlowWithoutBrowser

SelfServiceSettingsFlow initializeSelfServiceSettingsFlowWithoutBrowser(xSessionToken)

Initialize Settings Flow for APIs, Services, 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.

Example

import 'package:kratos_api_dart/api.dart';

final api = KratosApiDart().getV0alpha2Api();
final String xSessionToken = xSessionToken_example; // String | The Session Token of the Identity performing the settings flow.

try {
    final response = api.initializeSelfServiceSettingsFlowWithoutBrowser(xSessionToken);
    print(response);
} catch on DioError (e) {
    print('Exception when calling V0alpha2Api->initializeSelfServiceSettingsFlowWithoutBrowser: $e\n');
}

Parameters

Name	Type	Description	Notes
xSessionToken	String	The Session Token of the Identity performing the settings flow.	[optional]

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

initializeSelfServiceVerificationFlowForBrowsers

SelfServiceVerificationFlow initializeSelfServiceVerificationFlowForBrowsers(returnTo)

Initialize 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.

Example

import 'package:kratos_api_dart/api.dart';

final api = KratosApiDart().getV0alpha2Api();
final String returnTo = returnTo_example; // String | The URL to return the browser to after the flow was completed.

try {
    final response = api.initializeSelfServiceVerificationFlowForBrowsers(returnTo);
    print(response);
} catch on DioError (e) {
    print('Exception when calling V0alpha2Api->initializeSelfServiceVerificationFlowForBrowsers: $e\n');
}

Parameters

Name	Type	Description	Notes
returnTo	String	The URL to return the browser to after the flow was completed.	[optional]

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

initializeSelfServiceVerificationFlowWithoutBrowser

SelfServiceVerificationFlow initializeSelfServiceVerificationFlowWithoutBrowser()

Initialize Verification Flow for APIs, Services, 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 Kratos Email and Phone Verification Documentation.

Example

import 'package:kratos_api_dart/api.dart';

final api = KratosApiDart().getV0alpha2Api();

try {
    final response = api.initializeSelfServiceVerificationFlowWithoutBrowser();
    print(response);
} catch on DioError (e) {
    print('Exception when calling V0alpha2Api->initializeSelfServiceVerificationFlowWithoutBrowser: $e\n');
}

Parameters

This endpoint does not need any parameter.

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

listIdentitySchemas

BuiltList listIdentitySchemas(perPage, page)

Get all Identity Schemas

Example

import 'package:kratos_api_dart/api.dart';

final api = KratosApiDart().getV0alpha2Api();
final int perPage = 789; // int | Items per Page  This is the number of items per page.
final int page = 789; // int | Pagination Page

try {
    final response = api.listIdentitySchemas(perPage, page);
    print(response);
} catch on DioError (e) {
    print('Exception when calling V0alpha2Api->listIdentitySchemas: $e\n');
}

Parameters

Name	Type	Description	Notes
perPage	int	Items per Page This is the number of items per page.	[optional] [default to 100]
page	int	Pagination Page	[optional] [default to 0]

Return type

BuiltList<IdentitySchema>

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

submitSelfServiceLoginFlow

SuccessfulSelfServiceLoginWithoutBrowser submitSelfServiceLoginFlow(flow, xSessionToken, submitSelfServiceLoginFlowBody)

Submit a Login Flow

:::info This endpoint is EXPERIMENTAL and subject to potential breaking changes in the future. ::: 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 302 redirect to a fresh login flow if the original flow expired with the appropriate error messages set; 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 302 redirect to the post/after login URL or the return_to value if it was set and if the login succeeded; a HTTP 302 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 302 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 and User Registration Documentation.

Example

import 'package:kratos_api_dart/api.dart';

final api = KratosApiDart().getV0alpha2Api();
final String flow = flow_example; // String | The Login Flow ID  The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/login?flow=abcde`).
final String xSessionToken = xSessionToken_example; // String | The Session Token of the Identity performing the settings flow.
final SubmitSelfServiceLoginFlowBody submitSelfServiceLoginFlowBody = ; // SubmitSelfServiceLoginFlowBody | 

try {
    final response = api.submitSelfServiceLoginFlow(flow, xSessionToken, submitSelfServiceLoginFlowBody);
    print(response);
} catch on DioError (e) {
    print('Exception when calling V0alpha2Api->submitSelfServiceLoginFlow: $e\n');
}

Parameters

Name	Type	Description	Notes
flow	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`).
xSessionToken	String	The Session Token of the Identity performing the settings flow.	[optional]
submitSelfServiceLoginFlowBody	SubmitSelfServiceLoginFlowBody		[optional]

Return type

SuccessfulSelfServiceLoginWithoutBrowser

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

submitSelfServiceLogoutFlow

submitSelfServiceLogoutFlow(token, returnTo)

Complete Self-Service Logout

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 302 Found) 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.

Example

import 'package:kratos_api_dart/api.dart';

final api = KratosApiDart().getV0alpha2Api();
final String token = token_example; // String | A Valid Logout Token  If you do not have a logout token because you only have a session cookie, call `/self-service/logout/urls` to generate a URL for this endpoint.
final String returnTo = returnTo_example; // String | The URL to return to after the logout was completed.

try {
    api.submitSelfServiceLogoutFlow(token, returnTo);
} catch on DioError (e) {
    print('Exception when calling V0alpha2Api->submitSelfServiceLogoutFlow: $e\n');
}

Parameters

Name	Type	Description	Notes
token	String	A Valid Logout Token If you do not have a logout token because you only have a session cookie, call `/self-service/logout/urls` to generate a URL for this endpoint.	[optional]
returnTo	String	The URL to return to after the logout was completed.	[optional]

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: Not defined
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

submitSelfServiceLogoutFlowWithoutBrowser

submitSelfServiceLogoutFlowWithoutBrowser(submitSelfServiceLogoutFlowWithoutBrowserBody)

Perform Logout for APIs, Services, 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.

Example

import 'package:kratos_api_dart/api.dart';

final api = KratosApiDart().getV0alpha2Api();
final SubmitSelfServiceLogoutFlowWithoutBrowserBody submitSelfServiceLogoutFlowWithoutBrowserBody = ; // SubmitSelfServiceLogoutFlowWithoutBrowserBody | 

try {
    api.submitSelfServiceLogoutFlowWithoutBrowser(submitSelfServiceLogoutFlowWithoutBrowserBody);
} catch on DioError (e) {
    print('Exception when calling V0alpha2Api->submitSelfServiceLogoutFlowWithoutBrowser: $e\n');
}

Parameters

Name	Type	Description	Notes
submitSelfServiceLogoutFlowWithoutBrowserBody	SubmitSelfServiceLogoutFlowWithoutBrowserBody

Return type

void (empty response body)

Authorization

No authorization required

HTTP request headers

Content-Type: application/json
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

submitSelfServiceRecoveryFlow

SelfServiceRecoveryFlow submitSelfServiceRecoveryFlow(flow, token, submitSelfServiceRecoveryFlowBody)

Complete Recovery Flow

Use this endpoint to complete 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 302 Found 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 302 Found 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 302 Found 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.

Example

import 'package:kratos_api_dart/api.dart';

final api = KratosApiDart().getV0alpha2Api();
final String flow = flow_example; // 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`).
final String token = token_example; // String | 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.
final SubmitSelfServiceRecoveryFlowBody submitSelfServiceRecoveryFlowBody = ; // SubmitSelfServiceRecoveryFlowBody | 

try {
    final response = api.submitSelfServiceRecoveryFlow(flow, token, submitSelfServiceRecoveryFlowBody);
    print(response);
} catch on DioError (e) {
    print('Exception when calling V0alpha2Api->submitSelfServiceRecoveryFlow: $e\n');
}

Parameters

Name	Type	Description	Notes
flow	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`).
token	String	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.	[optional]
submitSelfServiceRecoveryFlowBody	SubmitSelfServiceRecoveryFlowBody		[optional]

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded
Accept: application/json

submitSelfServiceRegistrationFlow

SuccessfulSelfServiceRegistrationWithoutBrowser submitSelfServiceRegistrationFlow(flow, submitSelfServiceRegistrationFlowBody)

Submit a 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 302 redirect to a fresh registration flow if the original flow expired with the appropriate error messages set; 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 302 redirect to the post/after registration URL or the return_to value if it was set and if the registration succeeded; a HTTP 302 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 302 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 and User Registration Documentation.

Example

import 'package:kratos_api_dart/api.dart';

final api = KratosApiDart().getV0alpha2Api();
final String flow = flow_example; // String | The Registration Flow ID  The value for this parameter comes from `flow` URL Query parameter sent to your application (e.g. `/registration?flow=abcde`).
final SubmitSelfServiceRegistrationFlowBody submitSelfServiceRegistrationFlowBody = ; // SubmitSelfServiceRegistrationFlowBody | 

try {
    final response = api.submitSelfServiceRegistrationFlow(flow, submitSelfServiceRegistrationFlowBody);
    print(response);
} catch on DioError (e) {
    print('Exception when calling V0alpha2Api->submitSelfServiceRegistrationFlow: $e\n');
}

Parameters

Name	Type	Description	Notes
flow	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`).
submitSelfServiceRegistrationFlowBody	SubmitSelfServiceRegistrationFlowBody		[optional]

Return type

SuccessfulSelfServiceRegistrationWithoutBrowser

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded
Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

submitSelfServiceSettingsFlow

SelfServiceSettingsFlow submitSelfServiceSettingsFlow(flow, xSessionToken, submitSelfServiceSettingsFlowBody)

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 302 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 302 redirect to the post/after settings URL or the return_to value if it was set and if the flow succeeded; a HTTP 302 redirect to the Settings UI URL with the flow ID containing the validation errors otherwise. a HTTP 302 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 302 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.

Example

import 'package:kratos_api_dart/api.dart';

final api = KratosApiDart().getV0alpha2Api();
final String flow = flow_example; // 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`).
final String xSessionToken = xSessionToken_example; // String | The Session Token of the Identity performing the settings flow.
final SubmitSelfServiceSettingsFlowBody submitSelfServiceSettingsFlowBody = ; // SubmitSelfServiceSettingsFlowBody | 

try {
    final response = api.submitSelfServiceSettingsFlow(flow, xSessionToken, submitSelfServiceSettingsFlowBody);
    print(response);
} catch on DioError (e) {
    print('Exception when calling V0alpha2Api->submitSelfServiceSettingsFlow: $e\n');
}

Parameters

Name	Type	Description	Notes
flow	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`).
xSessionToken	String	The Session Token of the Identity performing the settings flow.	[optional]
submitSelfServiceSettingsFlowBody	SubmitSelfServiceSettingsFlowBody		[optional]

Return type

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Authorization

No authorization required

HTTP request headers

Content-Type: application/json, application/x-www-form-urlencoded
Accept: application/json

submitSelfServiceVerificationFlow

SelfServiceVerificationFlow submitSelfServiceVerificationFlow(flow, token, submitSelfServiceVerificationFlowBody)

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 302 Found 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 302 Found 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 302 Found 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.

Example

import 'package:kratos_api_dart/api.dart';

final api = KratosApiDart().getV0alpha2Api();
final String flow = flow_example; // 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`).
final String token = token_example; // String | 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.
final SubmitSelfServiceVerificationFlowBody submitSelfServiceVerificationFlowBody = ; // SubmitSelfServiceVerificationFlowBody | 

try {
    final response = api.submitSelfServiceVerificationFlow(flow, token, submitSelfServiceVerificationFlowBody);
    print(response);
} catch on DioError (e) {
    print('Exception when calling V0alpha2Api->submitSelfServiceVerificationFlow: $e\n');
}

Parameters

Name	Type	Description	Notes
flow	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`).
token	String	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.	[optional]
submitSelfServiceVerificationFlowBody	SubmitSelfServiceVerificationFlowBody		[optional]

Return type