ory_hydra v3.12.8

ory_hydra

OryHydra - JavaScript client for ory_hydra Welcome to the ORY Hydra HTTP API documentation. You will find documentation for all HTTP APIs here. This SDK is automatically generated by the Swagger Codegen project:

• API version: latest
• Package version: latest
• Build package: io.swagger.codegen.languages.JavascriptClientCodegen

Installation

For Node.js

npm

To publish the library as a npm, please follow the procedure in "Publishing npm packages".

Then install it via:

npm install ory_hydra --save

Local development

To use the library locally without publishing to a remote npm registry, first install the dependencies by changing into the directory containing package.json (and this README). Let's call this JAVASCRIPT_CLIENT_DIR. Then run:

npm install

Next, link it globally in npm with the following, also from JAVASCRIPT_CLIENT_DIR:

npm link

Finally, switch to the directory you want to use your ory_hydra from, and run:

npm link /path/to/<JAVASCRIPT_CLIENT_DIR>

You should now be able to require('ory_hydra') in javascript files from the directory you ran the last command above from.

git

If the library is hosted at a git repository, e.g. https://github.com/GIT_USER_ID/GIT_REPO_ID then install it via:

    npm install GIT_USER_ID/GIT_REPO_ID --save

For browser

The library also works in the browser environment via npm and browserify. After following the above steps with Node.js and installing browserify with npm install -g browserify, perform the following (assuming main.js is your entry file, that's to say your javascript file where you actually use this library):

browserify main.js > bundle.js

Then include bundle.js in the HTML pages.

Webpack Configuration

Using Webpack you may encounter the following error: "Module not found: Error: Cannot resolve module", most certainly you should disable AMD loader. Add/merge the following section to your webpack config:

module: {
  rules: [
    {
      parser: {
        amd: false
      }
    }
  ]
}

Getting Started

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

var OryHydra = require('ory_hydra');

var api = new OryHydra.AdminApi()

var consentChallenge = "consentChallenge_example"; // {String} 

var opts = { 
  'body': new OryHydra.AcceptConsentRequest() // {AcceptConsentRequest} 
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.acceptConsentRequest(consentChallenge, opts, callback);

Documentation for API Endpoints

All URIs are relative to http://localhost

Documentation for Models

• OryHydra.AcceptConsentRequest
• OryHydra.AcceptLoginRequest
• OryHydra.CompletedRequest
• OryHydra.ConsentRequest
• OryHydra.ConsentRequestSession
• OryHydra.EmptyResponse
• OryHydra.FlushInactiveOAuth2TokensRequest
• OryHydra.GenericError
• OryHydra.HealthNotReadyStatus
• OryHydra.HealthStatus
• OryHydra.JSONWebKey
• OryHydra.JSONWebKeySet
• OryHydra.JsonWebKeySetGeneratorRequest
• OryHydra.LoginRequest
• OryHydra.LogoutRequest
• OryHydra.OAuth2Client
• OryHydra.OAuth2TokenIntrospection
• OryHydra.Oauth2TokenResponse
• OryHydra.OauthTokenResponse
• OryHydra.OpenIDConnectContext
• OryHydra.PreviousConsentSession
• OryHydra.RejectRequest
• OryHydra.SwaggerFlushInactiveAccessTokens
• OryHydra.SwaggerJsonWebKeyQuery
• OryHydra.SwaggerJwkCreateSet
• OryHydra.SwaggerJwkSetQuery
• OryHydra.SwaggerJwkUpdateSet
• OryHydra.SwaggerJwkUpdateSetKey
• OryHydra.SwaggerOAuthIntrospectionRequest
• OryHydra.SwaggerRevokeOAuth2TokenParameters
• OryHydra.Swaggeroauth2TokenParameters
• OryHydra.UserinfoResponse
• OryHydra.Version
• OryHydra.WellKnown

Documentation for Authorization

basic

• Type: HTTP basic authentication

oauth2

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