{
"opencollection": "1.0.0",
"info": {
"name": "Ory Hydra api frontend API",
"version": "1.0"
},
"items": [
{
"info": {
"name": "frontend",
"type": "folder"
},
"items": [
{
"info": {
"name": "Get WebAuthn JavaScript",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/.well-known/ory/webauthn.js"
},
"docs": "This endpoint provides JavaScript which is needed in order to perform WebAuthn login and registration.\n\nIf you are building a JavaScript Browser App (e.g. in ReactJS or AngularJS) you will need to load this file:\n\n```html\n\n```\n\nMore information can be found at [Ory Kratos User Login](https://www.ory.com/docs/kratos/self-service/flows/user-login) and [User Registration Documentation](https://www.ory."
},
{
"info": {
"name": "Get User-Flow Errors",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/self-service/errors",
"params": [
{
"name": "id",
"value": "",
"type": "query",
"description": "Error is the error's ID"
}
]
},
"docs": "This endpoint returns the error associated with a user-facing self service errors.\n\nThis endpoint supports stub values to help you implement the error UI:\n\n`?id=stub:500` - returns a stub 500 (Internal Server Error) error.\n\nMore information can be found at [Ory Kratos User User Facing Error Documentation](https://www.ory.com/docs/kratos/self-service/flows/user-facing-errors)."
},
{
"info": {
"name": "Get FedCM Parameters",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/self-service/fed-cm/parameters"
},
"docs": "This endpoint returns a list of all available FedCM providers. It is only supported on the Ory Network."
},
{
"info": {
"name": "Submit a FedCM token",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/self-service/fed-cm/token",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use this endpoint to submit a token from a FedCM provider through\n`navigator.credentials.get` and log the user in. The parameters from\n`navigator.credentials.get` must have come from `GET\nself-service/fed-cm/parameters`."
},
{
"info": {
"name": "Submit a Login Flow",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/self-service/login",
"headers": [
{
"name": "X-Session-Token",
"value": ""
},
{
"name": "Cookie",
"value": ""
}
],
"params": [
{
"name": "flow",
"value": "",
"type": "query",
"description": "The Login Flow ID\n\nThe value for this parameter comes from `flow` URL Query parameter sent to your\napplication (e.g. `/login?flow=abcde`)."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use this endpoint to complete a login flow. This endpoint\nbehaves differently for API and browser flows.\n\nAPI flows expect `application/json` to be sent in the body and responds with\nHTTP 200 and a application/json body with the session token on success;\nHTTP 410 if the original flow expired with the appropriate error messages set and optionally a `use_flow_id` parameter in the body;\nHTTP 400 on form validation errors.\n\nBrowser flows expect a Content-Type of `application/x-www-form-urlencoded` o"
},
{
"info": {
"name": "Create Login Flow for Native Apps",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/self-service/login/api",
"headers": [
{
"name": "X-Session-Token",
"value": ""
}
],
"params": [
{
"name": "refresh",
"value": "",
"type": "query",
"description": "Refresh a login session\n\nIf set to true, this will refresh an existing login session by\nasking the user to sign in again. This will reset the\nauthenticated_at time of the session."
},
{
"name": "aal",
"value": "",
"type": "query",
"description": "Request a Specific AuthenticationMethod Assurance Level\n\nUse this parameter to upgrade an existing session's authenticator assurance level (AAL). This\nallows you to ask for multi-factor authentication. When an identity sign in using e.g. username+password,\nthe AAL is 1. If you wish to \"upgrade\" the session's security by asking the user to perform TOTP / WebAuth/ ...\nyou would set this to \"aal2\"."
},
{
"name": "return_session_token_exchange_code",
"value": "",
"type": "query",
"description": "EnableSessionTokenExchangeCode requests the login flow to include a code that can be used to retrieve the session token\nafter the login flow has been completed."
},
{
"name": "return_to",
"value": "",
"type": "query",
"description": "The URL to return the browser to after the flow was completed."
},
{
"name": "organization",
"value": "",
"type": "query",
"description": "An optional organization ID that should be used for logging this user in.\nThis parameter is only effective in the Ory Network."
},
{
"name": "via",
"value": "",
"type": "query",
"description": "Via should contain the identity's credential the code should be sent to. Only relevant in aal2 flows.\n\nDEPRECATED: This field is deprecated. Please remove it from your requests. The user will now see a choice\nof MFA credentials to choose from to perform the second factor instead."
},
{
"name": "identity_schema",
"value": "",
"type": "query",
"description": "An optional identity schema to use for the login flow."
}
]
},
"docs": "This endpoint initiates a login flow for native apps that do not use a browser, such as mobile devices, smart TVs, and so on.\n\nIf a valid provided session cookie or session token is provided, a 400 Bad Request error\nwill be returned unless the URL query parameter `?refresh=true` is set.\n\nTo fetch an existing login flow call `/self-service/login/flows?flow=`.\n\nYou MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server\nPages, NodeJS, "
},
{
"info": {
"name": "Create Login Flow for Browsers",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/self-service/login/browser",
"headers": [
{
"name": "Cookie",
"value": ""
}
],
"params": [
{
"name": "refresh",
"value": "",
"type": "query",
"description": "Refresh a login session\n\nIf set to true, this will refresh an existing login session by\nasking the user to sign in again. This will reset the\nauthenticated_at time of the session."
},
{
"name": "aal",
"value": "",
"type": "query",
"description": "Request a Specific AuthenticationMethod Assurance Level\n\nUse this parameter to upgrade an existing session's authenticator assurance level (AAL). This\nallows you to ask for multi-factor authentication. When an identity sign in using e.g. username+password,\nthe AAL is 1. If you wish to \"upgrade\" the session's security by asking the user to perform TOTP / WebAuth/ ...\nyou would set this to \"aal2\"."
},
{
"name": "return_to",
"value": "",
"type": "query",
"description": "The URL to return the browser to after the flow was completed."
},
{
"name": "login_challenge",
"value": "",
"type": "query",
"description": "An optional Hydra login challenge. If present, Kratos will cooperate with\nOry Hydra to act as an OAuth2 identity provider.\n\nThe value for this parameter comes from `login_challenge` URL Query parameter sent to your\napplication (e.g. `/login?login_challenge=abcde`)."
},
{
"name": "organization",
"value": "",
"type": "query",
"description": "An optional organization ID that should be used for logging this user in.\nThis parameter is only effective in the Ory Network."
},
{
"name": "via",
"value": "",
"type": "query",
"description": "Via should contain the identity's credential the code should be sent to. Only relevant in aal2 flows.\n\nDEPRECATED: This field is deprecated. Please remove it from your requests. The user will now see a choice\nof MFA credentials to choose from to perform the second factor instead."
},
{
"name": "identity_schema",
"value": "",
"type": "query",
"description": "An optional identity schema to use for the login flow."
}
]
},
"docs": "This endpoint initializes a browser-based user login flow. This endpoint will set the appropriate\ncookies and anti-CSRF measures required for browser-based flows.\n\nIf this endpoint is opened as a link in the browser, it will be redirected to\n`selfservice.flows.login.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session\nexists already, the browser will be redirected to `urls.default_redirect_url` unless the query parameter\n`?refresh=true` was set.\n\nIf this endpoint"
},
{
"info": {
"name": "Get Login Flow",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/self-service/login/flows",
"headers": [
{
"name": "Cookie",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "query",
"description": "The Login Flow ID\n\nThe value for this parameter comes from `flow` URL Query parameter sent to your\napplication (e.g. `/login?flow=abcde`)."
}
]
},
"docs": "This endpoint returns a login flow's context with, for example, error details and other information.\n\nBrowser flows expect the anti-CSRF cookie to be included in the request's HTTP Cookie Header.\nFor AJAX requests you must ensure that cookies are included in the request or requests will fail.\n\nIf you use the browser-flow for server-side apps, the services need to run on a common top-level-domain\nand you need to forward the incoming HTTP Cookie header to this endpoint:\n\n```js\npseudo-code example\n"
},
{
"info": {
"name": "Update Logout Flow",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/self-service/logout",
"headers": [
{
"name": "Cookie",
"value": ""
}
],
"params": [
{
"name": "token",
"value": "",
"type": "query",
"description": "A Valid Logout Token\n\nIf you do not have a logout token because you only have a session cookie,\ncall `/self-service/logout/browser` to generate a URL for this endpoint."
},
{
"name": "return_to",
"value": "",
"type": "query",
"description": "The URL to return to after the logout was completed."
}
]
},
"docs": "This endpoint logs out an identity in a self-service manner.\n\nIf the `Accept` HTTP header is not set to `application/json`, the browser will be redirected (HTTP 303 See Other)\nto the `return_to` parameter of the initial request or fall back to `urls.default_return_to`.\n\nIf the `Accept` HTTP header is set to `application/json`, a 204 No Content response\nwill be sent on successful logout instead.\n\nThis endpoint is NOT INTENDED for API clients and only works\nwith browsers (Chrome, Firefox, ...). Fo"
},
{
"info": {
"name": "Perform Logout for Native Apps",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/self-service/logout/api",
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use this endpoint to log out an identity using an Ory Session Token. If the Ory Session Token was successfully\nrevoked, the server returns a 204 No Content response. A 204 No Content response is also sent when\nthe Ory Session Token has been revoked already before.\n\nIf the Ory Session Token is malformed or does not exist a 403 Forbidden response will be returned.\n\nThis endpoint does not remove any HTTP\nCookies - use the Browser-Based Self-Service Logout Flow instead."
},
{
"info": {
"name": "Create a Logout URL for Browsers",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/self-service/logout/browser",
"headers": [
{
"name": "cookie",
"value": ""
}
],
"params": [
{
"name": "return_to",
"value": "",
"type": "query",
"description": "Return to URL\n\nThe URL to which the browser should be redirected to after the logout\nhas been performed."
}
]
},
"docs": "This endpoint initializes a browser-based user logout flow and a URL which can be used to log out the user.\n\nThis endpoint is NOT INTENDED for API clients and only works\nwith browsers (Chrome, Firefox, ...). For API clients you can\ncall the `/self-service/logout/api` URL directly with the Ory Session Token.\n\nThe URL is only valid for the currently signed in user. If no user is signed in, this endpoint returns\na 401 error.\n\nWhen calling this endpoint from a backend, please ensure to properly forw"
},
{
"info": {
"name": "Update Recovery Flow",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/self-service/recovery",
"headers": [
{
"name": "Cookie",
"value": ""
}
],
"params": [
{
"name": "flow",
"value": "",
"type": "query",
"description": "The Recovery Flow ID\n\nThe value for this parameter comes from `flow` URL Query parameter sent to your\napplication (e.g. `/recovery?flow=abcde`)."
},
{
"name": "token",
"value": "",
"type": "query",
"description": "Recovery Token\n\nThe recovery token which completes the recovery request. If the token\nis invalid (e.g. expired) an error will be shown to the end-user.\n\nThis parameter is usually set in a link and not used by any direct API call."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use this endpoint to update a recovery flow. This endpoint\nbehaves differently for API and browser flows and has several states:\n\n`choose_method` expects `flow` (in the URL query) and `email` (in the body) to be sent\nand works with API- and Browser-initiated flows.\nFor 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.\nand a HTTP 303 See Other redirect with a fresh recovery f"
},
{
"info": {
"name": "Create Recovery Flow for Native Apps",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/self-service/recovery/api"
},
"docs": "This endpoint initiates a recovery flow for API clients such as mobile devices, smart TVs, and so on.\n\nIf a valid provided session cookie or session token is provided, a 400 Bad Request error.\n\nOn an existing recovery flow, use the `getRecoveryFlow` API endpoint.\n\nYou MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server\nPages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make\nyou vulnerable"
},
{
"info": {
"name": "Create Recovery Flow for Browsers",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/self-service/recovery/browser",
"params": [
{
"name": "return_to",
"value": "",
"type": "query",
"description": "The URL to return the browser to after the flow was completed."
},
{
"name": "skip_settings",
"value": "",
"type": "query",
"description": "Skip redirection to the settings UI after the recovery flow was\ncompleted. Instead, the user will be redirected to the URL specified in\n`return_to` query parameter or the default return URL if `return_to` is\nnot set."
}
]
},
"docs": "This endpoint initializes a browser-based account recovery flow. Once initialized, the browser will be redirected to\n`selfservice.flows.recovery.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session\nexists, the browser is returned to the configured return URL.\n\nIf this endpoint is called via an AJAX request, the response contains the recovery flow without any redirects\nor a 400 bad request error if the user is already authenticated.\n\nThis endpoint is NOT INTENDED "
},
{
"info": {
"name": "Get Recovery Flow",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/self-service/recovery/flows",
"headers": [
{
"name": "Cookie",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "query",
"description": "The Flow ID\n\nThe value for this parameter comes from `request` URL Query parameter sent to your\napplication (e.g. `/recovery?flow=abcde`)."
}
]
},
"docs": "This endpoint returns a recovery flow's context with, for example, error details and other information.\n\nBrowser flows expect the anti-CSRF cookie to be included in the request's HTTP Cookie Header.\nFor AJAX requests you must ensure that cookies are included in the request or requests will fail.\n\nIf you use the browser-flow for server-side apps, the services need to run on a common top-level-domain\nand you need to forward the incoming HTTP Cookie header to this endpoint:\n\n```js\npseudo-code examp"
},
{
"info": {
"name": "Update Registration Flow",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/self-service/registration",
"headers": [
{
"name": "Cookie",
"value": ""
}
],
"params": [
{
"name": "flow",
"value": "",
"type": "query",
"description": "The Registration Flow ID\n\nThe value for this parameter comes from `flow` URL Query parameter sent to your\napplication (e.g. `/registration?flow=abcde`)."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use this endpoint to complete a registration flow by sending an identity's traits and password. This endpoint\nbehaves differently for API and browser flows.\n\nAPI flows expect `application/json` to be sent in the body and respond with\nHTTP 200 and a application/json body with the created identity success - if the session hook is configured the\n`session` and `session_token` will also be included;\nHTTP 410 if the original flow expired with the appropriate error messages set and optionally a `use_fl"
},
{
"info": {
"name": "Create Registration Flow for Native Apps",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/self-service/registration/api",
"params": [
{
"name": "return_session_token_exchange_code",
"value": "",
"type": "query",
"description": "EnableSessionTokenExchangeCode requests the login flow to include a code that can be used to retrieve the session token\nafter the login flow has been completed."
},
{
"name": "return_to",
"value": "",
"type": "query",
"description": "The URL to return the browser to after the flow was completed."
},
{
"name": "organization",
"value": "",
"type": "query",
"description": "An optional organization ID that should be used to register this user.\nThis parameter is only effective in the Ory Network."
},
{
"name": "identity_schema",
"value": "",
"type": "query",
"description": "An optional identity schema to use for the registration flow."
}
]
},
"docs": "This endpoint initiates a registration flow for API clients such as mobile devices, smart TVs, and so on.\n\nIf a valid provided session cookie or session token is provided, a 400 Bad Request error\nwill be returned unless the URL query parameter `?refresh=true` is set.\n\nTo fetch an existing registration flow call `/self-service/registration/flows?flow=`.\n\nYou MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server\nPages, NodeJS, PHP, G"
},
{
"info": {
"name": "Create Registration Flow for Browsers",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/self-service/registration/browser",
"params": [
{
"name": "return_to",
"value": "",
"type": "query",
"description": "The URL to return the browser to after the flow was completed."
},
{
"name": "login_challenge",
"value": "",
"type": "query",
"description": "Ory OAuth 2.0 Login Challenge.\n\nIf set will cooperate with Ory OAuth2 and OpenID to act as an OAuth2 server / OpenID Provider.\n\nThe value for this parameter comes from `login_challenge` URL Query parameter sent to your\napplication (e.g. `/registration?login_challenge=abcde`).\n\nThis feature is compatible with Ory Hydra when not running on the Ory Network."
},
{
"name": "after_verification_return_to",
"value": "",
"type": "query",
"description": "The URL to return the browser to after the verification flow was completed.\n\nAfter the registration flow is completed, the user will be sent a verification email.\nUpon completing the verification flow, this URL will be used to override the default\n`selfservice.flows.verification.after.default_redirect_to` value."
},
{
"name": "organization",
"value": "",
"type": "query",
"description": "An optional organization ID that should be used to register this user.\nThis parameter is only effective in the Ory Network."
},
{
"name": "identity_schema",
"value": "",
"type": "query",
"description": "An optional identity schema to use for the registration flow."
}
]
},
"docs": "This endpoint initializes a browser-based user registration flow. This endpoint will set the appropriate\ncookies and anti-CSRF measures required for browser-based flows.\n\nIf this endpoint is opened as a link in the browser, it will be redirected to\n`selfservice.flows.registration.ui_url` with the flow ID set as the query parameter `?flow=`. If a valid user session\nexists already, the browser will be redirected to `urls.default_redirect_url`.\n\nIf this endpoint is called via an AJAX request, the r"
},
{
"info": {
"name": "Get Registration Flow",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/self-service/registration/flows",
"headers": [
{
"name": "Cookie",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "query",
"description": "The Registration Flow ID\n\nThe value for this parameter comes from `flow` URL Query parameter sent to your\napplication (e.g. `/registration?flow=abcde`)."
}
]
},
"docs": "This endpoint returns a registration flow's context with, for example, error details and other information.\n\nBrowser flows expect the anti-CSRF cookie to be included in the request's HTTP Cookie Header.\nFor AJAX requests you must ensure that cookies are included in the request or requests will fail.\n\nIf you use the browser-flow for server-side apps, the services need to run on a common top-level-domain\nand you need to forward the incoming HTTP Cookie header to this endpoint:\n\n```js\npseudo-code e"
},
{
"info": {
"name": "Complete Settings Flow",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/self-service/settings",
"headers": [
{
"name": "X-Session-Token",
"value": ""
},
{
"name": "Cookie",
"value": ""
}
],
"params": [
{
"name": "flow",
"value": "",
"type": "query",
"description": "The Settings Flow ID\n\nThe value for this parameter comes from `flow` URL Query parameter sent to your\napplication (e.g. `/settings?flow=abcde`)."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use this endpoint to complete a settings flow by sending an identity's updated password. This endpoint\nbehaves differently for API and browser flows.\n\nAPI-initiated flows expect `application/json` to be sent in the body and respond with\nHTTP 200 and an application/json body with the session token on success;\nHTTP 303 redirect to a fresh settings flow if the original flow expired with the appropriate error messages set;\nHTTP 400 on form validation errors.\nHTTP 401 when the endpoint is called with"
},
{
"info": {
"name": "Create Settings Flow for Native Apps",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/self-service/settings/api",
"headers": [
{
"name": "X-Session-Token",
"value": ""
}
]
},
"docs": "This endpoint initiates a settings flow for API clients such as mobile devices, smart TVs, and so on.\nYou must provide a valid Ory Kratos Session Token for this endpoint to respond with HTTP 200 OK.\n\nTo fetch an existing settings flow call `/self-service/settings/flows?flow=`.\n\nYou MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server\nPages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications w"
},
{
"info": {
"name": "Create Settings Flow for Browsers",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/self-service/settings/browser",
"headers": [
{
"name": "Cookie",
"value": ""
}
],
"params": [
{
"name": "return_to",
"value": "",
"type": "query",
"description": "The URL to return the browser to after the flow was completed."
}
]
},
"docs": "This endpoint initializes a browser-based user settings flow. Once initialized, the browser will be redirected to\n`selfservice.flows.settings.ui_url` with the flow ID set as the query parameter `?flow=`. If no valid\nOry Kratos Session Cookie is included in the request, a login flow will be initialized.\n\nIf this endpoint is opened as a link in the browser, it will be redirected to\n`selfservice.flows.settings.ui_url` with the flow ID set as the query parameter `?flow=`. If no valid user session\nwa"
},
{
"info": {
"name": "Get Settings Flow",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/self-service/settings/flows",
"headers": [
{
"name": "X-Session-Token",
"value": ""
},
{
"name": "Cookie",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "query",
"description": "ID is the Settings Flow ID\n\nThe value for this parameter comes from `flow` URL Query parameter sent to your\napplication (e.g. `/settings?flow=abcde`)."
}
]
},
"docs": "When accessing this endpoint through Ory Kratos' Public API you must ensure that either the Ory Kratos Session Cookie\nor the Ory Kratos Session Token are set.\n\nDepending on your configuration this endpoint might return a 403 error if the session has a lower Authenticator\nAssurance Level (AAL) than is possible for the identity. This can happen if the identity has password + webauthn\ncredentials (which would result in AAL2) but the session has only AAL1. If this error occurs, ask the user\nto sign "
},
{
"info": {
"name": "Complete Verification Flow",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/self-service/verification",
"headers": [
{
"name": "Cookie",
"value": ""
}
],
"params": [
{
"name": "flow",
"value": "",
"type": "query",
"description": "The Verification Flow ID\n\nThe value for this parameter comes from `flow` URL Query parameter sent to your\napplication (e.g. `/verification?flow=abcde`)."
},
{
"name": "token",
"value": "",
"type": "query",
"description": "Verification Token\n\nThe verification token which completes the verification request. If the token\nis invalid (e.g. expired) an error will be shown to the end-user.\n\nThis parameter is usually set in a link and not used by any direct API call."
}
],
"body": {
"type": "json",
"data": "{}"
}
},
"docs": "Use this endpoint to complete a verification flow. This endpoint\nbehaves differently for API and browser flows and has several states:\n\n`choose_method` expects `flow` (in the URL query) and `email` (in the body) to be sent\nand works with API- and Browser-initiated flows.\nFor 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\nand a HTTP 303 See Other redirect with a fresh verif"
},
{
"info": {
"name": "Create Verification Flow for Native Apps",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/self-service/verification/api",
"params": [
{
"name": "return_to",
"value": "",
"type": "query",
"description": "A URL contained in the return_to key of the verification flow.\nThis piece of data has no effect on the actual logic of the flow and is purely informational."
}
]
},
"docs": "This endpoint initiates a verification flow for API clients such as mobile devices, smart TVs, and so on.\n\nTo fetch an existing verification flow call `/self-service/verification/flows?flow=`.\n\nYou MUST NOT use this endpoint in client-side (Single Page Apps, ReactJS, AngularJS) nor server-side (Java Server\nPages, NodeJS, PHP, Golang, ...) browser applications. Using this endpoint in these applications will make\nyou vulnerable to a variety of CSRF attacks.\n\nThis endpoint MUST ONLY be use"
},
{
"info": {
"name": "Create Verification Flow for Browser Clients",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/self-service/verification/browser",
"params": [
{
"name": "return_to",
"value": "",
"type": "query",
"description": "The URL to return the browser to after the flow was completed."
}
]
},
"docs": "This endpoint initializes a browser-based account verification flow. Once initialized, the browser will be redirected to\n`selfservice.flows.verification.ui_url` with the flow ID set as the query parameter `?flow=`.\n\nIf this endpoint is called via an AJAX request, the response contains the recovery flow without any redirects.\n\nThis endpoint is NOT INTENDED for API clients and only works with browsers (Chrome, Firefox, ...).\n\nMore information can be found at [Ory Kratos Email and Phone Verificatio"
},
{
"info": {
"name": "Get Verification Flow",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/self-service/verification/flows",
"headers": [
{
"name": "cookie",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "query",
"description": "The Flow ID\n\nThe value for this parameter comes from `request` URL Query parameter sent to your\napplication (e.g. `/verification?flow=abcde`)."
}
]
},
"docs": "This endpoint returns a verification flow's context with, for example, error details and other information.\n\nBrowser flows expect the anti-CSRF cookie to be included in the request's HTTP Cookie Header.\nFor AJAX requests you must ensure that cookies are included in the request or requests will fail.\n\nIf you use the browser-flow for server-side apps, the services need to run on a common top-level-domain\nand you need to forward the incoming HTTP Cookie header to this endpoint:\n\n```js\npseudo-code e"
},
{
"info": {
"name": "Get My Active Sessions",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/sessions",
"headers": [
{
"name": "X-Session-Token",
"value": ""
},
{
"name": "Cookie",
"value": ""
}
],
"params": [
{
"name": "per_page",
"value": "",
"type": "query",
"description": "Deprecated Items per Page\n\nDEPRECATED: Please use `page_token` instead. This parameter will be removed in the future.\n\nThis is the number of items per page."
},
{
"name": "page",
"value": "",
"type": "query",
"description": "Deprecated Pagination Page\n\nDEPRECATED: Please use `page_token` instead. This parameter will be removed in the future.\n\nThis value is currently an integer, but it is not sequential. The value is not the page number, but a\nreference. The next page can be any number and some numbers might return an empty list.\n\nFor example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist.\nThe first page can be retrieved by omitting this parameter. Following page pointers will be returned in the\n`Link` header."
},
{
"name": "page_size",
"value": "",
"type": "query",
"description": "Page Size\n\nThis is the number of items per page to return. For details on pagination please head over to the\n[pagination documentation](https://www.ory.com/docs/ecosystem/api-design#pagination)."
},
{
"name": "page_token",
"value": "",
"type": "query",
"description": "Next Page Token\n\nThe next page token. For details on pagination please head over to the\n[pagination documentation](https://www.ory.com/docs/ecosystem/api-design#pagination)."
}
]
},
"docs": "This endpoints returns all other active sessions that belong to the logged-in user.\nThe current session can be retrieved by calling the `/sessions/whoami` endpoint."
},
{
"info": {
"name": "Disable my other sessions",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/sessions",
"headers": [
{
"name": "X-Session-Token",
"value": ""
},
{
"name": "Cookie",
"value": ""
}
]
},
"docs": "Calling this endpoint invalidates all except the current session that belong to the logged-in user.\nSession data are not deleted."
},
{
"info": {
"name": "Exchange Session Token",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/sessions/token-exchange",
"params": [
{
"name": "init_code",
"value": "",
"type": "query",
"description": "The part of the code return when initializing the flow."
},
{
"name": "return_to_code",
"value": "",
"type": "query",
"description": "The part of the code returned by the return_to URL."
}
]
},
"docs": "Exchange Session Token"
},
{
"info": {
"name": "Check Who the Current HTTP Session Belongs To",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/sessions/whoami",
"headers": [
{
"name": "X-Session-Token",
"value": "MP2YWEMeM8MxjkGKpH4dqOQ4Q4DlSPaj"
},
{
"name": "Cookie",
"value": "ory_session=a19iOVAbdzdgl70Rq1QZmrKmcjDtdsviCTZx7m9a9yHIUS8Wa9T7hvqyGTsLHi6Qifn2WUfpAKx9DWp0SJGleIn9vh2YF4A16id93kXFTgIgmwIOvbVAScyrx7yVl6bPZnCx27ec4WQDtaTewC1CpgudeDV2jQQnSaCP6ny3xa8qLH-QUgYqdQuoA_LF1phxgRCUfIrCLQOkolX5nv3ze_f=="
}
],
"params": [
{
"name": "tokenize_as",
"value": "",
"type": "query",
"description": "Returns the session additionally as a token (such as a JWT)\n\nThe 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)."
}
]
},
"docs": "Uses the HTTP Headers in the GET request to determine (e.g. by using checking the cookies) who is authenticated.\nReturns a session object in the body or 401 if the credentials are invalid or no credentials were sent.\nWhen the request it successful it adds the user ID to the 'X-Kratos-Authenticated-Identity-Id' header\nin the response.\n\nIf you call this endpoint from a server-side application, you must forward the HTTP Cookie Header to this endpoint:\n\n```js\npseudo-code example\nrouter.get('/protect"
},
{
"info": {
"name": "Disable one of my sessions",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/sessions/:id",
"headers": [
{
"name": "X-Session-Token",
"value": ""
},
{
"name": "Cookie",
"value": ""
}
],
"params": [
{
"name": "id",
"value": "",
"type": "path",
"description": "ID is the session's ID."
}
]
},
"docs": "Calling this endpoint invalidates the specified session. The current session cannot be revoked.\nSession data are not deleted."
}
]
}
],
"bundled": true
}