hydra-client

Ory Kratos

• API version: v0.0.0-alpha.1
  • Build date: 2020-01-06T13:38:36.268669+01:00[Europe/Berlin]

Welcome to the ORY Kratos HTTP API documentation!

Automatically generated by the OpenAPI Generator

Requirements

Building the API client library requires:

1. Java 1.7+
2. Maven/Gradle

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>sh.ory.kratos</groupId>
  <artifactId>hydra-client</artifactId>
  <version>v0.0.0-alpha.1</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "sh.ory.kratos:hydra-client:v0.0.0-alpha.1"

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/hydra-client-v0.0.0-alpha.1.jar
• target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

// Import classes:
import sh.ory.kratos.ApiClient;
import sh.ory.kratos.ApiException;
import sh.ory.kratos.Configuration;
import sh.ory.kratos.models.*;
import sh.ory.kratos.api.HealthApi;

public class Example {
  public static void main(String[] args) {
    ApiClient defaultClient = Configuration.getDefaultApiClient();
    defaultClient.setBasePath("http://localhost");

    HealthApi apiInstance = new HealthApi(defaultClient);
    try {
      HealthStatus result = apiInstance.isInstanceAlive();
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling HealthApi#isInstanceAlive");
      System.err.println("Status code: " + e.getCode());
      System.err.println("Reason: " + e.getResponseBody());
      System.err.println("Response headers: " + e.getResponseHeaders());
      e.printStackTrace();
    }
  }
}

Documentation for API Endpoints

All URIs are relative to http://localhost

Documentation for Models

• Error
• Form
• FormField
• GenericError
• HealthNotReadyStatus
• HealthStatus
• Identity
• LoginRequest
• LoginRequestMethod
• LoginRequestMethodConfig
• OidcStrategyCredentialsConfig
• OidcStrategyRequestMethod
• ProfileManagementRequest
• RegistrationRequest
• RegistrationRequestMethod
• RegistrationRequestMethodConfig
• Version

Documentation for Authorization

All endpoints do not require authorization. Authentication schemes defined for the API:

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author