ory_hydra_client

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

This Dart package is automatically generated by the OpenAPI Generator project:

  • API version: v1.9.1
  • Build package: org.openapitools.codegen.languages.DartClientCodegen

Requirements

Dart 2.0 or later

Installation & Usage

Github

If this Dart package is published to Github, add the following dependency to your pubspec.yaml

dependencies:
  ory_hydra_client:
    git: https://github.com/ory/sdk.git

Local

To use the package in your local drive, add the following dependency to your pubspec.yaml

dependencies:
  ory_hydra_client:
    path: /path/to/ory_hydra_client

Tests

TODO

Getting Started

Please follow the installation procedure and then run the following:

import 'package:ory_hydra_client/api.dart';


final api_instance = AdminApi();
final consentChallenge = consentChallenge_example; // String | 
final body = AcceptConsentRequest(); // AcceptConsentRequest | 

try {
    final result = api_instance.acceptConsentRequest(consentChallenge, body);
    print(result);
} catch (e) {
    print('Exception when calling AdminApi->acceptConsentRequest: $e\n');
}

Documentation for API Endpoints

All URIs are relative to http://localhost

ClassMethodHTTP requestDescription
AdminApiacceptConsentRequestPUT /oauth2/auth/requests/consent/acceptAccept a Consent Request
AdminApiacceptLoginRequestPUT /oauth2/auth/requests/login/acceptAccept a Login Request
AdminApiacceptLogoutRequestPUT /oauth2/auth/requests/logout/acceptAccept a Logout Request
AdminApicreateJsonWebKeySetPOST /keys/{set}Generate a New JSON Web Key
AdminApicreateOAuth2ClientPOST /clientsCreate an OAuth 2.0 Client
AdminApideleteJsonWebKeyDELETE /keys/{set}/{kid}Delete a JSON Web Key
AdminApideleteJsonWebKeySetDELETE /keys/{set}Delete a JSON Web Key Set
AdminApideleteOAuth2ClientDELETE /clients/{id}Deletes an OAuth 2.0 Client
AdminApideleteOAuth2TokenDELETE /oauth2/tokensDelete OAuth2 Access Tokens from a Client
AdminApiflushInactiveOAuth2TokensPOST /oauth2/flushFlush Expired OAuth2 Access Tokens
AdminApigetConsentRequestGET /oauth2/auth/requests/consentGet Consent Request Information
AdminApigetJsonWebKeyGET /keys/{set}/{kid}Fetch a JSON Web Key
AdminApigetJsonWebKeySetGET /keys/{set}Retrieve a JSON Web Key Set
AdminApigetLoginRequestGET /oauth2/auth/requests/loginGet a Login Request
AdminApigetLogoutRequestGET /oauth2/auth/requests/logoutGet a Logout Request
AdminApigetOAuth2ClientGET /clients/{id}Get an OAuth 2.0 Client.
AdminApigetVersionGET /versionGet Service Version
AdminApiintrospectOAuth2TokenPOST /oauth2/introspectIntrospect OAuth2 Tokens
AdminApiisInstanceAliveGET /health/aliveCheck Alive Status
AdminApilistOAuth2ClientsGET /clientsList OAuth 2.0 Clients
AdminApilistSubjectConsentSessionsGET /oauth2/auth/sessions/consentLists All Consent Sessions of a Subject
AdminApiprometheusGET /metrics/prometheusGet Snapshot Metrics from the Hydra Service.
AdminApirejectConsentRequestPUT /oauth2/auth/requests/consent/rejectReject a Consent Request
AdminApirejectLoginRequestPUT /oauth2/auth/requests/login/rejectReject a Login Request
AdminApirejectLogoutRequestPUT /oauth2/auth/requests/logout/rejectReject a Logout Request
AdminApirevokeAuthenticationSessionDELETE /oauth2/auth/sessions/loginInvalidates All Login Sessions of a Certain User Invalidates a Subject's Authentication Session
AdminApirevokeConsentSessionsDELETE /oauth2/auth/sessions/consentRevokes Consent Sessions of a Subject for a Specific OAuth 2.0 Client
AdminApiupdateJsonWebKeyPUT /keys/{set}/{kid}Update a JSON Web Key
AdminApiupdateJsonWebKeySetPUT /keys/{set}Update a JSON Web Key Set
AdminApiupdateOAuth2ClientPUT /clients/{id}Update an OAuth 2.0 Client
PublicApidisconnectUserGET /oauth2/sessions/logoutOpenID Connect Front-Backchannel Enabled Logout
PublicApidiscoverOpenIDConfigurationGET /.well-known/openid-configurationOpenID Connect Discovery
PublicApiisInstanceReadyGET /health/readyCheck Readiness Status
PublicApioauth2TokenPOST /oauth2/tokenThe OAuth 2.0 Token Endpoint
PublicApioauthAuthGET /oauth2/authThe OAuth 2.0 Authorize Endpoint
PublicApirevokeOAuth2TokenPOST /oauth2/revokeRevoke OAuth2 Tokens
PublicApiuserinfoGET /userinfoOpenID Connect Userinfo
PublicApiwellKnownGET /.well-known/jwks.jsonJSON Web Keys Discovery

Documentation For Models

Documentation For Authorization

basic

  • Type: HTTP Basic authentication

oauth2

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

Author

Libraries

openapi.api