Welcome to the ORY Hydra HTTP API documentation. You will find documentation for all HTTP APIs here. Keep in mind that this document reflects the latest branch, always. Support for versioned documentation is coming in the future.
This API client was generated by the swagger-codegen project. By using the swagger-spec from a remote server, you can easily generate an API client.
- API version: Latest
- Package version: 1.0.0
- Build package: io.swagger.codegen.languages.GoClientCodegen For more information, please visit https://www.ory.sh
Put the package under your project folder and add the following in import:
"./swagger"
All URIs are relative to http://localhost
| Class | Method | HTTP request | Description |
|---|---|---|---|
| HealthApi | IsInstanceAlive | Get /health/alive | Check the Alive Status |
| HealthApi | IsInstanceReady | Get /health/ready | Check the Readiness Status |
| JsonWebKeyApi | CreateJsonWebKeySet | Post /keys/{set} | Generate a new JSON Web Key |
| JsonWebKeyApi | DeleteJsonWebKey | Delete /keys/{set}/{kid} | Delete a JSON Web Key |
| JsonWebKeyApi | DeleteJsonWebKeySet | Delete /keys/{set} | Delete a JSON Web Key Set |
| JsonWebKeyApi | GetJsonWebKey | Get /keys/{set}/{kid} | Retrieve a JSON Web Key |
| JsonWebKeyApi | GetJsonWebKeySet | Get /keys/{set} | Retrieve a JSON Web Key Set |
| JsonWebKeyApi | UpdateJsonWebKey | Put /keys/{set}/{kid} | Update a JSON Web Key |
| JsonWebKeyApi | UpdateJsonWebKeySet | Put /keys/{set} | Update a JSON Web Key Set |
| MetricsApi | GetPrometheusMetrics | Get /metrics/prometheus | Retrieve Prometheus metrics |
| OAuth2Api | AcceptConsentRequest | Put /oauth2/auth/requests/consent/{challenge}/accept | Accept an consent request |
| OAuth2Api | AcceptLoginRequest | Put /oauth2/auth/requests/login/{challenge}/accept | Accept an login request |
| OAuth2Api | CreateOAuth2Client | Post /clients | Create an OAuth 2.0 client |
| OAuth2Api | DeleteOAuth2Client | Delete /clients/{id} | Deletes an OAuth 2.0 Client |
| OAuth2Api | FlushInactiveOAuth2Tokens | Post /oauth2/flush | Flush Expired OAuth2 Access Tokens |
| OAuth2Api | GetConsentRequest | Get /oauth2/auth/requests/consent/{challenge} | Get consent request information |
| OAuth2Api | GetLoginRequest | Get /oauth2/auth/requests/login/{challenge} | Get an login request |
| OAuth2Api | GetOAuth2Client | Get /clients/{id} | Get an OAuth 2.0 Client. |
| OAuth2Api | GetWellKnown | Get /.well-known/openid-configuration | Server well known configuration |
| OAuth2Api | IntrospectOAuth2Token | Post /oauth2/introspect | Introspect OAuth2 tokens |
| OAuth2Api | ListOAuth2Clients | Get /clients | List OAuth 2.0 Clients |
| OAuth2Api | OauthAuth | Get /oauth2/auth | The OAuth 2.0 authorize endpoint |
| OAuth2Api | OauthToken | Post /oauth2/token | The OAuth 2.0 token endpoint |
| OAuth2Api | RejectConsentRequest | Put /oauth2/auth/requests/consent/{challenge}/reject | Reject an consent request |
| OAuth2Api | RejectLoginRequest | Put /oauth2/auth/requests/login/{challenge}/reject | Reject an logout request |
| OAuth2Api | RevokeOAuth2Token | Post /oauth2/revoke | Revoke OAuth2 tokens |
| OAuth2Api | UpdateOAuth2Client | Put /clients/{id} | Update an OAuth 2.0 Client |
| OAuth2Api | Userinfo | Post /userinfo | OpenID Connect Userinfo |
| OAuth2Api | WellKnown | Get /.well-known/jwks.json | Get Well-Known JSON Web Keys |
| VersionApi | GetVersion | Get /version | Get the version of Hydra |
- AcceptConsentRequest
- AcceptLoginRequest
- AuthenticationSession
- CompletedRequest
- ConsentRequest
- ConsentRequestSession
- FlushInactiveOAuth2TokensRequest
- Handler
- HealthNotReadyStatus
- HealthStatus
- InlineResponse401
- JoseWebKeySetRequest
- JsonWebKey
- JsonWebKeySet
- JsonWebKeySetGeneratorRequest
- KeyGenerator
- LoginRequest
- Manager
- OAuth2Client
- OAuth2TokenIntrospection
- OauthTokenResponse
- OpenIdConnectContext
- RawMessage
- RejectRequest
- SwaggerFlushInactiveAccessTokens
- SwaggerJsonWebKeyQuery
- SwaggerJwkCreateSet
- SwaggerJwkSetQuery
- SwaggerJwkUpdateSet
- SwaggerJwkUpdateSetKey
- SwaggerOAuthIntrospectionRequest
- SwaggerRevokeOAuth2TokenParameters
- UserinfoResponse
- Version
- WellKnown
- Writer
- Type: HTTP basic authentication
- Type: OAuth
- Flow: accessCode
- Authorization URL: https://your-hydra-instance.com/oauth2/auth
- Scopes:
- offline: A scope required when requesting refresh tokens
- openid: Request an OpenID Connect ID Token