leancode_kratos_client 0.0.1
leancode_kratos_client: ^0.0.1 copied to clipboard
A Flutter library for connecting to Ory Kratos. It helps manage user authentication, registration, making it simple to add identity features to your app.
KratosClient #
The KratosClient provides an API client for interacting with an Ory Kratos server.
Usage #
To create a client: #
final client = KratosClient(
baseUri: Uri.parse('https://kratos.example.com'),
browserCallback: (url) async {
// open browser and return code
},
);
Features #
The main available APIs are: #
Registration #
registerWithPassword- Register using email and passwordregisterWithOidc- Register using OpenID Connect provider
Login #
loginWithPassword- Login with email and password
Verification #
getVerificationFlow- Get verification flowverifyAccount- Complete email verification
Recovery #
getRecoveryFlow- Get account recovery flowsendEmailRecoveryFlow- Initiate email account recoverysendCodeRecoveryFlow- Submit recovery code
Profile #
getSettingsFlow- Get user profileupdateTraits- Update user profile traitsupdatePassword- Update user password
Other #
logout- Logout userrefreshSessionToken- Refresh session token
Credentials Storage #
The client handles persisting credentials like the session token. By default it uses FlutterSecureCredentialsStorage but you can pass a custom CredentialsStorage on construction.
Error Handling #
Most methods return a union type for success or failure responses. See code for details on specific error types.
HTTP Client #
The http.Client used to make requests can be customized by passing your own on construction.
Logging #
Debug logging is printed using the logging package.