API Reference ory_kratos v1.0.0
Modules
API calls for all endpoints tagged Courier
.
API calls for all endpoints tagged Frontend
.
API calls for all endpoints tagged Identity
.
API calls for all endpoints tagged Metadata
.
Handle Tesla connections for Ory.
Helper functions for deserializing responses into models
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. Generally, "aal1" implies that one authentication factor was used while AAL2 implies that two factors (e.g. password + TOTP) have been used. To learn more about these levels please head over to: https://www.ory.sh/kratos/docs/concepts/credentials
Patch identities response
Indicates that a session was issued, and the application should use this token for authenticated requests
Indicates, that the UI flow could be continued by showing a verification ui
A Message's Status
It can either be email
or phone
Create Identity Body
Create Recovery Code for Identity Request Body
Create Recovery Link for Identity Request Body
Deleted Session Count
Is sent when a flow is replaced by a different flow of the same class
The standard Ory JSON API error format.
An identity represents a (human) user in Ory.
Credentials represents a specific credential type
and so on.
Payload for patching an identity
Response for a single identity patch
An Identity JSON Schema Container
The state can either be active
or inactive
.
Create Identity and Import Credentials
Create Identity and Import Social Sign In Credentials
Create Identity and Import Social Sign In Credentials Configuration
Create Identity and Import Password Credentials
Create Identity and Import Password Credentials Configuration
A JSONPatch document as defined by RFC 6902
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 successfully, a session cookie or session token will be issued.
Logout Flow
MessageDispatch represents an attempt of sending a courier message It contains the status of the attempt (failed or successful) and the error if any occured
OAuth2ConsentRequestOpenIDConnectContext struct for OAuth2ConsentRequestOpenIDConnectContext
OAuth2LoginRequest struct for OAuth2LoginRequest
Patch Identities Body
Perform Native Logout Request Body
Used when an administrator creates a recovery code for an identity.
This request is used when an identity wants to recover their account. We recommend reading the Account Recovery Documentation
The state represents the state of the recovery flow. choose_method: ask the user to choose a method (e.g. recover account via email) sent_email: the email has been sent to the user passed_challenge: the request was successful and the recovery challenge was passed.
Used when an administrator creates a recovery link for an identity.
Is sent when a flow is expired
A Session
A singular authenticator used during authentication / login.
Device corresponding to a Session
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 Settings Documentation
show_form: No user data has been collected, or it is invalid, and thus the form should be shown. success: Indicates that the settings flow has been updated successfully with the provided data. Done will stay true when repeatedly checking. If set to true, done will revert back to false only when a flow with invalid (e.g. "please use a valid phone number") data was sent.
The Response for Registration Flows via API
The Response for Login Flows via API
The Response for Registration Flows via API
Container represents a HTML Form. The container can work with both HTTP Form and JSON requests
Nodes are represented as HTML elements or their native UI equivalents. For example, a node can be an <img>
tag, or an <input element>
but also some plain text
.
InputAttributes represents the attributes of an input node
This might include a label and other information that can optionally be used to render UIs.
Update Identity Body
Update Login Flow with Lookup Secret Method
Update Login Flow with OpenID Connect Method
Update Login Flow with Password Method
Update Login Flow with TOTP Method
Update Login Flow with WebAuthn Method
Update Recovery Flow Request Body
Update Recovery Flow with Code Method
Update Recovery Flow with Link Method
Update Registration Request Body
Update Registration Flow with OpenID Connect Method
Update Registration Flow with Password Method
Update Registration Flow with WebAuthn Method
Update Settings Flow Request Body
Update Settings Flow with Lookup Method
Update Settings Flow with OpenID Connect Method
Update Settings Flow with Password Method
Update Settings Flow with Profile Method
Update Settings Flow with TOTP Method
Update Settings Flow with WebAuthn Method
Update Verification Flow Request Body
Update Verification Flow with Link Method
VerifiableAddress is an identity's verifiable address
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.sh/docs/kratos/self-service/flows/verify-email-account-activation
The state represents the state of the verification flow. choose_method: ask the user to choose a method (e.g. recover account via email) sent_email: the email has been sent to the user passed_challenge: the request was successful and the recovery challenge was passed.
Helper functions for building Tesla requests