The identity and technical contract details declared by the specification.
settingsFlow
object
This flow is used when an identity wants to update settings (e.g. profile data, passwords, ...) in a selfservice manner. We recommend reading the [User Setting…
12 properties
8 required
updateLoginFlowWithTotpMethod
object
Update Login Flow with TOTP Method
4 properties
2 required
loginFlow
object
This object represents a login flow. A login flow is initiated at the "Initiate Login API / Browser Flow" endpoint by a client. Once a login flow is completed…
19 properties
7 required
selfServiceFlowType
string
The flow type can either be api or browser.
updateRecoveryFlowWithCodeMethod
object
Update Recovery Flow with Code Method
9 properties
1 required
updateSettingsFlowWithOidcMethod
object
Update Settings Flow with OpenID Connect Method
7 properties
1 required
updateSettingsFlowWithLookupMethod
object
Update Settings Flow with Lookup Method
7 properties
1 required
updateRegistrationFlowWithWebAuthnMethod
object
Update Registration Flow with WebAuthn Method
6 properties
2 required
successfulNativeRegistration
object
The Response for Registration Flows via API
4 properties
1 required
OAuth2LoginRequest
object
OAuth2LoginRequest struct for OAuth2LoginRequest
9 properties
updateRecoveryFlowWithLinkMethod
object
Update Recovery Flow with Link Method
4 properties
2 required
updateSettingsFlowWithWebAuthnMethod
object
Update Settings Flow with WebAuthn Method
6 properties
1 required
errorBrowserLocationChangeRequired
object
2 properties
updateLoginFlowWithPasswordMethod
object
Update Login Flow with Password Method
6 properties
3 required
updateRegistrationFlowWithCodeMethod
object
Update Registration Flow with Code Method
6 properties
2 required
sessionAuthenticationMethod
object
A singular authenticator used during authentication / login.
7 properties
updateSettingsFlowWithPasskeyMethod
object
Update Settings Flow with Passkey Method
4 properties
1 required
sessionAuthenticationMethods
array
A list of authenticators which were used to authenticate the session.
identityCredentials
object
Credentials represents a specific credential type
6 properties
updateLoginFlowWithSamlMethod
object
Update login flow using SAML
4 properties
2 required
updateSettingsFlowWithSamlMethod
object
Update settings flow using SAML
7 properties
1 required
updateLoginFlowWithPasskeyMethod
object
Update Login Flow with Passkey Method
3 properties
1 required
continueWithSettingsUi
object
Indicates, that the UI flow could be continued by showing a settings ui
2 properties
2 required
recoveryIdentityAddress
object
6 properties
2 required
continueWithVerificationUi
object
Indicates, that the UI flow could be continued by showing a verification ui
2 properties
2 required
uiText
object
4 properties
3 required
flowError
object
4 properties
1 required
registrationFlow
object
15 properties
7 required
updateLoginFlowWithOidcMethod
object
Update Login Flow with OpenID Connect Method
8 properties
2 required
updateLoginFlowWithCodeMethod
object
Update Login flow using the code method
7 properties
2 required
uiNodeTextAttributes
object
3 properties
3 required
continueWithRecoveryUi
object
Indicates, that the UI flow could be continued by showing a recovery ui
2 properties
2 required
uiNodeInputAttributes
object
InputAttributes represents the attributes of an input node
15 properties
4 required
uiNodeDivisionAttributes
object
Division sections are used for interactive widgets that require a hook in the DOM / view.
4 properties
2 required
performNativeLogoutBody
object
Perform Native Logout Request Body
1 property
1 required
continueWithSettingsUiFlow
object
2 properties
1 required
updateSettingsFlowBody
Update Settings Flow Request Body
sessionDevice
object
Device corresponding to a Session
4 properties
1 required
updateRegistrationFlowWithPasswordMethod
object
Update Registration Flow with Password Method
5 properties
3 required
uiContainer
object
Container represents a HTML Form. The container can work with both HTTP Form and JSON requests
4 properties
3 required
authenticatorAssuranceLevel
string
The authenticator assurance level can be one of "aal1", "aal2", or "aal3". A higher number means that it is harder for an attacker to compromise the account. G…
updateRegistrationFlowWithProfileMethod
object
Update Registration Flow with Profile Method
5 properties
2 required
session
object
A Session
10 properties
1 required
updateRegistrationFlowWithPasskeyMethod
object
Update Registration Flow with Passkey Method
5 properties
2 required
uiNodeInputAttributesOption
object
Represents a single selectable value for an input whose JSON schema defined an enum. The value is always a scalar JSON type (string, number, or boolean) serial…
1 property
1 required
updateLoginFlowWithIdentifierFirstMethod
object
Update Login Flow with Multi-Step Method
4 properties
2 required
updateLoginFlowWithLookupSecretMethod
object
Update Login Flow with Lookup Secret Method
3 properties
2 required
identity
object
An [identity](https://www.ory.com/docs/kratos/concepts/identity-user-model) represents a (human) user in Ory.
15 properties
4 required
updateVerificationFlowBody
Update Verification Flow Request Body
nullJsonRawMessage
NullJSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger and is NULLable-
createFedcmFlowResponse
object
Contains a list of all available FedCM providers.
2 properties
continueWithRecoveryUiFlow
object
2 properties
1 required
updateRecoveryFlowBody
Update Recovery Flow Request Body
verificationFlow
object
Used to verify an out-of-band communication channel such as an email address or a phone number. For more information head over to: https://www.ory.com/docs/kra…
10 properties
4 required
OAuth2Client
object
48 properties
deleteMySessionsCount
object
Deleted Session Count
1 property
logoutFlow
object
Logout Flow
2 properties
2 required
updateRegistrationFlowWithSamlMethod
object
Update registration flow using SAML
5 properties
2 required
continueWithSetOrySessionToken
object
Indicates that a session was issued, and the application should use this token for authenticated requests
2 properties
2 required
Provider
object
7 properties
updateVerificationFlowWithCodeMethod
object
5 properties
1 required
updateRegistrationFlowBody
Update Registration Request Body
updateSettingsFlowWithProfileMethod
object
Update Settings Flow with Profile Method
4 properties
2 required
successfulNativeLogin
object
The Response for Login Flows via API
3 properties
1 required
uiNodeAnchorAttributes
object
4 properties
4 required
errorGeneric
object
The standard Ory JSON API error format.
1 property
1 required
continueWithRedirectBrowserTo
object
Indicates, that the UI flow could be continued by showing a recovery ui
2 properties
2 required
UpdateFedcmFlowBody
object
4 properties
2 required
recoveryFlow
object
This request is used when an identity wants to recover their account. We recommend reading the [Account Recovery Documentation](../self-service/flows/password-…
11 properties
7 required
uiNodeMeta
object
This might include a label and other information that can optionally be used to render UIs.
1 property
identityVerifiableAddressStatus
string
VerifiableAddressStatus must not exceed 16 characters as that is the limitation in the SQL Schema
uiNodeScriptAttributes
object
9 properties
9 required
updateLoginFlowWithWebAuthnMethod
object
Update Login Flow with WebAuthn Method
5 properties
2 required
updateRegistrationFlowWithOidcMethod
object
Update Registration Flow with OpenID Connect Method
8 properties
2 required
webAuthnJavaScript
string
continueWithVerificationUiFlow
object
3 properties
2 required
OAuth2ConsentRequestOpenIDConnectContext
object
OAuth2ConsentRequestOpenIDConnectContext struct for OAuth2ConsentRequestOpenIDConnectContext
5 properties
uiNode
object
Nodes are represented as HTML elements or their native UI equivalents. For example, a node can be an tag, or an but also some plain text.
5 properties
5 required
uiNodeImageAttributes
object
5 properties
5 required
verifiableIdentityAddress
object
VerifiableAddress is an identity's verifiable address
8 properties
4 required
identityTraits
Traits represent an identity's traits. The identity is able to create, modify, and delete traits in a self-service manner. The input will always be validated a…
updateSettingsFlowWithPasswordMethod
object
Update Settings Flow with Password Method
4 properties
2 required
updateVerificationFlowWithLinkMethod
object
Update Verification Flow with Link Method
4 properties
2 required
updateSettingsFlowWithTotpMethod
object
Update Settings Flow with TOTP Method
5 properties
1 required
genericError
object
8 properties
1 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Ory publishes across the network.
