ory_kratos_client 0.11.0 ory_kratos_client: ^0.11.0 copied to clipboard
OpenAPI API client
ory_kratos_client (EXPERIMENTAL) #
This is the API specification for Ory Identities with features such as registration, login, recovery, account verification, profile settings, password reset, identity management, session management, email and sms delivery, and more.
This Dart package is automatically generated by the OpenAPI Generator project:
- API version: v0.11.0
- Build package: org.openapitools.codegen.languages.DartDioClientCodegen
Requirements #
- Dart 2.12.0 or later OR Flutter 1.26.0 or later
- Dio 4.0.0+
Installation & Usage #
pub.dev #
To use the package from pub.dev, please include the following in pubspec.yaml
dependencies:
ory_kratos_client: 0.11.0
Github #
If this Dart package is published to Github, please include the following in pubspec.yaml
dependencies:
ory_kratos_client:
git:
url: https://github.com/ory/sdk.git
#ref: main
Local development #
To use the package from your local drive, please include the following in pubspec.yaml
dependencies:
ory_kratos_client:
path: /path/to/ory_kratos_client
Getting Started #
Please follow the installation procedure and then run the following:
import 'package:ory_kratos_client/ory_kratos_client.dart';
final api = OryKratosClient().getCourierApi();
final int perPage = 789; // int | Items per Page This is the number of items per page.
final int page = 789; // int | Pagination Page This value is currently an integer, but it is not sequential. The value is not the page number, but a reference. The next page can be any number and some numbers might return an empty list. For example, page 2 might not follow after page 1. And even if page 3 and 5 exist, but page 4 might not exist.
final CourierMessageStatus status = ; // CourierMessageStatus | Status filters out messages based on status. If no value is provided, it doesn't take effect on filter.
final String recipient = recipient_example; // String | Recipient filters out messages based on recipient. If no value is provided, it doesn't take effect on filter.
try {
final response = await api.listCourierMessages(perPage, page, status, recipient);
print(response);
} catch on DioError (e) {
print("Exception when calling CourierApi->listCourierMessages: $e\n");
}
Documentation for API Endpoints #
All URIs are relative to http://localhost
Class | Method | HTTP request | Description |
---|---|---|---|
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 | 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 | 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 | updateLoginFlow | POST /self-service/login | Submit a Login Flow |
FrontendApi | updateLogoutFlow | GET /self-service/logout | Update Logout Flow |
FrontendApi | updateRecoveryFlow | POST /self-service/recovery | Complete 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 | 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 | 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 | getIdentitySchema | GET /schemas/{id} | Get Identity JSON Schema |
IdentityApi | getSession | GET /admin/sessions/{id} | This endpoint returns the session object with expandables specified. |
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
- CourierMessageStatus
- CourierMessageType
- CreateIdentityBody
- CreateRecoveryCodeForIdentityBody
- CreateRecoveryLinkForIdentityBody
- DeleteMySessionsCount
- ErrorAuthenticatorAssuranceLevelNotSatisfied
- ErrorBrowserLocationChangeRequired
- ErrorFlowReplaced
- ErrorGeneric
- FlowError
- GenericError
- GetVersion200Response
- HealthNotReadyStatus
- HealthStatus
- Identity
- IdentityCredentials
- IdentityCredentialsOidc
- IdentityCredentialsOidcProvider
- IdentityCredentialsPassword
- IdentityCredentialsType
- IdentitySchemaContainer
- IdentityState
- IdentityWithCredentials
- IdentityWithCredentialsOidc
- IdentityWithCredentialsOidcConfig
- IdentityWithCredentialsOidcConfigProvider
- IdentityWithCredentialsPassword
- IdentityWithCredentialsPasswordConfig
- IsAlive200Response
- IsReady503Response
- JsonPatch
- LoginFlow
- LogoutFlow
- Message
- NeedsPrivilegedSessionError
- OAuth2Client
- OAuth2ConsentRequestOpenIDConnectContext
- OAuth2LoginRequest
- Pagination
- PerformNativeLogoutBody
- RecoveryCodeForIdentity
- RecoveryFlow
- RecoveryFlowState
- RecoveryIdentityAddress
- RecoveryLinkForIdentity
- RegistrationFlow
- SelfServiceFlowExpiredError
- Session
- SessionAuthenticationMethod
- SessionDevice
- SettingsFlow
- SettingsFlowState
- SuccessfulNativeLogin
- SuccessfulNativeRegistration
- TokenPagination
- TokenPaginationHeaders
- UiContainer
- UiNode
- UiNodeAnchorAttributes
- UiNodeAttributes
- UiNodeImageAttributes
- UiNodeInputAttributes
- UiNodeMeta
- UiNodeScriptAttributes
- UiNodeTextAttributes
- UiText
- UpdateIdentityBody
- UpdateLoginFlowBody
- UpdateLoginFlowWithLookupSecretMethod
- UpdateLoginFlowWithOidcMethod
- UpdateLoginFlowWithPasswordMethod
- UpdateLoginFlowWithTotpMethod
- UpdateLoginFlowWithWebAuthnMethod
- UpdateRecoveryFlowBody
- UpdateRecoveryFlowWithCodeMethod
- UpdateRecoveryFlowWithLinkMethod
- UpdateRegistrationFlowBody
- UpdateRegistrationFlowWithOidcMethod
- UpdateRegistrationFlowWithPasswordMethod
- UpdateRegistrationFlowWithWebAuthnMethod
- UpdateSettingsFlowBody
- UpdateSettingsFlowWithLookupMethod
- UpdateSettingsFlowWithOidcMethod
- UpdateSettingsFlowWithPasswordMethod
- UpdateSettingsFlowWithProfileMethod
- UpdateSettingsFlowWithTotpMethod
- UpdateSettingsFlowWithWebAuthnMethod
- UpdateVerificationFlowBody
- UpdateVerificationFlowWithCodeMethodBody
- UpdateVerificationFlowWithLinkMethod
- VerifiableIdentityAddress
- VerificationFlow
- VerificationFlowState
- Version
Documentation For Authorization #
oryAccessToken #
- Type: API key
- API key parameter name: Authorization
- Location: HTTP header