ory_hydra_client 1.11.5 copy "ory_hydra_client: ^1.11.5" to clipboard
ory_hydra_client: ^1.11.5 copied to clipboard

outdated

OpenAPI API client

ory_hydra_client #

Documentation for all of Ory Oathkeeper's APIs.

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

  • API version: v1.11.5
  • Build package: org.openapitools.codegen.languages.DartDioClientCodegen

Requirements #

Dart 2.7.0 or later OR Flutter 1.12 or later

Installation & Usage #

Github #

If this Dart package is published to Github, please include the following in pubspec.yaml

name: ory_hydra_client
version: 1.11.5
description: OpenAPI API client
dependencies:
  ory_hydra_client:
    git: https://github.com/ory/sdk.git
      version: 'any'

Local #

To use the package in your local drive, please include the following in pubspec.yaml

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

Getting Started #

Please follow the installation procedure and then run the following:

import 'package:ory_hydra_client/api.dart';


final api = AdminApi();
final consentChallenge = consentChallenge_example; // String | 
final acceptConsentRequest = AcceptConsentRequest(); // AcceptConsentRequest | 

try {
    final response = await api.acceptConsentRequest(consentChallenge, acceptConsentRequest);
    print(response);
} catch (e) {
    print("Exception when calling AdminApi->acceptConsentRequest: $e\n");
}

Documentation for API Endpoints #

All URIs are relative to http://localhost

Class Method HTTP request Description
AdminApi acceptConsentRequest PUT /oauth2/auth/requests/consent/accept Accept a Consent Request
AdminApi acceptLoginRequest PUT /oauth2/auth/requests/login/accept Accept a Login Request
AdminApi acceptLogoutRequest PUT /oauth2/auth/requests/logout/accept Accept a Logout Request
AdminApi createJsonWebKeySet POST /keys/{set} Generate a New JSON Web Key
AdminApi createOAuth2Client POST /clients Create an OAuth 2.0 Client
AdminApi deleteJsonWebKey DELETE /keys/{set}/{kid} Delete a JSON Web Key
AdminApi deleteJsonWebKeySet DELETE /keys/{set} Delete a JSON Web Key Set
AdminApi deleteOAuth2Client DELETE /clients/{id} Deletes an OAuth 2.0 Client
AdminApi deleteOAuth2Token DELETE /oauth2/tokens Delete OAuth2 Access Tokens from a Client
AdminApi deleteTrustedJwtGrantIssuer DELETE /trust/grants/jwt-bearer/issuers/{id} Delete a Trusted OAuth2 JWT Bearer Grant Type Issuer
AdminApi flushInactiveOAuth2Tokens POST /oauth2/flush Flush Expired OAuth2 Access Tokens
AdminApi getConsentRequest GET /oauth2/auth/requests/consent Get Consent Request Information
AdminApi getJsonWebKey GET /keys/{set}/{kid} Fetch a JSON Web Key
AdminApi getJsonWebKeySet GET /keys/{set} Retrieve a JSON Web Key Set
AdminApi getLoginRequest GET /oauth2/auth/requests/login Get a Login Request
AdminApi getLogoutRequest GET /oauth2/auth/requests/logout Get a Logout Request
AdminApi getOAuth2Client GET /clients/{id} Get an OAuth 2.0 Client
AdminApi getTrustedJwtGrantIssuer GET /trust/grants/jwt-bearer/issuers/{id} Get a Trusted OAuth2 JWT Bearer Grant Type Issuer
AdminApi introspectOAuth2Token POST /oauth2/introspect Introspect OAuth2 Tokens
AdminApi listOAuth2Clients GET /clients List OAuth 2.0 Clients
AdminApi listSubjectConsentSessions GET /oauth2/auth/sessions/consent Lists All Consent Sessions of a Subject
AdminApi listTrustedJwtGrantIssuers GET /trust/grants/jwt-bearer/issuers List Trusted OAuth2 JWT Bearer Grant Type Issuers
AdminApi patchOAuth2Client PATCH /clients/{id} Patch an OAuth 2.0 Client
AdminApi rejectConsentRequest PUT /oauth2/auth/requests/consent/reject Reject a Consent Request
AdminApi rejectLoginRequest PUT /oauth2/auth/requests/login/reject Reject a Login Request
AdminApi rejectLogoutRequest PUT /oauth2/auth/requests/logout/reject Reject a Logout Request
AdminApi revokeAuthenticationSession DELETE /oauth2/auth/sessions/login Invalidates All Login Sessions of a Certain User Invalidates a Subject's Authentication Session
AdminApi revokeConsentSessions DELETE /oauth2/auth/sessions/consent Revokes Consent Sessions of a Subject for a Specific OAuth 2.0 Client
AdminApi trustJwtGrantIssuer POST /trust/grants/jwt-bearer/issuers Trust an OAuth2 JWT Bearer Grant Type Issuer
AdminApi updateJsonWebKey PUT /keys/{set}/{kid} Update a JSON Web Key
AdminApi updateJsonWebKeySet PUT /keys/{set} Update a JSON Web Key Set
AdminApi updateOAuth2Client PUT /clients/{id} Update an OAuth 2.0 Client
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
PublicApi disconnectUser GET /oauth2/sessions/logout OpenID Connect Front-Backchannel Enabled Logout
PublicApi discoverOpenIDConfiguration GET /.well-known/openid-configuration OpenID Connect Discovery
PublicApi dynamicClientRegistrationCreateOAuth2Client POST /connect/register Register an OAuth 2.0 Client using the OpenID / OAuth2 Dynamic Client Registration Management Protocol
PublicApi dynamicClientRegistrationDeleteOAuth2Client DELETE /connect/register/{id} Deletes an OAuth 2.0 Client using the OpenID / OAuth2 Dynamic Client Registration Management Protocol
PublicApi dynamicClientRegistrationGetOAuth2Client GET /connect/register/{id} Get an OAuth 2.0 Client using the OpenID / OAuth2 Dynamic Client Registration Management Protocol
PublicApi dynamicClientRegistrationUpdateOAuth2Client PUT /connect/register/{id} Update an OAuth 2.0 Client using the OpenID / OAuth2 Dynamic Client Registration Management Protocol
PublicApi oauth2Token POST /oauth2/token The OAuth 2.0 Token Endpoint
PublicApi oauthAuth GET /oauth2/auth The OAuth 2.0 Authorize Endpoint
PublicApi revokeOAuth2Token POST /oauth2/revoke Revoke OAuth2 Tokens
PublicApi userinfo GET /userinfo OpenID Connect Userinfo
PublicApi wellKnown GET /.well-known/jwks.json JSON 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 #

hi@ory.sh