@ory/kratos-client

@ory/kratos-client@v26.2.0

This generator creates TypeScript/JavaScript client that utilizes axios. The generated Node module can be used in the following environments:

Environment

• Node.js
• Webpack
• Browserify

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)

Building

To build and compile the typescript sources to javascript use:

npm install
npm run build

Publishing

First build the package then run npm publish

Consuming

navigate to the folder of your consuming project and run one of the following commands.

published:

npm install @ory/kratos-client@v26.2.0 --save

unPublished (not recommended):

npm install PATH_TO_GENERATED_PACKAGE --save

Documentation for API Endpoints

All URIs are relative to http://localhost

Class	Method	HTTP request	Description
CourierApi	getCourierMessage	GET /admin/courier/messages/{id}	Get a Message
CourierApi	listCourierMessages	GET /admin/courier/messages	List Messages
FrontendApi	createBrowserLoginFlow	GET /self-service/login/browser	Create Login Flow for Browsers
FrontendApi	createBrowserLogoutFlow	GET /self-service/logout/browser	Create a Logout URL for Browsers
FrontendApi	createBrowserRecoveryFlow	GET /self-service/recovery/browser	Create Recovery Flow for Browsers
FrontendApi	createBrowserRegistrationFlow	GET /self-service/registration/browser	Create Registration Flow for Browsers
FrontendApi	createBrowserSettingsFlow	GET /self-service/settings/browser	Create Settings Flow for Browsers
FrontendApi	createBrowserVerificationFlow	GET /self-service/verification/browser	Create Verification Flow for Browser Clients
FrontendApi	createFedcmFlow	GET /self-service/fed-cm/parameters	Get FedCM Parameters
FrontendApi	createNativeLoginFlow	GET /self-service/login/api	Create Login Flow for Native Apps
FrontendApi	createNativeRecoveryFlow	GET /self-service/recovery/api	Create Recovery Flow for Native Apps
FrontendApi	createNativeRegistrationFlow	GET /self-service/registration/api	Create Registration Flow for Native Apps
FrontendApi	createNativeSettingsFlow	GET /self-service/settings/api	Create Settings Flow for Native Apps
FrontendApi	createNativeVerificationFlow	GET /self-service/verification/api	Create Verification Flow for Native Apps
FrontendApi	disableMyOtherSessions	DELETE /sessions	Disable my other sessions
FrontendApi	disableMySession	DELETE /sessions/{id}	Disable one of my sessions
FrontendApi	exchangeSessionToken	GET /sessions/token-exchange	Exchange Session Token
FrontendApi	getFlowError	GET /self-service/errors	Get User-Flow Errors
FrontendApi	getLoginFlow	GET /self-service/login/flows	Get Login Flow
FrontendApi	getRecoveryFlow	GET /self-service/recovery/flows	Get Recovery Flow
FrontendApi	getRegistrationFlow	GET /self-service/registration/flows	Get Registration Flow
FrontendApi	getSettingsFlow	GET /self-service/settings/flows	Get Settings Flow
FrontendApi	getVerificationFlow	GET /self-service/verification/flows	Get Verification Flow
FrontendApi	getWebAuthnJavaScript	GET /.well-known/ory/webauthn.js	Get WebAuthn JavaScript
FrontendApi	listMySessions	GET /sessions	Get My Active Sessions
FrontendApi	performNativeLogout	DELETE /self-service/logout/api	Perform Logout for Native Apps
FrontendApi	toSession	GET /sessions/whoami	Check Who the Current HTTP Session Belongs To
FrontendApi	updateFedcmFlow	POST /self-service/fed-cm/token	Submit a FedCM token
FrontendApi	updateLoginFlow	POST /self-service/login	Submit a Login Flow
FrontendApi	updateLogoutFlow	GET /self-service/logout	Update Logout Flow
FrontendApi	updateRecoveryFlow	POST /self-service/recovery	Update Recovery Flow
FrontendApi	updateRegistrationFlow	POST /self-service/registration	Update Registration Flow
FrontendApi	updateSettingsFlow	POST /self-service/settings	Complete Settings Flow
FrontendApi	updateVerificationFlow	POST /self-service/verification	Complete Verification Flow
IdentityApi	batchPatchIdentities	PATCH /admin/identities	Create multiple identities
IdentityApi	createIdentity	POST /admin/identities	Create an Identity
IdentityApi	createRecoveryCodeForIdentity	POST /admin/recovery/code	Create a Recovery Code
IdentityApi	createRecoveryLinkForIdentity	POST /admin/recovery/link	Create a Recovery Link
IdentityApi	deleteIdentity	DELETE /admin/identities/{id}	Delete an Identity
IdentityApi	deleteIdentityCredentials	DELETE /admin/identities/{id}/credentials/{type}	Delete a credential for a specific identity
IdentityApi	deleteIdentitySessions	DELETE /admin/identities/{id}/sessions	Delete & Invalidate an Identity's Sessions
IdentityApi	disableSession	DELETE /admin/sessions/{id}	Deactivate a Session
IdentityApi	extendSession	PATCH /admin/sessions/{id}/extend	Extend a Session
IdentityApi	getIdentity	GET /admin/identities/{id}	Get an Identity
IdentityApi	getIdentityByExternalID	GET /admin/identities/by/external/{externalID}	Get an Identity by its External ID
IdentityApi	getIdentitySchema	GET /schemas/{id}	Get Identity JSON Schema
IdentityApi	getSession	GET /admin/sessions/{id}	Get Session
IdentityApi	listIdentities	GET /admin/identities	List Identities
IdentityApi	listIdentitySchemas	GET /schemas	Get all Identity Schemas
IdentityApi	listIdentitySessions	GET /admin/identities/{id}/sessions	List an Identity's Sessions
IdentityApi	listSessions	GET /admin/sessions	List All Sessions
IdentityApi	patchIdentity	PATCH /admin/identities/{id}	Patch an Identity
IdentityApi	updateIdentity	PUT /admin/identities/{id}	Update an Identity
MetadataApi	getVersion	GET /version	Return Running Software Version.
MetadataApi	isAlive	GET /health/alive	Check HTTP Server Status
MetadataApi	isReady	GET /health/ready	Check HTTP Server and Database Status

Documentation For Models

• AuthenticatorAssuranceLevel
• BatchPatchIdentitiesResponse
• ConsistencyRequestParameters
• ContinueWith
• ContinueWithRecoveryUi
• ContinueWithRecoveryUiFlow
• ContinueWithRedirectBrowserTo
• ContinueWithSetOrySessionToken
• ContinueWithSettingsUi
• ContinueWithSettingsUiFlow
• ContinueWithVerificationUi
• ContinueWithVerificationUiFlow
• CourierMessageStatus
• CourierMessageType
• CreateFedcmFlowResponse
• CreateIdentityBody
• CreateRecoveryCodeForIdentityBody
• CreateRecoveryLinkForIdentityBody
• DeleteMySessionsCount
• ErrorAuthenticatorAssuranceLevelNotSatisfied
• ErrorBrowserLocationChangeRequired
• ErrorFlowReplaced
• ErrorGeneric
• FlowError
• GenericError
• GetVersion200Response
• HealthNotReadyStatus
• HealthStatus
• Identity
• IdentityCredentials
• IdentityCredentialsCode
• IdentityCredentialsCodeAddress
• IdentityCredentialsOidc
• IdentityCredentialsOidcProvider
• IdentityCredentialsPassword
• IdentityPatch
• IdentityPatchResponse
• IdentitySchemaContainer
• IdentityWithCredentials
• IdentityWithCredentialsOidc
• IdentityWithCredentialsOidcConfig
• IdentityWithCredentialsOidcConfigProvider
• IdentityWithCredentialsPassword
• IdentityWithCredentialsPasswordConfig
• IdentityWithCredentialsSaml
• IdentityWithCredentialsSamlConfig
• IdentityWithCredentialsSamlConfigProvider
• IsAlive200Response
• IsReady503Response
• JsonPatch
• LoginFlow
• LoginFlowState
• LogoutFlow
• Message
• MessageDispatch
• NeedsPrivilegedSessionError
• OAuth2Client
• OAuth2ConsentRequestOpenIDConnectContext
• OAuth2LoginRequest
• PatchIdentitiesBody
• PerformNativeLogoutBody
• Provider
• RecoveryCodeForIdentity
• RecoveryFlow
• RecoveryFlowState
• RecoveryIdentityAddress
• RecoveryLinkForIdentity
• RegistrationFlow
• RegistrationFlowState
• SelfServiceFlowExpiredError
• Session
• SessionAuthenticationMethod
• SessionDevice
• SettingsFlow
• SettingsFlowState
• SuccessfulCodeExchangeResponse
• SuccessfulNativeLogin
• SuccessfulNativeRegistration
• TokenPagination
• TokenPaginationHeaders
• UiContainer
• UiNode
• UiNodeAnchorAttributes
• UiNodeAttributes
• UiNodeDivisionAttributes
• UiNodeImageAttributes
• UiNodeInputAttributes
• UiNodeMeta
• UiNodeScriptAttributes
• UiNodeTextAttributes
• UiText
• UpdateFedcmFlowBody
• UpdateIdentityBody
• UpdateLoginFlowBody
• UpdateLoginFlowWithCodeMethod
• UpdateLoginFlowWithIdentifierFirstMethod
• UpdateLoginFlowWithLookupSecretMethod
• UpdateLoginFlowWithOidcMethod
• UpdateLoginFlowWithPasskeyMethod
• UpdateLoginFlowWithPasswordMethod
• UpdateLoginFlowWithSamlMethod
• UpdateLoginFlowWithTotpMethod
• UpdateLoginFlowWithWebAuthnMethod
• UpdateRecoveryFlowBody
• UpdateRecoveryFlowWithCodeMethod
• UpdateRecoveryFlowWithLinkMethod
• UpdateRegistrationFlowBody
• UpdateRegistrationFlowWithCodeMethod
• UpdateRegistrationFlowWithOidcMethod
• UpdateRegistrationFlowWithPasskeyMethod
• UpdateRegistrationFlowWithPasswordMethod
• UpdateRegistrationFlowWithProfileMethod
• UpdateRegistrationFlowWithSamlMethod
• UpdateRegistrationFlowWithWebAuthnMethod
• UpdateSettingsFlowBody
• UpdateSettingsFlowWithLookupMethod
• UpdateSettingsFlowWithOidcMethod
• UpdateSettingsFlowWithPasskeyMethod
• UpdateSettingsFlowWithPasswordMethod
• UpdateSettingsFlowWithProfileMethod
• UpdateSettingsFlowWithSamlMethod
• UpdateSettingsFlowWithTotpMethod
• UpdateSettingsFlowWithWebAuthnMethod
• UpdateVerificationFlowBody
• UpdateVerificationFlowWithCodeMethod
• UpdateVerificationFlowWithLinkMethod
• VerifiableIdentityAddress
• VerificationFlow
• VerificationFlowState
• Version

Documentation For Authorization

Authentication schemes defined for the API:

oryAccessToken

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header