@ory/kratos-client-fetch

v26.2.0

Published

a month ago

OpenAPI client for @ory/kratos-client-fetch

0High
0Medium
0Low

arekkas

hperl

jonas-jonas

@ory/[email protected]

A TypeScript SDK client for the localhost API.

Usage

First, install the SDK from npm.

npm install @ory/kratos-client-fetch --save

Next, try it out.

import {
  Configuration,
  CourierApi,
} from '@ory/kratos-client-fetch';
import type { GetCourierMessageRequest } from '@ory/kratos-client-fetch';

async function example() {
  console.log("🚀 Testing @ory/kratos-client-fetch SDK...");
  const config = new Configuration({ 
    // To configure API key authorization: oryAccessToken
    apiKey: "YOUR API KEY",
  });
  const api = new CourierApi(config);

  const body = {
    // string | MessageID is the ID of the message.
    id: id_example,
  } satisfies GetCourierMessageRequest;

  try {
    const data = await api.getCourierMessage(body);
    console.log(data);
  } catch (error) {
    console.error(error);
  }
}

// Run the test
example().catch(console.error);

Documentation

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

Models

Authorization

Authentication schemes defined for the API:

oryAccessToken

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

About

This TypeScript SDK client supports the Fetch API and is automatically generated by the OpenAPI Generator project:

API version: v26.2.0
Package version: v26.2.0
Generator version: 7.17.0
Build package: org.openapitools.codegen.languages.TypeScriptFetchClientCodegen

The generated npm module supports the following:

Environments
- Node.js
- Webpack
- Browserify
Language levels
- ES5 - you must have a Promises/A+ library installed
- ES6
Module systems
- CommonJS
- ES6 module system

Development

Building

To build the TypeScript source code, you need to have Node.js and npm installed. After cloning the repository, navigate to the project directory and run:

npm install
npm run build

Publishing

Once you've built the package, you can publish it to npm:

npm publish

License

Apache 2.0