ory_hydra_client (EXPERIMENTAL)

Documentation for all of Ory Hydra's APIs.

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

• API version: v2.2.0
• Build package: org.openapitools.codegen.languages.DartDioClientCodegen

Requirements

• Dart 2.15.0+ or Flutter 2.8.0+
• Dio 5.0.0+ (https://pub.dev/packages/dio)

Installation & Usage

pub.dev

To use the package from pub.dev, please include the following in pubspec.yaml

dependencies:
  ory_hydra_client: 2.2.0

Github

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

dependencies:
  ory_hydra_client:
    git:
      url: https://github.com/ory/sdk.git
      #ref: main

Local development

To use the package from 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/ory_hydra_client.dart';


final api = OryHydraClient().getJwkApi();
final String set_ = set__example; // String | The JSON Web Key Set ID
final CreateJsonWebKeySet createJsonWebKeySet = ; // CreateJsonWebKeySet | 

try {
    final response = await api.createJsonWebKeySet(set_, createJsonWebKeySet);
    print(response);
} catch on DioError (e) {
    print("Exception when calling JwkApi->createJsonWebKeySet: $e\n");
}

Documentation for API Endpoints

All URIs are relative to http://localhost

Documentation For Models

• AcceptOAuth2ConsentRequest
• AcceptOAuth2ConsentRequestSession
• AcceptOAuth2LoginRequest
• CreateJsonWebKeySet
• CreateVerifiableCredentialRequestBody
• CredentialSupportedDraft00
• ErrorOAuth2
• GenericError
• GetVersion200Response
• HealthNotReadyStatus
• HealthStatus
• IntrospectedOAuth2Token
• IsReady200Response
• IsReady503Response
• JsonPatch
• JsonWebKey
• JsonWebKeySet
• OAuth2Client
• OAuth2ClientTokenLifespans
• OAuth2ConsentRequest
• OAuth2ConsentRequestOpenIDConnectContext
• OAuth2ConsentSession
• OAuth2ConsentSessionExpiresAt
• OAuth2LoginRequest
• OAuth2LogoutRequest
• OAuth2RedirectTo
• OAuth2TokenExchange
• OidcConfiguration
• OidcUserInfo
• Pagination
• PaginationHeaders
• RFC6749ErrorJson
• RejectOAuth2Request
• TokenPagination
• TokenPaginationHeaders
• TokenPaginationRequestParameters
• TokenPaginationResponseHeaders
• TrustOAuth2JwtGrantIssuer
• TrustedOAuth2JwtGrantIssuer
• TrustedOAuth2JwtGrantJsonWebKey
• VerifiableCredentialPrimingResponse
• VerifiableCredentialProof
• VerifiableCredentialResponse
• Version

Documentation For Authorization

Authentication schemes defined for the API:

basic

• Type: HTTP basic authentication

bearer

• 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