# \PublicApi All URIs are relative to *http://localhost* Method | HTTP request | Description ------------- | ------------- | ------------- [**disconnect_user**](PublicApi.md#disconnect_user) | **get** /oauth2/sessions/logout | OpenID Connect Front-Backchannel enabled Logout [**discover_open_id_configuration**](PublicApi.md#discover_open_id_configuration) | **get** /.well-known/openid-configuration | OpenID Connect Discovery [**is_instance_ready**](PublicApi.md#is_instance_ready) | **get** /health/ready | Check readiness status [**oauth2_token**](PublicApi.md#oauth2_token) | **post** /oauth2/token | The OAuth 2.0 token endpoint [**oauth_auth**](PublicApi.md#oauth_auth) | **get** /oauth2/auth | The OAuth 2.0 authorize endpoint [**revoke_o_auth2_token**](PublicApi.md#revoke_o_auth2_token) | **post** /oauth2/revoke | Revoke OAuth2 tokens [**userinfo**](PublicApi.md#userinfo) | **get** /userinfo | OpenID Connect Userinfo [**well_known**](PublicApi.md#well_known) | **get** /.well-known/jwks.json | JSON Web Keys Discovery ## disconnect_user > disconnect_user() 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.net/specs/openid-connect-frontchannel-1_0.html https://openid.net/specs/openid-connect-backchannel-1_0.html ### Parameters This endpoint does not need any parameter. ### Return type (empty response body) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: Not defined [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## discover_open_id_configuration > crate::models::WellKnown discover_open_id_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/ ### Parameters This endpoint does not need any parameter. ### Return type [**crate::models::WellKnown**](wellKnown.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## is_instance_ready > crate::models::HealthStatus is_instance_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. ### Parameters This endpoint does not need any parameter. ### Return type [**crate::models::HealthStatus**](healthStatus.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## oauth2_token > crate::models::Oauth2TokenResponse oauth2_token(grant_type, code, refresh_token, redirect_uri, client_id) The OAuth 2.0 token endpoint The client makes a request to the token endpoint by sending the following parameters using the \"application/x-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.net/code/ > > Do not the the Hydra SDK does not implement this endpoint properly. Use one of the libraries listed above! ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **grant_type** | **String** | | [required] | **code** | Option<**String**> | | | **refresh_token** | Option<**String**> | | | **redirect_uri** | Option<**String**> | | | **client_id** | Option<**String**> | | | ### Return type [**crate::models::Oauth2TokenResponse**](oauth2TokenResponse.md) ### Authorization [basic](../README.md#basic), [oauth2](../README.md#oauth2) ### HTTP request headers - **Content-Type**: application/x-www-form-urlencoded - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## oauth_auth > oauth_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 ### Parameters This endpoint does not need any parameter. ### Return type (empty response body) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## revoke_o_auth2_token > revoke_o_auth2_token(token) 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. ### Parameters Name | Type | Description | Required | Notes ------------- | ------------- | ------------- | ------------- | ------------- **token** | **String** | | [required] | ### Return type (empty response body) ### Authorization [basic](../README.md#basic), [oauth2](../README.md#oauth2) ### HTTP request headers - **Content-Type**: application/x-www-form-urlencoded - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## userinfo > crate::models::UserinfoResponse 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](http://openid.net/specs/openid-connect-core-1_0.html#UserInfo). ### Parameters This endpoint does not need any parameter. ### Return type [**crate::models::UserinfoResponse**](userinfoResponse.md) ### Authorization [oauth2](../README.md#oauth2) ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md) ## well_known > crate::models::JsonWebKeySet well_known() 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](https://github.com/auth0/node-jwks-rsa) among others. ### Parameters This endpoint does not need any parameter. ### Return type [**crate::models::JsonWebKeySet**](JSONWebKeySet.md) ### Authorization No authorization required ### HTTP request headers - **Content-Type**: Not defined - **Accept**: application/json [[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)