ory_hydra_client

Documentation for all of Ory Hydra's APIs.

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

  • API version: v1.11.8
  • 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.8
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

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
AdminApideleteTrustedJwtGrantIssuerDELETE /trust/grants/jwt-bearer/issuers/{id}Delete a Trusted OAuth2 JWT Bearer Grant Type Issuer
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
AdminApigetTrustedJwtGrantIssuerGET /trust/grants/jwt-bearer/issuers/{id}Get a Trusted OAuth2 JWT Bearer Grant Type Issuer
AdminApiintrospectOAuth2TokenPOST /oauth2/introspectIntrospect OAuth2 Tokens
AdminApilistOAuth2ClientsGET /clientsList OAuth 2.0 Clients
AdminApilistSubjectConsentSessionsGET /oauth2/auth/sessions/consentLists All Consent Sessions of a Subject
AdminApilistTrustedJwtGrantIssuersGET /trust/grants/jwt-bearer/issuersList Trusted OAuth2 JWT Bearer Grant Type Issuers
AdminApipatchOAuth2ClientPATCH /clients/{id}Patch an OAuth 2.0 Client
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
AdminApitrustJwtGrantIssuerPOST /trust/grants/jwt-bearer/issuersTrust an OAuth2 JWT Bearer Grant Type Issuer
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
MetadataApigetVersionGET /versionReturn Running Software Version.
MetadataApiisAliveGET /health/aliveCheck HTTP Server Status
MetadataApiisReadyGET /health/readyCheck HTTP Server and Database Status
PublicApidisconnectUserGET /oauth2/sessions/logoutOpenID Connect Front-Backchannel Enabled Logout
PublicApidiscoverOpenIDConfigurationGET /.well-known/openid-configurationOpenID Connect Discovery
PublicApidynamicClientRegistrationCreateOAuth2ClientPOST /connect/registerRegister an OAuth 2.0 Client using the OpenID / OAuth2 Dynamic Client Registration Management Protocol
PublicApidynamicClientRegistrationDeleteOAuth2ClientDELETE /connect/register/{id}Deletes an OAuth 2.0 Client using the OpenID / OAuth2 Dynamic Client Registration Management Protocol
PublicApidynamicClientRegistrationGetOAuth2ClientGET /connect/register/{id}Get an OAuth 2.0 Client using the OpenID / OAuth2 Dynamic Client Registration Management Protocol
PublicApidynamicClientRegistrationUpdateOAuth2ClientPUT /connect/register/{id}Update an OAuth 2.0 Client using the OpenID / OAuth2 Dynamic Client Registration Management Protocol
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

hi@ory.sh

Libraries

accept_login_request
accept_login_request.g
admin_api
api_key_auth
api_util
auth
basic_auth
completed_request
completed_request.g
flush_inactive_o_auth2_tokens_request
flush_inactive_o_auth2_tokens_request.g
generic_error
generic_error.g
health_not_ready_status
health_not_ready_status.g
health_status
health_status.g
inline_response200
inline_response200.g
inline_response503
inline_response503.g
inline_response2001
inline_response2001.g
json_error
json_error.g
json_web_key
json_web_key.g
json_web_key_set
json_web_key_set.g
json_web_key_set_generator_request
json_web_key_set_generator_request.g
login_request
login_request.g
logout_request
logout_request.g
metadata_api
o_auth2_client
o_auth2_client.g
o_auth2_token_introspection
o_auth2_token_introspection.g
oauth
oauth2_token_response
oauth2_token_response.g
oauth_token_response
oauth_token_response.g
open_id_connect_context
open_id_connect_context.g
ory_hydra_client.api
patch_document
patch_document.g
public_api
refresh_token_hook_request
refresh_token_hook_request.g
refresh_token_hook_response
refresh_token_hook_response.g
reject_request
reject_request.g
request_was_handled_response
request_was_handled_response.g
serializers
serializers.g
trust_jwt_grant_issuer_body
trust_jwt_grant_issuer_body.g
trusted_json_web_key
trusted_json_web_key.g
trusted_jwt_grant_issuer
trusted_jwt_grant_issuer.g
userinfo_response
userinfo_response.g
version
version.g
well_known
well_known.g