hydra-client

ORY Hydra

• API version: v0.0.0-alpha.2
  • Build date: 2020-01-04T16:01:02.111610+01:00[Europe/Berlin]

Welcome to the ORY Hydra HTTP API documentation. You will find documentation for all HTTP APIs here.

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.hydra</groupId>
  <artifactId>hydra-client</artifactId>
  <version>v0.0.0-alpha.2</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

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

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

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

Getting Started

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

// Import classes:
import sh.ory.hydra.ApiClient;
import sh.ory.hydra.ApiException;
import sh.ory.hydra.Configuration;
import sh.ory.hydra.models.*;
import sh.ory.hydra.api.AdminApi;

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

    AdminApi apiInstance = new AdminApi(defaultClient);
    String consentChallenge = "consentChallenge_example"; // String | 
    AcceptConsentRequest body = new AcceptConsentRequest(); // AcceptConsentRequest | 
    try {
      CompletedRequest result = apiInstance.acceptConsentRequest(consentChallenge, body);
      System.out.println(result);
    } catch (ApiException e) {
      System.err.println("Exception when calling AdminApi#acceptConsentRequest");
      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

• AcceptConsentRequest
• AcceptLoginRequest
• CompletedRequest
• ConsentRequest
• ConsentRequestSession
• FlushInactiveOAuth2TokensRequest
• GenericError
• HealthNotReadyStatus
• HealthStatus
• JSONWebKey
• JSONWebKeySet
• JsonWebKeySetGeneratorRequest
• LoginRequest
• LogoutRequest
• OAuth2Client
• OAuth2TokenIntrospection
• Oauth2TokenResponse
• OauthTokenResponse
• OpenIDConnectContext
• PreviousConsentSession
• RejectRequest
• UserinfoResponse
• Version
• WellKnown

Documentation for Authorization

Authentication schemes defined for the API:

basic

• Type: HTTP basic authentication

oauth2

• Type: OAuth
• Flow: accessCode
• Authorization URL: /oauth2/auth
• Scopes:
  • offline: A scope required when requesting refresh tokens (alias for `offline`)
  • offline_access: A scope required when requesting refresh tokens
  • openid: Request an OpenID Connect ID Token

Recommendation

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

Author