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 | GetInstanceStatus | Get /health/status | Check the Health 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 |
| OAuth2Api | AcceptOAuth2ConsentRequest | Patch /oauth2/consent/requests/{id}/accept | Accept a consent 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 | GetOAuth2Client | Get /clients/{id} | Get an OAuth 2.0 Client. |
| OAuth2Api | GetOAuth2ConsentRequest | Get /oauth2/consent/requests/{id} | Receive consent request information |
| 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 | RejectOAuth2ConsentRequest | Patch /oauth2/consent/requests/{id}/reject | Reject a consent 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 |
| PolicyApi | CreatePolicy | Post /policies | Create an Access Control Policy |
| PolicyApi | DeletePolicy | Delete /policies/{id} | Delete an Access Control Policy |
| PolicyApi | GetPolicy | Get /policies/{id} | Get an Access Control Policy |
| PolicyApi | ListPolicies | Get /policies | List Access Control Policies |
| PolicyApi | UpdatePolicy | Put /policies/{id} | Update an Access Control Polic |
| WardenApi | AddMembersToGroup | Post /warden/groups/{id}/members | Add members to a group |
| WardenApi | CreateGroup | Post /warden/groups | Create a group |
| WardenApi | DeleteGroup | Delete /warden/groups/{id} | Delete a group by id |
| WardenApi | DoesWardenAllowAccessRequest | Post /warden/allowed | Check if an access request is valid (without providing an access token) |
| WardenApi | DoesWardenAllowTokenAccessRequest | Post /warden/token/allowed | Check if an access request is valid (providing an access token) |
| WardenApi | GetGroup | Get /warden/groups/{id} | Get a group by id |
| WardenApi | ListGroups | Get /warden/groups | List groups |
| WardenApi | RemoveMembersFromGroup | Delete /warden/groups/{id}/members | Remove members from a group |
- ConsentRequest
- ConsentRequestAcceptance
- ConsentRequestManager
- ConsentRequestRejection
- Context
- Firewall
- FlushInactiveOAuth2TokensRequest
- Group
- GroupMembers
- Handler
- InlineResponse200
- InlineResponse401
- JoseWebKeySetRequest
- JsonWebKey
- JsonWebKeySet
- JsonWebKeySetGeneratorRequest
- KeyGenerator
- Manager
- OAuth2Client
- OAuth2ConsentRequest
- OAuth2TokenIntrospection
- OauthTokenResponse
- Policy
- PolicyConditions
- RawMessage
- SwaggerAcceptConsentRequest
- SwaggerCreatePolicyParameters
- SwaggerDoesWardenAllowAccessRequestParameters
- SwaggerDoesWardenAllowTokenAccessRequestParameters
- SwaggerFlushInactiveAccessTokens
- SwaggerGetPolicyParameters
- SwaggerJsonWebKeyQuery
- SwaggerJwkCreateSet
- SwaggerJwkSetQuery
- SwaggerJwkUpdateSet
- SwaggerJwkUpdateSetKey
- SwaggerListPolicyParameters
- SwaggerListPolicyResponse
- SwaggerOAuthConsentRequestPayload
- SwaggerOAuthIntrospectionRequest
- SwaggerRejectConsentRequest
- SwaggerRevokeOAuth2TokenParameters
- SwaggerUpdatePolicyParameters
- TokenAllowedRequest
- UserinfoResponse
- WardenAccessRequest
- WardenAccessRequestResponse
- WardenTokenAccessRequest
- WardenTokenAccessRequestResponse
- WellKnown
- Writer
- Type: HTTP basic authentication
- Type: OAuth
- Flow: accessCode
- Authorization URL: https://your-hydra-instance.com/oauth2/auth
- Scopes:
- hydra.clients: A scope required to manage OAuth 2.0 Clients
- hydra.consent: A scope required to fetch and modify consent requests
- hydra.keys.create: A scope required to create JSON Web Keys
- hydra.keys.delete: A scope required to delete JSON Web Keys
- hydra.keys.get: A scope required to fetch JSON Web Keys
- hydra.keys.update: A scope required to get JSON Web Keys
- hydra.policies: A scope required to manage access control policies
- hydra.warden: A scope required to make access control inquiries
- hydra.warden.groups: A scope required to manage warden groups
- offline: A scope required when requesting refresh tokens
- openid: Request an OpenID Connect ID Token