ORYHydra.API.Public

Operations

Public

disconnectUser

disconnectUser :: ORYHydraRequest DisconnectUser MimeNoContent NoContent MimeNoContent

GET /oauth2/sessions/logout

OpenID Connect Front-Backchannel Enabled Logout

This endpoint initiates and completes user logout at ORY Hydra and initiates OpenID Connect Front-Back-channel logout: https:openid.netspecsopenid-connect-frontchannel-1_0.html https:openid.netspecs/openid-connect-backchannel-1_0.html

data DisconnectUser

Instances

Produces DisconnectUser MimeNoContent

Defined in ORYHydra.API.Public

discoverOpenIDConfiguration

discoverOpenIDConfiguration :: ORYHydraRequest DiscoverOpenIDConfiguration MimeNoContent WellKnown MimeJSON

GET /.well-known/openid-configuration

OpenID Connect Discovery

The well known endpoint an be used to retrieve information for OpenID Connect clients. We encourage you to not roll your own OpenID Connect client but to use an OpenID Connect client library instead. You can learn more on this flow at https://openid.net/specs/openid-connect-discovery-1_0.html . Popular libraries for OpenID Connect clients include oidc-client-js (JavaScript), go-oidc (Golang), and others. For a full list of clients go here: https://openid.net/developers/certified/

data DiscoverOpenIDConfiguration

Instances

Produces DiscoverOpenIDConfiguration MimeJSON

application/json

Defined in ORYHydra.API.Public

isInstanceReady

isInstanceReady :: ORYHydraRequest IsInstanceReady MimeNoContent HealthStatus MimeJSON

GET /health/ready

Check Readiness Status

This endpoint returns a 200 status code when the HTTP server is up running and the environment dependencies (e.g. the database) are responsive as well. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set. Be aware that if you are running multiple nodes of this service, the health status will never refer to the cluster state, only to a single instance.

data IsInstanceReady

Instances

Produces IsInstanceReady MimeJSON

application/json

Defined in ORYHydra.API.Public

oauth2Token

oauth2Token

Arguments

:: Consumes Oauth2Token MimeFormUrlEncoded

=> GrantType

"grantType"

-> ORYHydraRequest Oauth2Token MimeFormUrlEncoded Oauth2TokenResponse MimeJSON

POST /oauth2/token

The OAuth 2.0 Token Endpoint

The client makes a request to the token endpoint by sending the following parameters using the "applicationx-www-form-urlencoded" HTTP request entity-body. > Do not implement a client for this endpoint yourself. Use a library. There are many libraries > available for any programming language. You can find a list of libraries here: https:oauth.netcode/ > > Do note that Hydra SDK does not implement this endpoint properly. Use one of the libraries listed above!

AuthMethod: AuthBasicBasic, AuthOAuthOauth2

data Oauth2Token

Instances

Produces Oauth2Token MimeJSON

application/json

Defined in ORYHydra.API.Public

Consumes Oauth2Token MimeFormUrlEncoded

application/x-www-form-urlencoded

Defined in ORYHydra.API.Public

HasOptionalParam Oauth2Token RefreshToken

Defined in ORYHydra.API.Public

Methods

applyOptionalParam :: ORYHydraRequest Oauth2Token contentType res accept -> RefreshToken -> ORYHydraRequest Oauth2Token contentType res accept

(-&-) :: ORYHydraRequest Oauth2Token contentType res accept -> RefreshToken -> ORYHydraRequest Oauth2Token contentType res accept

HasOptionalParam Oauth2Token RedirectUri

Defined in ORYHydra.API.Public

Methods

applyOptionalParam :: ORYHydraRequest Oauth2Token contentType res accept -> RedirectUri -> ORYHydraRequest Oauth2Token contentType res accept

(-&-) :: ORYHydraRequest Oauth2Token contentType res accept -> RedirectUri -> ORYHydraRequest Oauth2Token contentType res accept

HasOptionalParam Oauth2Token Code

Defined in ORYHydra.API.Public

Methods

applyOptionalParam :: ORYHydraRequest Oauth2Token contentType res accept -> Code -> ORYHydraRequest Oauth2Token contentType res accept

(-&-) :: ORYHydraRequest Oauth2Token contentType res accept -> Code -> ORYHydraRequest Oauth2Token contentType res accept

HasOptionalParam Oauth2Token ClientId

Defined in ORYHydra.API.Public

Methods

applyOptionalParam :: ORYHydraRequest Oauth2Token contentType res accept -> ClientId -> ORYHydraRequest Oauth2Token contentType res accept

(-&-) :: ORYHydraRequest Oauth2Token contentType res accept -> ClientId -> ORYHydraRequest Oauth2Token contentType res accept

oauthAuth

oauthAuth :: ORYHydraRequest OauthAuth MimeNoContent res MimeJSON

GET /oauth2/auth

The OAuth 2.0 Authorize Endpoint

This endpoint is not documented here because you should never use your own implementation to perform OAuth2 flows. OAuth2 is a very popular protocol and a library for your programming language will exists. To learn more about this flow please refer to the specification: https://tools.ietf.org/html/rfc6749

Note: Has Produces instances, but no response schema

data OauthAuth

Instances

Produces OauthAuth MimeJSON

application/json

Defined in ORYHydra.API.Public

revokeOAuth2Token

revokeOAuth2Token

Arguments

:: Consumes RevokeOAuth2Token MimeFormUrlEncoded

=> Token

"token"

-> ORYHydraRequest RevokeOAuth2Token MimeFormUrlEncoded res MimeJSON

POST /oauth2/revoke

Revoke OAuth2 Tokens

Revoking a token (both access and refresh) means that the tokens will be invalid. A revoked access token can no longer be used to make access requests, and a revoked refresh token can no longer be used to refresh an access token. Revoking a refresh token also invalidates the access token that was created with it. A token may only be revoked by the client the token was generated for.

AuthMethod: AuthBasicBasic, AuthOAuthOauth2

Note: Has Produces instances, but no response schema

data RevokeOAuth2Token

Instances

Produces RevokeOAuth2Token MimeJSON

application/json

Defined in ORYHydra.API.Public

Consumes RevokeOAuth2Token MimeFormUrlEncoded

application/x-www-form-urlencoded

Defined in ORYHydra.API.Public

userinfo

userinfo :: ORYHydraRequest Userinfo MimeNoContent UserinfoResponse MimeJSON

GET /userinfo

OpenID Connect Userinfo

This endpoint returns the payload of the ID Token, including the idTokenExtra values, of the provided OAuth 2.0 Access Token. For more information please refer to the spec.

AuthMethod: AuthOAuthOauth2

data Userinfo

Instances

Produces Userinfo MimeJSON

application/json

Defined in ORYHydra.API.Public

wellKnown0

wellKnown0 :: ORYHydraRequest WellKnown0 MimeNoContent JSONWebKeySet MimeJSON

GET /.well-known/jwks.json

JSON Web Keys Discovery

This endpoint returns JSON Web Keys to be used as public keys for verifying OpenID Connect ID Tokens and, if enabled, OAuth 2.0 JWT Access Tokens. This endpoint can be used with client libraries like node-jwks-rsa among others.

data WellKnown0

Instances

Produces WellKnown0 MimeJSON

application/json

Defined in ORYHydra.API.Public