Package sh.ory.hydra.api

Class PublicApi

  • public class PublicApi
extends Object

    • Constructor Detail

      • PublicApi

        public PublicApi()

      • PublicApi

        public PublicApi​(ApiClient apiClient)

    • Method Detail

      • getApiClient

        public ApiClient getApiClient()

      • setApiClient

        public void setApiClient​(ApiClient apiClient)

      • disconnectUserCall

        public okhttp3.Call disconnectUserCall​(ApiCallback _callback)
                                throws ApiException
        Build call for disconnectUser
        Parameters:
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        302 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -

      • disconnectUser

        public void disconnectUser()
                    throws ApiException
        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
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        302 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -

      • disconnectUserWithHttpInfo

        public ApiResponse<Void> disconnectUserWithHttpInfo()
                                             throws ApiException
        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
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        302 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -

      • disconnectUserAsync

        public okhttp3.Call disconnectUserAsync​(ApiCallback<Void> _callback)
                                 throws ApiException
        OpenID Connect Front-Backchannel Enabled Logout (asynchronously) 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:
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        302 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -

      • discoverOpenIDConfigurationCall

        public okhttp3.Call discoverOpenIDConfigurationCall​(ApiCallback _callback)
                                             throws ApiException
        Build call for discoverOpenIDConfiguration
        Parameters:
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 wellKnown -
        401 genericError -
        500 genericError -

      • discoverOpenIDConfiguration

        public WellKnown discoverOpenIDConfiguration()
                                      throws ApiException
        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/
        Returns:
        WellKnown
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 wellKnown -
        401 genericError -
        500 genericError -

      • discoverOpenIDConfigurationWithHttpInfo

        public ApiResponse<WellKnown> discoverOpenIDConfigurationWithHttpInfo()
                                                               throws ApiException
        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/
        Returns:
        ApiResponse<WellKnown>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 wellKnown -
        401 genericError -
        500 genericError -

      • discoverOpenIDConfigurationAsync

        public okhttp3.Call discoverOpenIDConfigurationAsync​(ApiCallback<WellKnown> _callback)
                                              throws ApiException
        OpenID Connect Discovery (asynchronously) 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:
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 wellKnown -
        401 genericError -
        500 genericError -

      • isInstanceReadyCall

        public okhttp3.Call isInstanceReadyCall​(ApiCallback _callback)
                                 throws ApiException
        Build call for isInstanceReady
        Parameters:
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 healthStatus -
        503 healthNotReadyStatus -

      • isInstanceReady

        public HealthStatus isInstanceReady()
                             throws ApiException
        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.
        Returns:
        HealthStatus
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 healthStatus -
        503 healthNotReadyStatus -

      • isInstanceReadyWithHttpInfo

        public ApiResponse<HealthStatus> isInstanceReadyWithHttpInfo()
                                                      throws ApiException
        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.
        Returns:
        ApiResponse<HealthStatus>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 healthStatus -
        503 healthNotReadyStatus -

      • isInstanceReadyAsync

        public okhttp3.Call isInstanceReadyAsync​(ApiCallback<HealthStatus> _callback)
                                  throws ApiException
        Check Readiness Status (asynchronously) 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:
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 healthStatus -
        503 healthNotReadyStatus -

      • oauth2TokenCall

        public okhttp3.Call oauth2TokenCall​(String grantType,
                                    String code,
                                    String refreshToken,
                                    String redirectUri,
                                    String clientId,
                                    ApiCallback _callback)
                             throws ApiException
        Build call for oauth2Token
        Parameters:
        grantType - (required)
        code - (optional)
        refreshToken - (optional)
        redirectUri - (optional)
        clientId - (optional)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 oauth2TokenResponse -
        400 genericError -
        401 genericError -
        500 genericError -

      • oauth2Token

        public Oauth2TokenResponse oauth2Token​(String grantType,
                                       String code,
                                       String refreshToken,
                                       String redirectUri,
                                       String clientId)
                                throws ApiException
        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 note that Hydra SDK does not implement this endpoint properly. Use one of the libraries listed above!
        Parameters:
        grantType - (required)
        code - (optional)
        refreshToken - (optional)
        redirectUri - (optional)
        clientId - (optional)
        Returns:
        Oauth2TokenResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 oauth2TokenResponse -
        400 genericError -
        401 genericError -
        500 genericError -

      • oauth2TokenWithHttpInfo

        public ApiResponse<Oauth2TokenResponse> oauth2TokenWithHttpInfo​(String grantType,
                                                                String code,
                                                                String refreshToken,
                                                                String redirectUri,
                                                                String clientId)
                                                         throws ApiException
        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 note that Hydra SDK does not implement this endpoint properly. Use one of the libraries listed above!
        Parameters:
        grantType - (required)
        code - (optional)
        refreshToken - (optional)
        redirectUri - (optional)
        clientId - (optional)
        Returns:
        ApiResponse<Oauth2TokenResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 oauth2TokenResponse -
        400 genericError -
        401 genericError -
        500 genericError -

      • oauth2TokenAsync

        public okhttp3.Call oauth2TokenAsync​(String grantType,
                                     String code,
                                     String refreshToken,
                                     String redirectUri,
                                     String clientId,
                                     ApiCallback<Oauth2TokenResponse> _callback)
                              throws ApiException
        The OAuth 2.0 Token Endpoint (asynchronously) 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 note that Hydra SDK does not implement this endpoint properly. Use one of the libraries listed above!
        Parameters:
        grantType - (required)
        code - (optional)
        refreshToken - (optional)
        redirectUri - (optional)
        clientId - (optional)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 oauth2TokenResponse -
        400 genericError -
        401 genericError -
        500 genericError -

      • oauthAuthCall

        public okhttp3.Call oauthAuthCall​(ApiCallback _callback)
                           throws ApiException
        Build call for oauthAuth
        Parameters:
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        302 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
        401 genericError -
        500 genericError -

      • oauthAuth

        public void oauthAuth()
               throws ApiException
        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
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        302 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
        401 genericError -
        500 genericError -

      • oauthAuthWithHttpInfo

        public ApiResponse<Void> oauthAuthWithHttpInfo()
                                        throws ApiException
        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
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        302 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
        401 genericError -
        500 genericError -

      • oauthAuthAsync

        public okhttp3.Call oauthAuthAsync​(ApiCallback<Void> _callback)
                            throws ApiException
        The OAuth 2.0 Authorize Endpoint (asynchronously) 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:
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        302 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
        401 genericError -
        500 genericError -

      • revokeOAuth2TokenCall

        public okhttp3.Call revokeOAuth2TokenCall​(String token,
                                          ApiCallback _callback)
                                   throws ApiException
        Build call for revokeOAuth2Token
        Parameters:
        token - (required)
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
        401 genericError -
        500 genericError -

      • revokeOAuth2Token

        public void revokeOAuth2Token​(String token)
                       throws ApiException
        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:
        token - (required)
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
        401 genericError -
        500 genericError -

      • revokeOAuth2TokenWithHttpInfo

        public ApiResponse<Void> revokeOAuth2TokenWithHttpInfo​(String token)
                                                throws ApiException
        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:
        token - (required)
        Returns:
        ApiResponse<Void>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
        401 genericError -
        500 genericError -

      • revokeOAuth2TokenAsync

        public okhttp3.Call revokeOAuth2TokenAsync​(String token,
                                           ApiCallback<Void> _callback)
                                    throws ApiException
        Revoke OAuth2 Tokens (asynchronously) 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:
        token - (required)
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201. -
        401 genericError -
        500 genericError -

      • userinfoCall

        public okhttp3.Call userinfoCall​(ApiCallback _callback)
                          throws ApiException
        Build call for userinfo
        Parameters:
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 userinfoResponse -
        401 genericError -
        500 genericError -

      • userinfo

        public UserinfoResponse userinfo()
                          throws ApiException
        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).
        Returns:
        UserinfoResponse
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 userinfoResponse -
        401 genericError -
        500 genericError -

      • userinfoWithHttpInfo

        public ApiResponse<UserinfoResponse> userinfoWithHttpInfo()
                                                   throws ApiException
        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).
        Returns:
        ApiResponse<UserinfoResponse>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 userinfoResponse -
        401 genericError -
        500 genericError -

      • userinfoAsync

        public okhttp3.Call userinfoAsync​(ApiCallback<UserinfoResponse> _callback)
                           throws ApiException
        OpenID Connect Userinfo (asynchronously) 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:
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 userinfoResponse -
        401 genericError -
        500 genericError -

      • wellKnownCall

        public okhttp3.Call wellKnownCall​(ApiCallback _callback)
                           throws ApiException
        Build call for wellKnown
        Parameters:
        _callback - Callback for upload/download progress
        Returns:
        Call to execute
        Throws:
        ApiException - If fail to serialize the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 JSONWebKeySet -
        500 genericError -

      • wellKnown

        public JSONWebKeySet wellKnown()
                        throws ApiException
        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.
        Returns:
        JSONWebKeySet
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 JSONWebKeySet -
        500 genericError -

      • wellKnownWithHttpInfo

        public ApiResponse<JSONWebKeySet> wellKnownWithHttpInfo()
                                                 throws ApiException
        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.
        Returns:
        ApiResponse<JSONWebKeySet>
        Throws:
        ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body
        Http Response Details:
        Status Code Description Response Headers
        200 JSONWebKeySet -
        500 genericError -

      • wellKnownAsync

        public okhttp3.Call wellKnownAsync​(ApiCallback<JSONWebKeySet> _callback)
                            throws ApiException
        JSON Web Keys Discovery (asynchronously) 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:
        _callback - The callback to be executed when the API call finishes
        Returns:
        The request call
        Throws:
        ApiException - If fail to process the API call, e.g. serializing the request body object
        Http Response Details:
        Status Code Description Response Headers
        200 JSONWebKeySet -
        500 genericError -