java.lang.Object
- sh.ory.hydra.api.AdminApi

```
public class AdminApi
extends Object
```

Constructor Summary

Constructors
Constructor Description

AdminApi()

AdminApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
`CompletedRequest`	`acceptConsentRequest(String consentChallenge, AcceptConsentRequest body)`	Accept a Consent Request When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider to authenticate the subject and then tell ORY Hydra now about it.
`okhttp3.Call`	`acceptConsentRequestAsync(String consentChallenge, AcceptConsentRequest body, ApiCallback<CompletedRequest> _callback)`	Accept a Consent Request (asynchronously) When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider to authenticate the subject and then tell ORY Hydra now about it.
`okhttp3.Call`	`acceptConsentRequestCall(String consentChallenge, AcceptConsentRequest body, ApiCallback _callback)`	Build call for acceptConsentRequest
`ApiResponse<CompletedRequest>`	`acceptConsentRequestWithHttpInfo(String consentChallenge, AcceptConsentRequest body)`	Accept a Consent Request When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider to authenticate the subject and then tell ORY Hydra now about it.
`CompletedRequest`	`acceptLoginRequest(String loginChallenge, AcceptLoginRequest body)`	Accept a Login Request When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider (sometimes called \"identity provider\") to authenticate the subject and then tell ORY Hydra now about it.
`okhttp3.Call`	`acceptLoginRequestAsync(String loginChallenge, AcceptLoginRequest body, ApiCallback<CompletedRequest> _callback)`	Accept a Login Request (asynchronously) When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider (sometimes called \"identity provider\") to authenticate the subject and then tell ORY Hydra now about it.
`okhttp3.Call`	`acceptLoginRequestCall(String loginChallenge, AcceptLoginRequest body, ApiCallback _callback)`	Build call for acceptLoginRequest
`ApiResponse<CompletedRequest>`	`acceptLoginRequestWithHttpInfo(String loginChallenge, AcceptLoginRequest body)`	Accept a Login Request When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider (sometimes called \"identity provider\") to authenticate the subject and then tell ORY Hydra now about it.
`CompletedRequest`	`acceptLogoutRequest(String logoutChallenge)`	Accept a Logout Request When a user or an application requests ORY Hydra to log out a user, this endpoint is used to confirm that logout request.
`okhttp3.Call`	`acceptLogoutRequestAsync(String logoutChallenge, ApiCallback<CompletedRequest> _callback)`	Accept a Logout Request (asynchronously) When a user or an application requests ORY Hydra to log out a user, this endpoint is used to confirm that logout request.
`okhttp3.Call`	`acceptLogoutRequestCall(String logoutChallenge, ApiCallback _callback)`	Build call for acceptLogoutRequest
`ApiResponse<CompletedRequest>`	`acceptLogoutRequestWithHttpInfo(String logoutChallenge)`	Accept a Logout Request When a user or an application requests ORY Hydra to log out a user, this endpoint is used to confirm that logout request.
`JSONWebKeySet`	`createJsonWebKeySet(String set, JsonWebKeySetGeneratorRequest body)`	Generate a New JSON Web Key This endpoint is capable of generating JSON Web Key Sets for you.
`okhttp3.Call`	`createJsonWebKeySetAsync(String set, JsonWebKeySetGeneratorRequest body, ApiCallback<JSONWebKeySet> _callback)`	Generate a New JSON Web Key (asynchronously) This endpoint is capable of generating JSON Web Key Sets for you.
`okhttp3.Call`	`createJsonWebKeySetCall(String set, JsonWebKeySetGeneratorRequest body, ApiCallback _callback)`	Build call for createJsonWebKeySet
`ApiResponse<JSONWebKeySet>`	`createJsonWebKeySetWithHttpInfo(String set, JsonWebKeySetGeneratorRequest body)`	Generate a New JSON Web Key This endpoint is capable of generating JSON Web Key Sets for you.
`OAuth2Client`	`createOAuth2Client(OAuth2Client body)`	Create an OAuth 2.0 Client Create a new OAuth 2.0 client If you pass `client_secret` the secret will be used, otherwise a random secret will be generated.
`okhttp3.Call`	`createOAuth2ClientAsync(OAuth2Client body, ApiCallback<OAuth2Client> _callback)`	Create an OAuth 2.0 Client (asynchronously) Create a new OAuth 2.0 client If you pass `client_secret` the secret will be used, otherwise a random secret will be generated.
`okhttp3.Call`	`createOAuth2ClientCall(OAuth2Client body, ApiCallback _callback)`	Build call for createOAuth2Client
`ApiResponse<OAuth2Client>`	`createOAuth2ClientWithHttpInfo(OAuth2Client body)`	Create an OAuth 2.0 Client Create a new OAuth 2.0 client If you pass `client_secret` the secret will be used, otherwise a random secret will be generated.
`void`	`deleteJsonWebKey(String kid, String set)`	Delete a JSON Web Key Use this endpoint to delete a single JSON Web Key.
`okhttp3.Call`	`deleteJsonWebKeyAsync(String kid, String set, ApiCallback<Void> _callback)`	Delete a JSON Web Key (asynchronously) Use this endpoint to delete a single JSON Web Key.
`okhttp3.Call`	`deleteJsonWebKeyCall(String kid, String set, ApiCallback _callback)`	Build call for deleteJsonWebKey
`void`	`deleteJsonWebKeySet(String set)`	Delete a JSON Web Key Set Use this endpoint to delete a complete JSON Web Key Set and all the keys in that set.
`okhttp3.Call`	`deleteJsonWebKeySetAsync(String set, ApiCallback<Void> _callback)`	Delete a JSON Web Key Set (asynchronously) Use this endpoint to delete a complete JSON Web Key Set and all the keys in that set.
`okhttp3.Call`	`deleteJsonWebKeySetCall(String set, ApiCallback _callback)`	Build call for deleteJsonWebKeySet
`ApiResponse<Void>`	`deleteJsonWebKeySetWithHttpInfo(String set)`	Delete a JSON Web Key Set Use this endpoint to delete a complete JSON Web Key Set and all the keys in that set.
`ApiResponse<Void>`	`deleteJsonWebKeyWithHttpInfo(String kid, String set)`	Delete a JSON Web Key Use this endpoint to delete a single JSON Web Key.
`void`	`deleteOAuth2Client(String id)`	Deletes an OAuth 2.0 Client Delete an existing OAuth 2.0 Client by its ID.
`okhttp3.Call`	`deleteOAuth2ClientAsync(String id, ApiCallback<Void> _callback)`	Deletes an OAuth 2.0 Client (asynchronously) Delete an existing OAuth 2.0 Client by its ID.
`okhttp3.Call`	`deleteOAuth2ClientCall(String id, ApiCallback _callback)`	Build call for deleteOAuth2Client
`ApiResponse<Void>`	`deleteOAuth2ClientWithHttpInfo(String id)`	Deletes an OAuth 2.0 Client Delete an existing OAuth 2.0 Client by its ID.
`void`	`deleteOAuth2Token(String clientId)`	Delete OAuth2 Access Tokens from a Client This endpoint deletes OAuth2 access tokens issued for a client from the database
`okhttp3.Call`	`deleteOAuth2TokenAsync(String clientId, ApiCallback<Void> _callback)`	Delete OAuth2 Access Tokens from a Client (asynchronously) This endpoint deletes OAuth2 access tokens issued for a client from the database
`okhttp3.Call`	`deleteOAuth2TokenCall(String clientId, ApiCallback _callback)`	Build call for deleteOAuth2Token
`ApiResponse<Void>`	`deleteOAuth2TokenWithHttpInfo(String clientId)`	Delete OAuth2 Access Tokens from a Client This endpoint deletes OAuth2 access tokens issued for a client from the database
`void`	`flushInactiveOAuth2Tokens(FlushInactiveOAuth2TokensRequest body)`	Flush Expired OAuth2 Access Tokens This endpoint flushes expired OAuth2 access tokens from the database.
`okhttp3.Call`	`flushInactiveOAuth2TokensAsync(FlushInactiveOAuth2TokensRequest body, ApiCallback<Void> _callback)`	Flush Expired OAuth2 Access Tokens (asynchronously) This endpoint flushes expired OAuth2 access tokens from the database.
`okhttp3.Call`	`flushInactiveOAuth2TokensCall(FlushInactiveOAuth2TokensRequest body, ApiCallback _callback)`	Build call for flushInactiveOAuth2Tokens
`ApiResponse<Void>`	`flushInactiveOAuth2TokensWithHttpInfo(FlushInactiveOAuth2TokensRequest body)`	Flush Expired OAuth2 Access Tokens This endpoint flushes expired OAuth2 access tokens from the database.
`ApiClient`	`getApiClient()`
`ConsentRequest`	`getConsentRequest(String consentChallenge)`	Get Consent Request Information When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider to authenticate the subject and then tell ORY Hydra now about it.
`okhttp3.Call`	`getConsentRequestAsync(String consentChallenge, ApiCallback<ConsentRequest> _callback)`	Get Consent Request Information (asynchronously) When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider to authenticate the subject and then tell ORY Hydra now about it.
`okhttp3.Call`	`getConsentRequestCall(String consentChallenge, ApiCallback _callback)`	Build call for getConsentRequest
`ApiResponse<ConsentRequest>`	`getConsentRequestWithHttpInfo(String consentChallenge)`	Get Consent Request Information When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider to authenticate the subject and then tell ORY Hydra now about it.
`JSONWebKeySet`	`getJsonWebKey(String kid, String set)`	Fetch a JSON Web Key This endpoint returns a singular JSON Web Key, identified by the set and the specific key ID (kid).
`okhttp3.Call`	`getJsonWebKeyAsync(String kid, String set, ApiCallback<JSONWebKeySet> _callback)`	Fetch a JSON Web Key (asynchronously) This endpoint returns a singular JSON Web Key, identified by the set and the specific key ID (kid).
`okhttp3.Call`	`getJsonWebKeyCall(String kid, String set, ApiCallback _callback)`	Build call for getJsonWebKey
`JSONWebKeySet`	`getJsonWebKeySet(String set)`	Retrieve a JSON Web Key Set This endpoint can be used to retrieve JWK Sets stored in ORY Hydra.
`okhttp3.Call`	`getJsonWebKeySetAsync(String set, ApiCallback<JSONWebKeySet> _callback)`	Retrieve a JSON Web Key Set (asynchronously) This endpoint can be used to retrieve JWK Sets stored in ORY Hydra.
`okhttp3.Call`	`getJsonWebKeySetCall(String set, ApiCallback _callback)`	Build call for getJsonWebKeySet
`ApiResponse<JSONWebKeySet>`	`getJsonWebKeySetWithHttpInfo(String set)`	Retrieve a JSON Web Key Set This endpoint can be used to retrieve JWK Sets stored in ORY Hydra.
`ApiResponse<JSONWebKeySet>`	`getJsonWebKeyWithHttpInfo(String kid, String set)`	Fetch a JSON Web Key This endpoint returns a singular JSON Web Key, identified by the set and the specific key ID (kid).
`LoginRequest`	`getLoginRequest(String loginChallenge)`	Get a Login Request When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider (sometimes called \"identity provider\") to authenticate the subject and then tell ORY Hydra now about it.
`okhttp3.Call`	`getLoginRequestAsync(String loginChallenge, ApiCallback<LoginRequest> _callback)`	Get a Login Request (asynchronously) When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider (sometimes called \"identity provider\") to authenticate the subject and then tell ORY Hydra now about it.
`okhttp3.Call`	`getLoginRequestCall(String loginChallenge, ApiCallback _callback)`	Build call for getLoginRequest
`ApiResponse<LoginRequest>`	`getLoginRequestWithHttpInfo(String loginChallenge)`	Get a Login Request When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider (sometimes called \"identity provider\") to authenticate the subject and then tell ORY Hydra now about it.
`LogoutRequest`	`getLogoutRequest(String logoutChallenge)`	Get a Logout Request Use this endpoint to fetch a logout request.
`okhttp3.Call`	`getLogoutRequestAsync(String logoutChallenge, ApiCallback<LogoutRequest> _callback)`	Get a Logout Request (asynchronously) Use this endpoint to fetch a logout request.
`okhttp3.Call`	`getLogoutRequestCall(String logoutChallenge, ApiCallback _callback)`	Build call for getLogoutRequest
`ApiResponse<LogoutRequest>`	`getLogoutRequestWithHttpInfo(String logoutChallenge)`	Get a Logout Request Use this endpoint to fetch a logout request.
`OAuth2Client`	`getOAuth2Client(String id)`	Get an OAuth 2.0 Client.
`okhttp3.Call`	`getOAuth2ClientAsync(String id, ApiCallback<OAuth2Client> _callback)`	Get an OAuth 2.0 Client.
`okhttp3.Call`	`getOAuth2ClientCall(String id, ApiCallback _callback)`	Build call for getOAuth2Client
`ApiResponse<OAuth2Client>`	`getOAuth2ClientWithHttpInfo(String id)`	Get an OAuth 2.0 Client.
`Version`	`getVersion()`	Get Service Version This endpoint returns the service version typically notated using semantic versioning.
`okhttp3.Call`	`getVersionAsync(ApiCallback<Version> _callback)`	Get Service Version (asynchronously) This endpoint returns the service version typically notated using semantic versioning.
`okhttp3.Call`	`getVersionCall(ApiCallback _callback)`	Build call for getVersion
`ApiResponse<Version>`	`getVersionWithHttpInfo()`	Get Service Version This endpoint returns the service version typically notated using semantic versioning.
`OAuth2TokenIntrospection`	`introspectOAuth2Token(String token, String scope)`	Introspect OAuth2 Tokens The introspection endpoint allows to check if a token (both refresh and access) is active or not.
`okhttp3.Call`	`introspectOAuth2TokenAsync(String token, String scope, ApiCallback<OAuth2TokenIntrospection> _callback)`	Introspect OAuth2 Tokens (asynchronously) The introspection endpoint allows to check if a token (both refresh and access) is active or not.
`okhttp3.Call`	`introspectOAuth2TokenCall(String token, String scope, ApiCallback _callback)`	Build call for introspectOAuth2Token
`ApiResponse<OAuth2TokenIntrospection>`	`introspectOAuth2TokenWithHttpInfo(String token, String scope)`	Introspect OAuth2 Tokens The introspection endpoint allows to check if a token (both refresh and access) is active or not.
`HealthStatus`	`isInstanceAlive()`	Check Alive Status This endpoint returns a 200 status code when the HTTP server is up running.
`okhttp3.Call`	`isInstanceAliveAsync(ApiCallback<HealthStatus> _callback)`	Check Alive Status (asynchronously) This endpoint returns a 200 status code when the HTTP server is up running.
`okhttp3.Call`	`isInstanceAliveCall(ApiCallback _callback)`	Build call for isInstanceAlive
`ApiResponse<HealthStatus>`	`isInstanceAliveWithHttpInfo()`	Check Alive Status This endpoint returns a 200 status code when the HTTP server is up running.
`List<OAuth2Client>`	`listOAuth2Clients(Long limit, Long offset)`	List OAuth 2.0 Clients This endpoint lists all clients in the database, and never returns client secrets.
`okhttp3.Call`	`listOAuth2ClientsAsync(Long limit, Long offset, ApiCallback<List<OAuth2Client>> _callback)`	List OAuth 2.0 Clients (asynchronously) This endpoint lists all clients in the database, and never returns client secrets.
`okhttp3.Call`	`listOAuth2ClientsCall(Long limit, Long offset, ApiCallback _callback)`	Build call for listOAuth2Clients
`ApiResponse<List<OAuth2Client>>`	`listOAuth2ClientsWithHttpInfo(Long limit, Long offset)`	List OAuth 2.0 Clients This endpoint lists all clients in the database, and never returns client secrets.
`List<PreviousConsentSession>`	`listSubjectConsentSessions(String subject)`	Lists All Consent Sessions of a Subject This endpoint lists all subject's granted consent sessions, including client and granted scope.
`okhttp3.Call`	`listSubjectConsentSessionsAsync(String subject, ApiCallback<List<PreviousConsentSession>> _callback)`	Lists All Consent Sessions of a Subject (asynchronously) This endpoint lists all subject's granted consent sessions, including client and granted scope.
`okhttp3.Call`	`listSubjectConsentSessionsCall(String subject, ApiCallback _callback)`	Build call for listSubjectConsentSessions
`ApiResponse<List<PreviousConsentSession>>`	`listSubjectConsentSessionsWithHttpInfo(String subject)`	Lists All Consent Sessions of a Subject This endpoint lists all subject's granted consent sessions, including client and granted scope.
`void`	`prometheus()`	Get Snapshot Metrics from the Hydra Service.
`okhttp3.Call`	`prometheusAsync(ApiCallback<Void> _callback)`	Get Snapshot Metrics from the Hydra Service.
`okhttp3.Call`	`prometheusCall(ApiCallback _callback)`	Build call for prometheus
`ApiResponse<Void>`	`prometheusWithHttpInfo()`	Get Snapshot Metrics from the Hydra Service.
`CompletedRequest`	`rejectConsentRequest(String consentChallenge, RejectRequest body)`	Reject a Consent Request When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider to authenticate the subject and then tell ORY Hydra now about it.
`okhttp3.Call`	`rejectConsentRequestAsync(String consentChallenge, RejectRequest body, ApiCallback<CompletedRequest> _callback)`	Reject a Consent Request (asynchronously) When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider to authenticate the subject and then tell ORY Hydra now about it.
`okhttp3.Call`	`rejectConsentRequestCall(String consentChallenge, RejectRequest body, ApiCallback _callback)`	Build call for rejectConsentRequest
`ApiResponse<CompletedRequest>`	`rejectConsentRequestWithHttpInfo(String consentChallenge, RejectRequest body)`	Reject a Consent Request When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider to authenticate the subject and then tell ORY Hydra now about it.
`CompletedRequest`	`rejectLoginRequest(String loginChallenge, RejectRequest body)`	Reject a Login Request When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider (sometimes called \"identity provider\") to authenticate the subject and then tell ORY Hydra now about it.
`okhttp3.Call`	`rejectLoginRequestAsync(String loginChallenge, RejectRequest body, ApiCallback<CompletedRequest> _callback)`	Reject a Login Request (asynchronously) When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider (sometimes called \"identity provider\") to authenticate the subject and then tell ORY Hydra now about it.
`okhttp3.Call`	`rejectLoginRequestCall(String loginChallenge, RejectRequest body, ApiCallback _callback)`	Build call for rejectLoginRequest
`ApiResponse<CompletedRequest>`	`rejectLoginRequestWithHttpInfo(String loginChallenge, RejectRequest body)`	Reject a Login Request When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider (sometimes called \"identity provider\") to authenticate the subject and then tell ORY Hydra now about it.
`void`	`rejectLogoutRequest(String logoutChallenge, RejectRequest body)`	Reject a Logout Request When a user or an application requests ORY Hydra to log out a user, this endpoint is used to deny that logout request.
`okhttp3.Call`	`rejectLogoutRequestAsync(String logoutChallenge, RejectRequest body, ApiCallback<Void> _callback)`	Reject a Logout Request (asynchronously) When a user or an application requests ORY Hydra to log out a user, this endpoint is used to deny that logout request.
`okhttp3.Call`	`rejectLogoutRequestCall(String logoutChallenge, RejectRequest body, ApiCallback _callback)`	Build call for rejectLogoutRequest
`ApiResponse<Void>`	`rejectLogoutRequestWithHttpInfo(String logoutChallenge, RejectRequest body)`	Reject a Logout Request When a user or an application requests ORY Hydra to log out a user, this endpoint is used to deny that logout request.
`void`	`revokeAuthenticationSession(String subject)`	Invalidates All Login Sessions of a Certain User Invalidates a Subject's Authentication Session This endpoint invalidates a subject's authentication session.
`okhttp3.Call`	`revokeAuthenticationSessionAsync(String subject, ApiCallback<Void> _callback)`	Invalidates All Login Sessions of a Certain User Invalidates a Subject's Authentication Session (asynchronously) This endpoint invalidates a subject's authentication session.
`okhttp3.Call`	`revokeAuthenticationSessionCall(String subject, ApiCallback _callback)`	Build call for revokeAuthenticationSession
`ApiResponse<Void>`	`revokeAuthenticationSessionWithHttpInfo(String subject)`	Invalidates All Login Sessions of a Certain User Invalidates a Subject's Authentication Session This endpoint invalidates a subject's authentication session.
`void`	`revokeConsentSessions(String subject, String client, Boolean all)`	Revokes Consent Sessions of a Subject for a Specific OAuth 2.0 Client This endpoint revokes a subject's granted consent sessions for a specific OAuth 2.0 Client and invalidates all associated OAuth 2.0 Access Tokens.
`okhttp3.Call`	`revokeConsentSessionsAsync(String subject, String client, Boolean all, ApiCallback<Void> _callback)`	Revokes Consent Sessions of a Subject for a Specific OAuth 2.0 Client (asynchronously) This endpoint revokes a subject's granted consent sessions for a specific OAuth 2.0 Client and invalidates all associated OAuth 2.0 Access Tokens.
`okhttp3.Call`	`revokeConsentSessionsCall(String subject, String client, Boolean all, ApiCallback _callback)`	Build call for revokeConsentSessions
`ApiResponse<Void>`	`revokeConsentSessionsWithHttpInfo(String subject, String client, Boolean all)`	Revokes Consent Sessions of a Subject for a Specific OAuth 2.0 Client This endpoint revokes a subject's granted consent sessions for a specific OAuth 2.0 Client and invalidates all associated OAuth 2.0 Access Tokens.
`void`	`setApiClient(ApiClient apiClient)`
`JSONWebKey`	`updateJsonWebKey(String kid, String set, JSONWebKey body)`	Update a JSON Web Key Use this method if you do not want to let Hydra generate the JWKs for you, but instead save your own.
`okhttp3.Call`	`updateJsonWebKeyAsync(String kid, String set, JSONWebKey body, ApiCallback<JSONWebKey> _callback)`	Update a JSON Web Key (asynchronously) Use this method if you do not want to let Hydra generate the JWKs for you, but instead save your own.
`okhttp3.Call`	`updateJsonWebKeyCall(String kid, String set, JSONWebKey body, ApiCallback _callback)`	Build call for updateJsonWebKey
`JSONWebKeySet`	`updateJsonWebKeySet(String set, JSONWebKeySet body)`	Update a JSON Web Key Set Use this method if you do not want to let Hydra generate the JWKs for you, but instead save your own.
`okhttp3.Call`	`updateJsonWebKeySetAsync(String set, JSONWebKeySet body, ApiCallback<JSONWebKeySet> _callback)`	Update a JSON Web Key Set (asynchronously) Use this method if you do not want to let Hydra generate the JWKs for you, but instead save your own.
`okhttp3.Call`	`updateJsonWebKeySetCall(String set, JSONWebKeySet body, ApiCallback _callback)`	Build call for updateJsonWebKeySet
`ApiResponse<JSONWebKeySet>`	`updateJsonWebKeySetWithHttpInfo(String set, JSONWebKeySet body)`	Update a JSON Web Key Set Use this method if you do not want to let Hydra generate the JWKs for you, but instead save your own.
`ApiResponse<JSONWebKey>`	`updateJsonWebKeyWithHttpInfo(String kid, String set, JSONWebKey body)`	Update a JSON Web Key Use this method if you do not want to let Hydra generate the JWKs for you, but instead save your own.
`OAuth2Client`	`updateOAuth2Client(String id, OAuth2Client body)`	Update an OAuth 2.0 Client Update an existing OAuth 2.0 Client.
`okhttp3.Call`	`updateOAuth2ClientAsync(String id, OAuth2Client body, ApiCallback<OAuth2Client> _callback)`	Update an OAuth 2.0 Client (asynchronously) Update an existing OAuth 2.0 Client.
`okhttp3.Call`	`updateOAuth2ClientCall(String id, OAuth2Client body, ApiCallback _callback)`	Build call for updateOAuth2Client
`ApiResponse<OAuth2Client>`	`updateOAuth2ClientWithHttpInfo(String id, OAuth2Client body)`	Update an OAuth 2.0 Client Update an existing OAuth 2.0 Client.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AdminApi
```
public AdminApi()
```

AdminApi

public AdminApi(ApiClient apiClient)

Method Detail

getApiClient
```
public ApiClient getApiClient()
```

setApiClient

public void setApiClient(ApiClient apiClient)

acceptConsentRequestCall

public okhttp3.Call acceptConsentRequestCall(String consentChallenge,
                                             AcceptConsentRequest body,
                                             ApiCallback _callback)
                                      throws ApiException

Build call for acceptConsentRequest

Parameters:

consentChallenge - (required)

body - (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	completedRequest	-
404	genericError	-
500	genericError	-

acceptConsentRequest
```
public CompletedRequest acceptConsentRequest(String consentChallenge,
                                             AcceptConsentRequest body)
                                      throws ApiException
```
Accept a Consent Request When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider to authenticate the subject and then tell ORY Hydra now about it. If the subject authenticated, he/she must now be asked if the OAuth 2.0 Client which initiated the flow should be allowed to access the resources on the subject's behalf. The consent provider which handles this request and is a web app implemented and hosted by you. It shows a subject interface which asks the subject to grant or deny the client access to the requested scope (\"Application my-dropbox-app wants write access to all your private files\"). The consent challenge is appended to the consent provider's URL to which the subject's user-agent (browser) is redirected to. The consent provider uses that challenge to fetch information on the OAuth2 request and then tells ORY Hydra if the subject accepted or rejected the request. This endpoint tells ORY Hydra that the subject has authorized the OAuth 2.0 client to access resources on his/her behalf. The consent provider includes additional information, such as session data for access and ID tokens, and if the consent request should be used as basis for future requests. The response contains a redirect URL which the consent provider should redirect the user-agent to.

Parameters:

consentChallenge - (required)

body - (optional)

Returns:

CompletedRequest

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 completedRequest -

404 genericError -

500 genericError -

acceptConsentRequestWithHttpInfo
```
public ApiResponse<CompletedRequest> acceptConsentRequestWithHttpInfo(String consentChallenge,
                                                                      AcceptConsentRequest body)
                                                               throws ApiException
```
Accept a Consent Request When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider to authenticate the subject and then tell ORY Hydra now about it. If the subject authenticated, he/she must now be asked if the OAuth 2.0 Client which initiated the flow should be allowed to access the resources on the subject's behalf. The consent provider which handles this request and is a web app implemented and hosted by you. It shows a subject interface which asks the subject to grant or deny the client access to the requested scope (\"Application my-dropbox-app wants write access to all your private files\"). The consent challenge is appended to the consent provider's URL to which the subject's user-agent (browser) is redirected to. The consent provider uses that challenge to fetch information on the OAuth2 request and then tells ORY Hydra if the subject accepted or rejected the request. This endpoint tells ORY Hydra that the subject has authorized the OAuth 2.0 client to access resources on his/her behalf. The consent provider includes additional information, such as session data for access and ID tokens, and if the consent request should be used as basis for future requests. The response contains a redirect URL which the consent provider should redirect the user-agent to.

Parameters:

consentChallenge - (required)

body - (optional)

Returns:

ApiResponse<CompletedRequest>

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 completedRequest -

404 genericError -

500 genericError -

acceptConsentRequestAsync
```
public okhttp3.Call acceptConsentRequestAsync(String consentChallenge,
                                              AcceptConsentRequest body,
                                              ApiCallback<CompletedRequest> _callback)
                                       throws ApiException
```
Accept a Consent Request (asynchronously) When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider to authenticate the subject and then tell ORY Hydra now about it. If the subject authenticated, he/she must now be asked if the OAuth 2.0 Client which initiated the flow should be allowed to access the resources on the subject's behalf. The consent provider which handles this request and is a web app implemented and hosted by you. It shows a subject interface which asks the subject to grant or deny the client access to the requested scope (\"Application my-dropbox-app wants write access to all your private files\"). The consent challenge is appended to the consent provider's URL to which the subject's user-agent (browser) is redirected to. The consent provider uses that challenge to fetch information on the OAuth2 request and then tells ORY Hydra if the subject accepted or rejected the request. This endpoint tells ORY Hydra that the subject has authorized the OAuth 2.0 client to access resources on his/her behalf. The consent provider includes additional information, such as session data for access and ID tokens, and if the consent request should be used as basis for future requests. The response contains a redirect URL which the consent provider should redirect the user-agent to.

Parameters:

consentChallenge - (required)

body - (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 completedRequest -

404 genericError -

500 genericError -

acceptLoginRequestCall

public okhttp3.Call acceptLoginRequestCall(String loginChallenge,
                                           AcceptLoginRequest body,
                                           ApiCallback _callback)
                                    throws ApiException

Build call for acceptLoginRequest

Parameters:

loginChallenge - (required)

body - (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	completedRequest	-
400	genericError	-
401	genericError	-
404	genericError	-
500	genericError	-

acceptLoginRequest

public CompletedRequest acceptLoginRequest(String loginChallenge,
                                           AcceptLoginRequest body)
                                    throws ApiException

Accept a Login Request When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider (sometimes called \"identity provider\") to authenticate the subject and then tell ORY Hydra now about it. The login provider is an web-app you write and host, and it must be able to authenticate (\"show the subject a login screen\") a subject (in OAuth2 the proper name for subject is \"resource owner\"). The authentication challenge is appended to the login provider URL to which the subject's user-agent (browser) is redirected to. The login provider uses that challenge to fetch information on the OAuth2 request and then accept or reject the requested authentication process. This endpoint tells ORY Hydra that the subject has successfully authenticated and includes additional information such as the subject's ID and if ORY Hydra should remember the subject's subject agent for future authentication attempts by setting a cookie. The response contains a redirect URL which the login provider should redirect the user-agent to.

Parameters:

loginChallenge - (required)

body - (optional)

Returns:

CompletedRequest

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	completedRequest	-
400	genericError	-
401	genericError	-
404	genericError	-
500	genericError	-

acceptLoginRequestWithHttpInfo

public ApiResponse<CompletedRequest> acceptLoginRequestWithHttpInfo(String loginChallenge,
                                                                    AcceptLoginRequest body)
                                                             throws ApiException

Accept a Login Request When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider (sometimes called \"identity provider\") to authenticate the subject and then tell ORY Hydra now about it. The login provider is an web-app you write and host, and it must be able to authenticate (\"show the subject a login screen\") a subject (in OAuth2 the proper name for subject is \"resource owner\"). The authentication challenge is appended to the login provider URL to which the subject's user-agent (browser) is redirected to. The login provider uses that challenge to fetch information on the OAuth2 request and then accept or reject the requested authentication process. This endpoint tells ORY Hydra that the subject has successfully authenticated and includes additional information such as the subject's ID and if ORY Hydra should remember the subject's subject agent for future authentication attempts by setting a cookie. The response contains a redirect URL which the login provider should redirect the user-agent to.

Parameters:

loginChallenge - (required)

body - (optional)

Returns:

ApiResponse<CompletedRequest>

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	completedRequest	-
400	genericError	-
401	genericError	-
404	genericError	-
500	genericError	-

acceptLoginRequestAsync

public okhttp3.Call acceptLoginRequestAsync(String loginChallenge,
                                            AcceptLoginRequest body,
                                            ApiCallback<CompletedRequest> _callback)
                                     throws ApiException

Accept a Login Request (asynchronously) When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider (sometimes called \"identity provider\") to authenticate the subject and then tell ORY Hydra now about it. The login provider is an web-app you write and host, and it must be able to authenticate (\"show the subject a login screen\") a subject (in OAuth2 the proper name for subject is \"resource owner\"). The authentication challenge is appended to the login provider URL to which the subject's user-agent (browser) is redirected to. The login provider uses that challenge to fetch information on the OAuth2 request and then accept or reject the requested authentication process. This endpoint tells ORY Hydra that the subject has successfully authenticated and includes additional information such as the subject's ID and if ORY Hydra should remember the subject's subject agent for future authentication attempts by setting a cookie. The response contains a redirect URL which the login provider should redirect the user-agent to.

Parameters:

loginChallenge - (required)

body - (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	completedRequest	-
400	genericError	-
401	genericError	-
404	genericError	-
500	genericError	-

acceptLogoutRequestCall
```
public okhttp3.Call acceptLogoutRequestCall(String logoutChallenge,
                                            ApiCallback _callback)
                                     throws ApiException
```
Build call for acceptLogoutRequest

Parameters:

logoutChallenge - (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 completedRequest -

404 genericError -

500 genericError -

acceptLogoutRequest
```
public CompletedRequest acceptLogoutRequest(String logoutChallenge)
                                     throws ApiException
```
Accept a Logout Request When a user or an application requests ORY Hydra to log out a user, this endpoint is used to confirm that logout request. No body is required. The response contains a redirect URL which the consent provider should redirect the user-agent to.

Parameters:

logoutChallenge - (required)

Returns:

CompletedRequest

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 completedRequest -

404 genericError -

500 genericError -

acceptLogoutRequestWithHttpInfo
```
public ApiResponse<CompletedRequest> acceptLogoutRequestWithHttpInfo(String logoutChallenge)
                                                              throws ApiException
```
Accept a Logout Request When a user or an application requests ORY Hydra to log out a user, this endpoint is used to confirm that logout request. No body is required. The response contains a redirect URL which the consent provider should redirect the user-agent to.

Parameters:

logoutChallenge - (required)

Returns:

ApiResponse<CompletedRequest>

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 completedRequest -

404 genericError -

500 genericError -

acceptLogoutRequestAsync
```
public okhttp3.Call acceptLogoutRequestAsync(String logoutChallenge,
                                             ApiCallback<CompletedRequest> _callback)
                                      throws ApiException
```
Accept a Logout Request (asynchronously) When a user or an application requests ORY Hydra to log out a user, this endpoint is used to confirm that logout request. No body is required. The response contains a redirect URL which the consent provider should redirect the user-agent to.

Parameters:

logoutChallenge - (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 completedRequest -

404 genericError -

500 genericError -

createJsonWebKeySetCall
```
public okhttp3.Call createJsonWebKeySetCall(String set,
                                            JsonWebKeySetGeneratorRequest body,
                                            ApiCallback _callback)
                                     throws ApiException
```
Build call for createJsonWebKeySet

Parameters:

set - The set (required)

body - (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

201 JSONWebKeySet -

401 genericError -

403 genericError -

500 genericError -

createJsonWebKeySet
```
public JSONWebKeySet createJsonWebKeySet(String set,
                                         JsonWebKeySetGeneratorRequest body)
                                  throws ApiException
```
Generate a New JSON Web Key This endpoint is capable of generating JSON Web Key Sets for you. There a different strategies available, such as symmetric cryptographic keys (HS256, HS512) and asymetric cryptographic keys (RS256, ECDSA). If the specified JSON Web Key Set does not exist, it will be created. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.

Parameters:

set - The set (required)

body - (optional)

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

201 JSONWebKeySet -

401 genericError -

403 genericError -

500 genericError -

createJsonWebKeySetWithHttpInfo
```
public ApiResponse<JSONWebKeySet> createJsonWebKeySetWithHttpInfo(String set,
                                                                  JsonWebKeySetGeneratorRequest body)
                                                           throws ApiException
```
Generate a New JSON Web Key This endpoint is capable of generating JSON Web Key Sets for you. There a different strategies available, such as symmetric cryptographic keys (HS256, HS512) and asymetric cryptographic keys (RS256, ECDSA). If the specified JSON Web Key Set does not exist, it will be created. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.

Parameters:

set - The set (required)

body - (optional)

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

201 JSONWebKeySet -

401 genericError -

403 genericError -

500 genericError -

createJsonWebKeySetAsync
```
public okhttp3.Call createJsonWebKeySetAsync(String set,
                                             JsonWebKeySetGeneratorRequest body,
                                             ApiCallback<JSONWebKeySet> _callback)
                                      throws ApiException
```
Generate a New JSON Web Key (asynchronously) This endpoint is capable of generating JSON Web Key Sets for you. There a different strategies available, such as symmetric cryptographic keys (HS256, HS512) and asymetric cryptographic keys (RS256, ECDSA). If the specified JSON Web Key Set does not exist, it will be created. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.

Parameters:

set - The set (required)

body - (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

201 JSONWebKeySet -

401 genericError -

403 genericError -

500 genericError -

createOAuth2ClientCall
```
public okhttp3.Call createOAuth2ClientCall(OAuth2Client body,
                                           ApiCallback _callback)
                                    throws ApiException
```
Build call for createOAuth2Client

Parameters:

body - (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

201 oAuth2Client -

400 genericError -

409 genericError -

500 genericError -

createOAuth2Client
```
public OAuth2Client createOAuth2Client(OAuth2Client body)
                                throws ApiException
```
Create an OAuth 2.0 Client Create a new OAuth 2.0 client If you pass `client_secret` the secret will be used, otherwise a random secret will be generated. The secret will be returned in the response and you will not be able to retrieve it later on. Write the secret down and keep it somwhere safe. OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities. To manage ORY Hydra, you will need an OAuth 2.0 Client as well. Make sure that this endpoint is well protected and only callable by first-party components.

Parameters:

body - (required)

Returns:

OAuth2Client

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

201 oAuth2Client -

400 genericError -

409 genericError -

500 genericError -

createOAuth2ClientWithHttpInfo
```
public ApiResponse<OAuth2Client> createOAuth2ClientWithHttpInfo(OAuth2Client body)
                                                         throws ApiException
```
Create an OAuth 2.0 Client Create a new OAuth 2.0 client If you pass `client_secret` the secret will be used, otherwise a random secret will be generated. The secret will be returned in the response and you will not be able to retrieve it later on. Write the secret down and keep it somwhere safe. OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities. To manage ORY Hydra, you will need an OAuth 2.0 Client as well. Make sure that this endpoint is well protected and only callable by first-party components.

Parameters:

body - (required)

Returns:

ApiResponse<OAuth2Client>

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

201 oAuth2Client -

400 genericError -

409 genericError -

500 genericError -

createOAuth2ClientAsync
```
public okhttp3.Call createOAuth2ClientAsync(OAuth2Client body,
                                            ApiCallback<OAuth2Client> _callback)
                                     throws ApiException
```
Create an OAuth 2.0 Client (asynchronously) Create a new OAuth 2.0 client If you pass `client_secret` the secret will be used, otherwise a random secret will be generated. The secret will be returned in the response and you will not be able to retrieve it later on. Write the secret down and keep it somwhere safe. OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities. To manage ORY Hydra, you will need an OAuth 2.0 Client as well. Make sure that this endpoint is well protected and only callable by first-party components.

Parameters:

body - (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

201 oAuth2Client -

400 genericError -

409 genericError -

500 genericError -

deleteJsonWebKeyCall

public okhttp3.Call deleteJsonWebKeyCall(String kid,
                                         String set,
                                         ApiCallback _callback)
                                  throws ApiException

Build call for deleteJsonWebKey

Parameters:

kid - The kid of the desired key (required)

set - The set (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
204	Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201.	-
401	genericError	-
403	genericError	-
500	genericError	-

deleteJsonWebKey

public void deleteJsonWebKey(String kid,
                             String set)
                      throws ApiException

Delete a JSON Web Key Use this endpoint to delete a single JSON Web Key. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.

Parameters:

kid - The kid of the desired key (required)

set - The set (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
204	Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201.	-
401	genericError	-
403	genericError	-
500	genericError	-

deleteJsonWebKeyWithHttpInfo

public ApiResponse<Void> deleteJsonWebKeyWithHttpInfo(String kid,
                                                      String set)
                                               throws ApiException

Delete a JSON Web Key Use this endpoint to delete a single JSON Web Key. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.

Parameters:

kid - The kid of the desired key (required)

set - The set (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
204	Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201.	-
401	genericError	-
403	genericError	-
500	genericError	-

deleteJsonWebKeyAsync

public okhttp3.Call deleteJsonWebKeyAsync(String kid,
                                          String set,
                                          ApiCallback<Void> _callback)
                                   throws ApiException

Delete a JSON Web Key (asynchronously) Use this endpoint to delete a single JSON Web Key. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.

Parameters:

kid - The kid of the desired key (required)

set - The set (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
204	Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201.	-
401	genericError	-
403	genericError	-
500	genericError	-

deleteJsonWebKeySetCall

public okhttp3.Call deleteJsonWebKeySetCall(String set,
                                            ApiCallback _callback)
                                     throws ApiException

Build call for deleteJsonWebKeySet

Parameters:

set - The set (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
204	Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201.	-
401	genericError	-
403	genericError	-
500	genericError	-

deleteJsonWebKeySet

public void deleteJsonWebKeySet(String set)
                         throws ApiException

Delete a JSON Web Key Set Use this endpoint to delete a complete JSON Web Key Set and all the keys in that set. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.

Parameters:

set - The set (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
204	Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201.	-
401	genericError	-
403	genericError	-
500	genericError	-

deleteJsonWebKeySetWithHttpInfo

public ApiResponse<Void> deleteJsonWebKeySetWithHttpInfo(String set)
                                                  throws ApiException

Delete a JSON Web Key Set Use this endpoint to delete a complete JSON Web Key Set and all the keys in that set. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.

Parameters:

set - The set (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
204	Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201.	-
401	genericError	-
403	genericError	-
500	genericError	-

deleteJsonWebKeySetAsync

public okhttp3.Call deleteJsonWebKeySetAsync(String set,
                                             ApiCallback<Void> _callback)
                                      throws ApiException

Delete a JSON Web Key Set (asynchronously) Use this endpoint to delete a complete JSON Web Key Set and all the keys in that set. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.

Parameters:

set - The set (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
204	Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201.	-
401	genericError	-
403	genericError	-
500	genericError	-

deleteOAuth2ClientCall

public okhttp3.Call deleteOAuth2ClientCall(String id,
                                           ApiCallback _callback)
                                    throws ApiException

Build call for deleteOAuth2Client

Parameters:

id - The id of the OAuth 2.0 Client. (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
204	Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201.	-
404	genericError	-
500	genericError	-

deleteOAuth2Client

public void deleteOAuth2Client(String id)
                        throws ApiException

Deletes an OAuth 2.0 Client Delete an existing OAuth 2.0 Client by its ID. OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities. To manage ORY Hydra, you will need an OAuth 2.0 Client as well. Make sure that this endpoint is well protected and only callable by first-party components.

Parameters:

id - The id of the OAuth 2.0 Client. (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
204	Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201.	-
404	genericError	-
500	genericError	-

deleteOAuth2ClientWithHttpInfo

public ApiResponse<Void> deleteOAuth2ClientWithHttpInfo(String id)
                                                 throws ApiException

Deletes an OAuth 2.0 Client Delete an existing OAuth 2.0 Client by its ID. OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities. To manage ORY Hydra, you will need an OAuth 2.0 Client as well. Make sure that this endpoint is well protected and only callable by first-party components.

Parameters:

id - The id of the OAuth 2.0 Client. (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
204	Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201.	-
404	genericError	-
500	genericError	-

deleteOAuth2ClientAsync

public okhttp3.Call deleteOAuth2ClientAsync(String id,
                                            ApiCallback<Void> _callback)
                                     throws ApiException

Deletes an OAuth 2.0 Client (asynchronously) Delete an existing OAuth 2.0 Client by its ID. OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities. To manage ORY Hydra, you will need an OAuth 2.0 Client as well. Make sure that this endpoint is well protected and only callable by first-party components.

Parameters:

id - The id of the OAuth 2.0 Client. (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
204	Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201.	-
404	genericError	-
500	genericError	-

deleteOAuth2TokenCall

public okhttp3.Call deleteOAuth2TokenCall(String clientId,
                                          ApiCallback _callback)
                                   throws ApiException

Build call for deleteOAuth2Token

Parameters:

clientId - (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
204	Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201.	-
401	genericError	-
500	genericError	-

deleteOAuth2Token

public void deleteOAuth2Token(String clientId)
                       throws ApiException

Delete OAuth2 Access Tokens from a Client This endpoint deletes OAuth2 access tokens issued for a client from the database

Parameters:

clientId - (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
204	Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201.	-
401	genericError	-
500	genericError	-

deleteOAuth2TokenWithHttpInfo

public ApiResponse<Void> deleteOAuth2TokenWithHttpInfo(String clientId)
                                                throws ApiException

Delete OAuth2 Access Tokens from a Client This endpoint deletes OAuth2 access tokens issued for a client from the database

Parameters:

clientId - (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
204	Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201.	-
401	genericError	-
500	genericError	-

deleteOAuth2TokenAsync

public okhttp3.Call deleteOAuth2TokenAsync(String clientId,
                                           ApiCallback<Void> _callback)
                                    throws ApiException

Delete OAuth2 Access Tokens from a Client (asynchronously) This endpoint deletes OAuth2 access tokens issued for a client from the database

Parameters:

clientId - (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
204	Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201.	-
401	genericError	-
500	genericError	-

flushInactiveOAuth2TokensCall

public okhttp3.Call flushInactiveOAuth2TokensCall(FlushInactiveOAuth2TokensRequest body,
                                                  ApiCallback _callback)
                                           throws ApiException

Build call for flushInactiveOAuth2Tokens

Parameters:

body - (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
204	Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201.	-
401	genericError	-
500	genericError	-

flushInactiveOAuth2Tokens

public void flushInactiveOAuth2Tokens(FlushInactiveOAuth2TokensRequest body)
                               throws ApiException

Flush Expired OAuth2 Access Tokens This endpoint flushes expired OAuth2 access tokens from the database. You can set a time after which no tokens will be not be touched, in case you want to keep recent tokens for auditing. Refresh tokens can not be flushed as they are deleted automatically when performing the refresh flow.

Parameters:

body - (optional)

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
204	Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201.	-
401	genericError	-
500	genericError	-

flushInactiveOAuth2TokensWithHttpInfo

public ApiResponse<Void> flushInactiveOAuth2TokensWithHttpInfo(FlushInactiveOAuth2TokensRequest body)
                                                        throws ApiException

Flush Expired OAuth2 Access Tokens This endpoint flushes expired OAuth2 access tokens from the database. You can set a time after which no tokens will be not be touched, in case you want to keep recent tokens for auditing. Refresh tokens can not be flushed as they are deleted automatically when performing the refresh flow.

Parameters:

body - (optional)

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
204	Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201.	-
401	genericError	-
500	genericError	-

flushInactiveOAuth2TokensAsync

public okhttp3.Call flushInactiveOAuth2TokensAsync(FlushInactiveOAuth2TokensRequest body,
                                                   ApiCallback<Void> _callback)
                                            throws ApiException

Flush Expired OAuth2 Access Tokens (asynchronously) This endpoint flushes expired OAuth2 access tokens from the database. You can set a time after which no tokens will be not be touched, in case you want to keep recent tokens for auditing. Refresh tokens can not be flushed as they are deleted automatically when performing the refresh flow.

Parameters:

body - (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
204	Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201.	-
401	genericError	-
500	genericError	-

getConsentRequestCall
```
public okhttp3.Call getConsentRequestCall(String consentChallenge,
                                          ApiCallback _callback)
                                   throws ApiException
```
Build call for getConsentRequest

Parameters:

consentChallenge - (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 consentRequest -

404 genericError -

409 genericError -

500 genericError -

getConsentRequest
```
public ConsentRequest getConsentRequest(String consentChallenge)
                                 throws ApiException
```
Get Consent Request Information When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider to authenticate the subject and then tell ORY Hydra now about it. If the subject authenticated, he/she must now be asked if the OAuth 2.0 Client which initiated the flow should be allowed to access the resources on the subject's behalf. The consent provider which handles this request and is a web app implemented and hosted by you. It shows a subject interface which asks the subject to grant or deny the client access to the requested scope (\"Application my-dropbox-app wants write access to all your private files\"). The consent challenge is appended to the consent provider's URL to which the subject's user-agent (browser) is redirected to. The consent provider uses that challenge to fetch information on the OAuth2 request and then tells ORY Hydra if the subject accepted or rejected the request.

Parameters:

consentChallenge - (required)

Returns:

ConsentRequest

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 consentRequest -

404 genericError -

409 genericError -

500 genericError -

getConsentRequestWithHttpInfo
```
public ApiResponse<ConsentRequest> getConsentRequestWithHttpInfo(String consentChallenge)
                                                          throws ApiException
```
Get Consent Request Information When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider to authenticate the subject and then tell ORY Hydra now about it. If the subject authenticated, he/she must now be asked if the OAuth 2.0 Client which initiated the flow should be allowed to access the resources on the subject's behalf. The consent provider which handles this request and is a web app implemented and hosted by you. It shows a subject interface which asks the subject to grant or deny the client access to the requested scope (\"Application my-dropbox-app wants write access to all your private files\"). The consent challenge is appended to the consent provider's URL to which the subject's user-agent (browser) is redirected to. The consent provider uses that challenge to fetch information on the OAuth2 request and then tells ORY Hydra if the subject accepted or rejected the request.

Parameters:

consentChallenge - (required)

Returns:

ApiResponse<ConsentRequest>

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 consentRequest -

404 genericError -

409 genericError -

500 genericError -

getConsentRequestAsync
```
public okhttp3.Call getConsentRequestAsync(String consentChallenge,
                                           ApiCallback<ConsentRequest> _callback)
                                    throws ApiException
```
Get Consent Request Information (asynchronously) When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider to authenticate the subject and then tell ORY Hydra now about it. If the subject authenticated, he/she must now be asked if the OAuth 2.0 Client which initiated the flow should be allowed to access the resources on the subject's behalf. The consent provider which handles this request and is a web app implemented and hosted by you. It shows a subject interface which asks the subject to grant or deny the client access to the requested scope (\"Application my-dropbox-app wants write access to all your private files\"). The consent challenge is appended to the consent provider's URL to which the subject's user-agent (browser) is redirected to. The consent provider uses that challenge to fetch information on the OAuth2 request and then tells ORY Hydra if the subject accepted or rejected the request.

Parameters:

consentChallenge - (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 consentRequest -

404 genericError -

409 genericError -

500 genericError -

getJsonWebKeyCall
```
public okhttp3.Call getJsonWebKeyCall(String kid,
                                      String set,
                                      ApiCallback _callback)
                               throws ApiException
```
Build call for getJsonWebKey

Parameters:

kid - The kid of the desired key (required)

set - The set (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 JSONWebKeySet -

404 genericError -

500 genericError -

getJsonWebKey
```
public JSONWebKeySet getJsonWebKey(String kid,
                                   String set)
                            throws ApiException
```
Fetch a JSON Web Key This endpoint returns a singular JSON Web Key, identified by the set and the specific key ID (kid).

Parameters:

kid - The kid of the desired key (required)

set - The set (required)

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 -

404 genericError -

500 genericError -

getJsonWebKeyWithHttpInfo
```
public ApiResponse<JSONWebKeySet> getJsonWebKeyWithHttpInfo(String kid,
                                                            String set)
                                                     throws ApiException
```
Fetch a JSON Web Key This endpoint returns a singular JSON Web Key, identified by the set and the specific key ID (kid).

Parameters:

kid - The kid of the desired key (required)

set - The set (required)

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 -

404 genericError -

500 genericError -

getJsonWebKeyAsync
```
public okhttp3.Call getJsonWebKeyAsync(String kid,
                                       String set,
                                       ApiCallback<JSONWebKeySet> _callback)
                                throws ApiException
```
Fetch a JSON Web Key (asynchronously) This endpoint returns a singular JSON Web Key, identified by the set and the specific key ID (kid).

Parameters:

kid - The kid of the desired key (required)

set - The set (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 JSONWebKeySet -

404 genericError -

500 genericError -

getJsonWebKeySetCall
```
public okhttp3.Call getJsonWebKeySetCall(String set,
                                         ApiCallback _callback)
                                  throws ApiException
```
Build call for getJsonWebKeySet

Parameters:

set - The set (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 JSONWebKeySet -

401 genericError -

403 genericError -

500 genericError -

getJsonWebKeySet
```
public JSONWebKeySet getJsonWebKeySet(String set)
                               throws ApiException
```
Retrieve a JSON Web Key Set This endpoint can be used to retrieve JWK Sets stored in ORY Hydra. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.

Parameters:

set - The set (required)

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 -

401 genericError -

403 genericError -

500 genericError -

getJsonWebKeySetWithHttpInfo
```
public ApiResponse<JSONWebKeySet> getJsonWebKeySetWithHttpInfo(String set)
                                                        throws ApiException
```
Retrieve a JSON Web Key Set This endpoint can be used to retrieve JWK Sets stored in ORY Hydra. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.

Parameters:

set - The set (required)

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 -

401 genericError -

403 genericError -

500 genericError -

getJsonWebKeySetAsync
```
public okhttp3.Call getJsonWebKeySetAsync(String set,
                                          ApiCallback<JSONWebKeySet> _callback)
                                   throws ApiException
```
Retrieve a JSON Web Key Set (asynchronously) This endpoint can be used to retrieve JWK Sets stored in ORY Hydra. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.

Parameters:

set - The set (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 JSONWebKeySet -

401 genericError -

403 genericError -

500 genericError -

getLoginRequestCall

public okhttp3.Call getLoginRequestCall(String loginChallenge,
                                        ApiCallback _callback)
                                 throws ApiException

Build call for getLoginRequest

Parameters:

loginChallenge - (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	loginRequest	-
400	genericError	-
404	genericError	-
409	genericError	-
500	genericError	-

getLoginRequest

public LoginRequest getLoginRequest(String loginChallenge)
                             throws ApiException

Get a Login Request When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider (sometimes called \"identity provider\") to authenticate the subject and then tell ORY Hydra now about it. The login provider is an web-app you write and host, and it must be able to authenticate (\"show the subject a login screen\") a subject (in OAuth2 the proper name for subject is \"resource owner\"). The authentication challenge is appended to the login provider URL to which the subject's user-agent (browser) is redirected to. The login provider uses that challenge to fetch information on the OAuth2 request and then accept or reject the requested authentication process.

Parameters:

loginChallenge - (required)

Returns:

LoginRequest

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	loginRequest	-
400	genericError	-
404	genericError	-
409	genericError	-
500	genericError	-

getLoginRequestWithHttpInfo

public ApiResponse<LoginRequest> getLoginRequestWithHttpInfo(String loginChallenge)
                                                      throws ApiException

Get a Login Request When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider (sometimes called \"identity provider\") to authenticate the subject and then tell ORY Hydra now about it. The login provider is an web-app you write and host, and it must be able to authenticate (\"show the subject a login screen\") a subject (in OAuth2 the proper name for subject is \"resource owner\"). The authentication challenge is appended to the login provider URL to which the subject's user-agent (browser) is redirected to. The login provider uses that challenge to fetch information on the OAuth2 request and then accept or reject the requested authentication process.

Parameters:

loginChallenge - (required)

Returns:

ApiResponse<LoginRequest>

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	loginRequest	-
400	genericError	-
404	genericError	-
409	genericError	-
500	genericError	-

getLoginRequestAsync

public okhttp3.Call getLoginRequestAsync(String loginChallenge,
                                         ApiCallback<LoginRequest> _callback)
                                  throws ApiException

Get a Login Request (asynchronously) When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider (sometimes called \"identity provider\") to authenticate the subject and then tell ORY Hydra now about it. The login provider is an web-app you write and host, and it must be able to authenticate (\"show the subject a login screen\") a subject (in OAuth2 the proper name for subject is \"resource owner\"). The authentication challenge is appended to the login provider URL to which the subject's user-agent (browser) is redirected to. The login provider uses that challenge to fetch information on the OAuth2 request and then accept or reject the requested authentication process.

Parameters:

loginChallenge - (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	loginRequest	-
400	genericError	-
404	genericError	-
409	genericError	-
500	genericError	-

getLogoutRequestCall
```
public okhttp3.Call getLogoutRequestCall(String logoutChallenge,
                                         ApiCallback _callback)
                                  throws ApiException
```
Build call for getLogoutRequest

Parameters:

logoutChallenge - (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 logoutRequest -

404 genericError -

500 genericError -

getLogoutRequest
```
public LogoutRequest getLogoutRequest(String logoutChallenge)
                               throws ApiException
```
Get a Logout Request Use this endpoint to fetch a logout request.

Parameters:

logoutChallenge - (required)

Returns:

LogoutRequest

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 logoutRequest -

404 genericError -

500 genericError -

getLogoutRequestWithHttpInfo
```
public ApiResponse<LogoutRequest> getLogoutRequestWithHttpInfo(String logoutChallenge)
                                                        throws ApiException
```
Get a Logout Request Use this endpoint to fetch a logout request.

Parameters:

logoutChallenge - (required)

Returns:

ApiResponse<LogoutRequest>

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 logoutRequest -

404 genericError -

500 genericError -

getLogoutRequestAsync
```
public okhttp3.Call getLogoutRequestAsync(String logoutChallenge,
                                          ApiCallback<LogoutRequest> _callback)
                                   throws ApiException
```
Get a Logout Request (asynchronously) Use this endpoint to fetch a logout request.

Parameters:

logoutChallenge - (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 logoutRequest -

404 genericError -

500 genericError -

getOAuth2ClientCall
```
public okhttp3.Call getOAuth2ClientCall(String id,
                                        ApiCallback _callback)
                                 throws ApiException
```
Build call for getOAuth2Client

Parameters:

id - The id of the OAuth 2.0 Client. (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 oAuth2Client -

401 genericError -

500 genericError -

getOAuth2Client
```
public OAuth2Client getOAuth2Client(String id)
                             throws ApiException
```
Get an OAuth 2.0 Client. Get an OAUth 2.0 client by its ID. This endpoint never returns passwords. OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities. To manage ORY Hydra, you will need an OAuth 2.0 Client as well. Make sure that this endpoint is well protected and only callable by first-party components.

Parameters:

id - The id of the OAuth 2.0 Client. (required)

Returns:

OAuth2Client

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 oAuth2Client -

401 genericError -

500 genericError -

getOAuth2ClientWithHttpInfo
```
public ApiResponse<OAuth2Client> getOAuth2ClientWithHttpInfo(String id)
                                                      throws ApiException
```
Get an OAuth 2.0 Client. Get an OAUth 2.0 client by its ID. This endpoint never returns passwords. OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities. To manage ORY Hydra, you will need an OAuth 2.0 Client as well. Make sure that this endpoint is well protected and only callable by first-party components.

Parameters:

id - The id of the OAuth 2.0 Client. (required)

Returns:

ApiResponse<OAuth2Client>

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 oAuth2Client -

401 genericError -

500 genericError -

getOAuth2ClientAsync
```
public okhttp3.Call getOAuth2ClientAsync(String id,
                                         ApiCallback<OAuth2Client> _callback)
                                  throws ApiException
```
Get an OAuth 2.0 Client. (asynchronously) Get an OAUth 2.0 client by its ID. This endpoint never returns passwords. OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities. To manage ORY Hydra, you will need an OAuth 2.0 Client as well. Make sure that this endpoint is well protected and only callable by first-party components.

Parameters:

id - The id of the OAuth 2.0 Client. (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 oAuth2Client -

401 genericError -

500 genericError -

getVersionCall
```
public okhttp3.Call getVersionCall(ApiCallback _callback)
                            throws ApiException
```
Build call for getVersion

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 version -

getVersion
```
public Version getVersion()
                   throws ApiException
```
Get Service Version This endpoint returns the service version typically notated using semantic versioning. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set.

Returns:

Version

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 version -

getVersionWithHttpInfo
```
public ApiResponse<Version> getVersionWithHttpInfo()
                                            throws ApiException
```
Get Service Version This endpoint returns the service version typically notated using semantic versioning. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set.

Returns:

ApiResponse<Version>

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 version -

getVersionAsync
```
public okhttp3.Call getVersionAsync(ApiCallback<Version> _callback)
                             throws ApiException
```
Get Service Version (asynchronously) This endpoint returns the service version typically notated using semantic versioning. If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set.

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 version -

introspectOAuth2TokenCall
```
public okhttp3.Call introspectOAuth2TokenCall(String token,
                                              String scope,
                                              ApiCallback _callback)
                                       throws ApiException
```
Build call for introspectOAuth2Token

Parameters:

token - The string value of the token. For access tokens, this is the \\\"access_token\\\" value returned from the token endpoint defined in OAuth 2.0. For refresh tokens, this is the \\\"refresh_token\\\" value returned. (required)

scope - An optional, space separated list of required scopes. If the access token was not granted one of the scopes, the result of active will be false. (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 oAuth2TokenIntrospection -

401 genericError -

500 genericError -

introspectOAuth2Token
```
public OAuth2TokenIntrospection introspectOAuth2Token(String token,
                                                      String scope)
                                               throws ApiException
```
Introspect OAuth2 Tokens The introspection endpoint allows to check if a token (both refresh and access) is active or not. An active token is neither expired nor revoked. If a token is active, additional information on the token will be included. You can set additional data for a token by setting `accessTokenExtra` during the consent flow. For more information [read this blog post](https://www.oauth.com/oauth2-servers/token-introspection-endpoint/).

Parameters:

token - The string value of the token. For access tokens, this is the \\\"access_token\\\" value returned from the token endpoint defined in OAuth 2.0. For refresh tokens, this is the \\\"refresh_token\\\" value returned. (required)

scope - An optional, space separated list of required scopes. If the access token was not granted one of the scopes, the result of active will be false. (optional)

Returns:

OAuth2TokenIntrospection

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 oAuth2TokenIntrospection -

401 genericError -

500 genericError -

introspectOAuth2TokenWithHttpInfo
```
public ApiResponse<OAuth2TokenIntrospection> introspectOAuth2TokenWithHttpInfo(String token,
                                                                               String scope)
                                                                        throws ApiException
```
Introspect OAuth2 Tokens The introspection endpoint allows to check if a token (both refresh and access) is active or not. An active token is neither expired nor revoked. If a token is active, additional information on the token will be included. You can set additional data for a token by setting `accessTokenExtra` during the consent flow. For more information [read this blog post](https://www.oauth.com/oauth2-servers/token-introspection-endpoint/).

Parameters:

token - The string value of the token. For access tokens, this is the \\\"access_token\\\" value returned from the token endpoint defined in OAuth 2.0. For refresh tokens, this is the \\\"refresh_token\\\" value returned. (required)

scope - An optional, space separated list of required scopes. If the access token was not granted one of the scopes, the result of active will be false. (optional)

Returns:

ApiResponse<OAuth2TokenIntrospection>

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 oAuth2TokenIntrospection -

401 genericError -

500 genericError -

introspectOAuth2TokenAsync
```
public okhttp3.Call introspectOAuth2TokenAsync(String token,
                                               String scope,
                                               ApiCallback<OAuth2TokenIntrospection> _callback)
                                        throws ApiException
```
Introspect OAuth2 Tokens (asynchronously) The introspection endpoint allows to check if a token (both refresh and access) is active or not. An active token is neither expired nor revoked. If a token is active, additional information on the token will be included. You can set additional data for a token by setting `accessTokenExtra` during the consent flow. For more information [read this blog post](https://www.oauth.com/oauth2-servers/token-introspection-endpoint/).

Parameters:

token - The string value of the token. For access tokens, this is the \\\"access_token\\\" value returned from the token endpoint defined in OAuth 2.0. For refresh tokens, this is the \\\"refresh_token\\\" value returned. (required)

scope - An optional, space separated list of required scopes. If the access token was not granted one of the scopes, the result of active will be false. (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 oAuth2TokenIntrospection -

401 genericError -

500 genericError -

isInstanceAliveCall
```
public okhttp3.Call isInstanceAliveCall(ApiCallback _callback)
                                 throws ApiException
```
Build call for isInstanceAlive

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 -

500 genericError -

isInstanceAlive
```
public HealthStatus isInstanceAlive()
                             throws ApiException
```
Check Alive Status This endpoint returns a 200 status code when the HTTP server is up running. This status does currently not include checks whether the database connection is working. 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 -

500 genericError -

isInstanceAliveWithHttpInfo
```
public ApiResponse<HealthStatus> isInstanceAliveWithHttpInfo()
                                                      throws ApiException
```
Check Alive Status This endpoint returns a 200 status code when the HTTP server is up running. This status does currently not include checks whether the database connection is working. 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 -

500 genericError -

isInstanceAliveAsync
```
public okhttp3.Call isInstanceAliveAsync(ApiCallback<HealthStatus> _callback)
                                  throws ApiException
```
Check Alive Status (asynchronously) This endpoint returns a 200 status code when the HTTP server is up running. This status does currently not include checks whether the database connection is working. 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 -

500 genericError -

listOAuth2ClientsCall
```
public okhttp3.Call listOAuth2ClientsCall(Long limit,
                                          Long offset,
                                          ApiCallback _callback)
                                   throws ApiException
```
Build call for listOAuth2Clients

Parameters:

limit - The maximum amount of policies returned, upper bound is 500 policies (optional)

offset - The offset from where to start looking. (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 A list of clients. -

500 genericError -

listOAuth2Clients
```
public List<OAuth2Client> listOAuth2Clients(Long limit,
                                            Long offset)
                                     throws ApiException
```
List OAuth 2.0 Clients This endpoint lists all clients in the database, and never returns client secrets. As a default it lists the first 100 clients. The `limit` parameter can be used to retrieve more clients, but it has an upper bound at 500 objects. Pagination should be used to retrieve more than 500 objects. OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities. To manage ORY Hydra, you will need an OAuth 2.0 Client as well. Make sure that this endpoint is well protected and only callable by first-party components. The \"Link\" header is also included in successful responses, which contains one or more links for pagination, formatted like so: '<https://hydra-url/admin/clients?limit={limit}&offset={offset}>; rel=\"{page}\"', where page is one of the following applicable pages: 'first', 'next', 'last', and 'previous'. Multiple links can be included in this header, and will be separated by a comma.

Parameters:

limit - The maximum amount of policies returned, upper bound is 500 policies (optional)

offset - The offset from where to start looking. (optional)

Returns:

List<OAuth2Client>

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 A list of clients. -

500 genericError -

listOAuth2ClientsWithHttpInfo
```
public ApiResponse<List<OAuth2Client>> listOAuth2ClientsWithHttpInfo(Long limit,
                                                                     Long offset)
                                                              throws ApiException
```
List OAuth 2.0 Clients This endpoint lists all clients in the database, and never returns client secrets. As a default it lists the first 100 clients. The `limit` parameter can be used to retrieve more clients, but it has an upper bound at 500 objects. Pagination should be used to retrieve more than 500 objects. OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities. To manage ORY Hydra, you will need an OAuth 2.0 Client as well. Make sure that this endpoint is well protected and only callable by first-party components. The \"Link\" header is also included in successful responses, which contains one or more links for pagination, formatted like so: '<https://hydra-url/admin/clients?limit={limit}&offset={offset}>; rel=\"{page}\"', where page is one of the following applicable pages: 'first', 'next', 'last', and 'previous'. Multiple links can be included in this header, and will be separated by a comma.

Parameters:

limit - The maximum amount of policies returned, upper bound is 500 policies (optional)

offset - The offset from where to start looking. (optional)

Returns:

ApiResponse<List<OAuth2Client>>

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 A list of clients. -

500 genericError -

listOAuth2ClientsAsync
```
public okhttp3.Call listOAuth2ClientsAsync(Long limit,
                                           Long offset,
                                           ApiCallback<List<OAuth2Client>> _callback)
                                    throws ApiException
```
List OAuth 2.0 Clients (asynchronously) This endpoint lists all clients in the database, and never returns client secrets. As a default it lists the first 100 clients. The `limit` parameter can be used to retrieve more clients, but it has an upper bound at 500 objects. Pagination should be used to retrieve more than 500 objects. OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities. To manage ORY Hydra, you will need an OAuth 2.0 Client as well. Make sure that this endpoint is well protected and only callable by first-party components. The \"Link\" header is also included in successful responses, which contains one or more links for pagination, formatted like so: '<https://hydra-url/admin/clients?limit={limit}&offset={offset}>; rel=\"{page}\"', where page is one of the following applicable pages: 'first', 'next', 'last', and 'previous'. Multiple links can be included in this header, and will be separated by a comma.

Parameters:

limit - The maximum amount of policies returned, upper bound is 500 policies (optional)

offset - The offset from where to start looking. (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 A list of clients. -

500 genericError -

listSubjectConsentSessionsCall
```
public okhttp3.Call listSubjectConsentSessionsCall(String subject,
                                                   ApiCallback _callback)
                                            throws ApiException
```
Build call for listSubjectConsentSessions

Parameters:

subject - (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 A list of used consent requests. -

400 genericError -

500 genericError -

listSubjectConsentSessions
```
public List<PreviousConsentSession> listSubjectConsentSessions(String subject)
                                                        throws ApiException
```
Lists All Consent Sessions of a Subject This endpoint lists all subject's granted consent sessions, including client and granted scope. If the subject is unknown or has not granted any consent sessions yet, the endpoint returns an empty JSON array with status code 200 OK. The \"Link\" header is also included in successful responses, which contains one or more links for pagination, formatted like so: '<https://hydra-url/admin/oauth2/auth/sessions/consent?subject={user}&limit={limit}&offset={offset}>; rel=\"{page}\"', where page is one of the following applicable pages: 'first', 'next', 'last', and 'previous'. Multiple links can be included in this header, and will be separated by a comma.

Parameters:

subject - (required)

Returns:

List<PreviousConsentSession>

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 A list of used consent requests. -

400 genericError -

500 genericError -

listSubjectConsentSessionsWithHttpInfo
```
public ApiResponse<List<PreviousConsentSession>> listSubjectConsentSessionsWithHttpInfo(String subject)
                                                                                 throws ApiException
```
Lists All Consent Sessions of a Subject This endpoint lists all subject's granted consent sessions, including client and granted scope. If the subject is unknown or has not granted any consent sessions yet, the endpoint returns an empty JSON array with status code 200 OK. The \"Link\" header is also included in successful responses, which contains one or more links for pagination, formatted like so: '<https://hydra-url/admin/oauth2/auth/sessions/consent?subject={user}&limit={limit}&offset={offset}>; rel=\"{page}\"', where page is one of the following applicable pages: 'first', 'next', 'last', and 'previous'. Multiple links can be included in this header, and will be separated by a comma.

Parameters:

subject - (required)

Returns:

ApiResponse<List<PreviousConsentSession>>

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 A list of used consent requests. -

400 genericError -

500 genericError -

listSubjectConsentSessionsAsync
```
public okhttp3.Call listSubjectConsentSessionsAsync(String subject,
                                                    ApiCallback<List<PreviousConsentSession>> _callback)
                                             throws ApiException
```
Lists All Consent Sessions of a Subject (asynchronously) This endpoint lists all subject's granted consent sessions, including client and granted scope. If the subject is unknown or has not granted any consent sessions yet, the endpoint returns an empty JSON array with status code 200 OK. The \"Link\" header is also included in successful responses, which contains one or more links for pagination, formatted like so: '<https://hydra-url/admin/oauth2/auth/sessions/consent?subject={user}&limit={limit}&offset={offset}>; rel=\"{page}\"', where page is one of the following applicable pages: 'first', 'next', 'last', and 'previous'. Multiple links can be included in this header, and will be separated by a comma.

Parameters:

subject - (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 A list of used consent requests. -

400 genericError -

500 genericError -

prometheusCall

public okhttp3.Call prometheusCall(ApiCallback _callback)
                            throws ApiException

Build call for prometheus

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	Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201.	-

prometheus

public void prometheus()
                throws ApiException

Get Snapshot Metrics from the Hydra Service. If you're using k8s, you can then add annotations to your deployment like so: ``` metadata: annotations: prometheus.io/port: \"4445\" prometheus.io/path: \"/metrics/prometheus\" ``` If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set.

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.	-

prometheusWithHttpInfo

public ApiResponse<Void> prometheusWithHttpInfo()
                                         throws ApiException

Get Snapshot Metrics from the Hydra Service. If you're using k8s, you can then add annotations to your deployment like so: ``` metadata: annotations: prometheus.io/port: \"4445\" prometheus.io/path: \"/metrics/prometheus\" ``` If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set.

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.	-

prometheusAsync

public okhttp3.Call prometheusAsync(ApiCallback<Void> _callback)
                             throws ApiException

Get Snapshot Metrics from the Hydra Service. (asynchronously) If you're using k8s, you can then add annotations to your deployment like so: ``` metadata: annotations: prometheus.io/port: \"4445\" prometheus.io/path: \"/metrics/prometheus\" ``` If the service supports TLS Edge Termination, this endpoint does not require the `X-Forwarded-Proto` header to be set.

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	Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201.	-

rejectConsentRequestCall

public okhttp3.Call rejectConsentRequestCall(String consentChallenge,
                                             RejectRequest body,
                                             ApiCallback _callback)
                                      throws ApiException

Build call for rejectConsentRequest

Parameters:

consentChallenge - (required)

body - (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	completedRequest	-
404	genericError	-
500	genericError	-

rejectConsentRequest
```
public CompletedRequest rejectConsentRequest(String consentChallenge,
                                             RejectRequest body)
                                      throws ApiException
```
Reject a Consent Request When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider to authenticate the subject and then tell ORY Hydra now about it. If the subject authenticated, he/she must now be asked if the OAuth 2.0 Client which initiated the flow should be allowed to access the resources on the subject's behalf. The consent provider which handles this request and is a web app implemented and hosted by you. It shows a subject interface which asks the subject to grant or deny the client access to the requested scope (\"Application my-dropbox-app wants write access to all your private files\"). The consent challenge is appended to the consent provider's URL to which the subject's user-agent (browser) is redirected to. The consent provider uses that challenge to fetch information on the OAuth2 request and then tells ORY Hydra if the subject accepted or rejected the request. This endpoint tells ORY Hydra that the subject has not authorized the OAuth 2.0 client to access resources on his/her behalf. The consent provider must include a reason why the consent was not granted. The response contains a redirect URL which the consent provider should redirect the user-agent to.

Parameters:

consentChallenge - (required)

body - (optional)

Returns:

CompletedRequest

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 completedRequest -

404 genericError -

500 genericError -

rejectConsentRequestWithHttpInfo
```
public ApiResponse<CompletedRequest> rejectConsentRequestWithHttpInfo(String consentChallenge,
                                                                      RejectRequest body)
                                                               throws ApiException
```
Reject a Consent Request When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider to authenticate the subject and then tell ORY Hydra now about it. If the subject authenticated, he/she must now be asked if the OAuth 2.0 Client which initiated the flow should be allowed to access the resources on the subject's behalf. The consent provider which handles this request and is a web app implemented and hosted by you. It shows a subject interface which asks the subject to grant or deny the client access to the requested scope (\"Application my-dropbox-app wants write access to all your private files\"). The consent challenge is appended to the consent provider's URL to which the subject's user-agent (browser) is redirected to. The consent provider uses that challenge to fetch information on the OAuth2 request and then tells ORY Hydra if the subject accepted or rejected the request. This endpoint tells ORY Hydra that the subject has not authorized the OAuth 2.0 client to access resources on his/her behalf. The consent provider must include a reason why the consent was not granted. The response contains a redirect URL which the consent provider should redirect the user-agent to.

Parameters:

consentChallenge - (required)

body - (optional)

Returns:

ApiResponse<CompletedRequest>

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 completedRequest -

404 genericError -

500 genericError -

rejectConsentRequestAsync
```
public okhttp3.Call rejectConsentRequestAsync(String consentChallenge,
                                              RejectRequest body,
                                              ApiCallback<CompletedRequest> _callback)
                                       throws ApiException
```
Reject a Consent Request (asynchronously) When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider to authenticate the subject and then tell ORY Hydra now about it. If the subject authenticated, he/she must now be asked if the OAuth 2.0 Client which initiated the flow should be allowed to access the resources on the subject's behalf. The consent provider which handles this request and is a web app implemented and hosted by you. It shows a subject interface which asks the subject to grant or deny the client access to the requested scope (\"Application my-dropbox-app wants write access to all your private files\"). The consent challenge is appended to the consent provider's URL to which the subject's user-agent (browser) is redirected to. The consent provider uses that challenge to fetch information on the OAuth2 request and then tells ORY Hydra if the subject accepted or rejected the request. This endpoint tells ORY Hydra that the subject has not authorized the OAuth 2.0 client to access resources on his/her behalf. The consent provider must include a reason why the consent was not granted. The response contains a redirect URL which the consent provider should redirect the user-agent to.

Parameters:

consentChallenge - (required)

body - (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 completedRequest -

404 genericError -

500 genericError -

rejectLoginRequestCall

public okhttp3.Call rejectLoginRequestCall(String loginChallenge,
                                           RejectRequest body,
                                           ApiCallback _callback)
                                    throws ApiException

Build call for rejectLoginRequest

Parameters:

loginChallenge - (required)

body - (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	completedRequest	-
400	genericError	-
401	genericError	-
404	genericError	-
500	genericError	-

rejectLoginRequest

public CompletedRequest rejectLoginRequest(String loginChallenge,
                                           RejectRequest body)
                                    throws ApiException

Reject a Login Request When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider (sometimes called \"identity provider\") to authenticate the subject and then tell ORY Hydra now about it. The login provider is an web-app you write and host, and it must be able to authenticate (\"show the subject a login screen\") a subject (in OAuth2 the proper name for subject is \"resource owner\"). The authentication challenge is appended to the login provider URL to which the subject's user-agent (browser) is redirected to. The login provider uses that challenge to fetch information on the OAuth2 request and then accept or reject the requested authentication process. This endpoint tells ORY Hydra that the subject has not authenticated and includes a reason why the authentication was be denied. The response contains a redirect URL which the login provider should redirect the user-agent to.

Parameters:

loginChallenge - (required)

body - (optional)

Returns:

CompletedRequest

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	completedRequest	-
400	genericError	-
401	genericError	-
404	genericError	-
500	genericError	-

rejectLoginRequestWithHttpInfo

public ApiResponse<CompletedRequest> rejectLoginRequestWithHttpInfo(String loginChallenge,
                                                                    RejectRequest body)
                                                             throws ApiException

Reject a Login Request When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider (sometimes called \"identity provider\") to authenticate the subject and then tell ORY Hydra now about it. The login provider is an web-app you write and host, and it must be able to authenticate (\"show the subject a login screen\") a subject (in OAuth2 the proper name for subject is \"resource owner\"). The authentication challenge is appended to the login provider URL to which the subject's user-agent (browser) is redirected to. The login provider uses that challenge to fetch information on the OAuth2 request and then accept or reject the requested authentication process. This endpoint tells ORY Hydra that the subject has not authenticated and includes a reason why the authentication was be denied. The response contains a redirect URL which the login provider should redirect the user-agent to.

Parameters:

loginChallenge - (required)

body - (optional)

Returns:

ApiResponse<CompletedRequest>

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	completedRequest	-
400	genericError	-
401	genericError	-
404	genericError	-
500	genericError	-

rejectLoginRequestAsync

public okhttp3.Call rejectLoginRequestAsync(String loginChallenge,
                                            RejectRequest body,
                                            ApiCallback<CompletedRequest> _callback)
                                     throws ApiException

Reject a Login Request (asynchronously) When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, ORY Hydra asks the login provider (sometimes called \"identity provider\") to authenticate the subject and then tell ORY Hydra now about it. The login provider is an web-app you write and host, and it must be able to authenticate (\"show the subject a login screen\") a subject (in OAuth2 the proper name for subject is \"resource owner\"). The authentication challenge is appended to the login provider URL to which the subject's user-agent (browser) is redirected to. The login provider uses that challenge to fetch information on the OAuth2 request and then accept or reject the requested authentication process. This endpoint tells ORY Hydra that the subject has not authenticated and includes a reason why the authentication was be denied. The response contains a redirect URL which the login provider should redirect the user-agent to.

Parameters:

loginChallenge - (required)

body - (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	completedRequest	-
400	genericError	-
401	genericError	-
404	genericError	-
500	genericError	-

rejectLogoutRequestCall

public okhttp3.Call rejectLogoutRequestCall(String logoutChallenge,
                                            RejectRequest body,
                                            ApiCallback _callback)
                                     throws ApiException

Build call for rejectLogoutRequest

Parameters:

logoutChallenge - (required)

body - (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
204	Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201.	-
404	genericError	-
500	genericError	-

rejectLogoutRequest

public void rejectLogoutRequest(String logoutChallenge,
                                RejectRequest body)
                         throws ApiException

Reject a Logout Request When a user or an application requests ORY Hydra to log out a user, this endpoint is used to deny that logout request. No body is required. The response is empty as the logout provider has to chose what action to perform next.

Parameters:

logoutChallenge - (required)

body - (optional)

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
204	Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201.	-
404	genericError	-
500	genericError	-

rejectLogoutRequestWithHttpInfo

public ApiResponse<Void> rejectLogoutRequestWithHttpInfo(String logoutChallenge,
                                                         RejectRequest body)
                                                  throws ApiException

Reject a Logout Request When a user or an application requests ORY Hydra to log out a user, this endpoint is used to deny that logout request. No body is required. The response is empty as the logout provider has to chose what action to perform next.

Parameters:

logoutChallenge - (required)

body - (optional)

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
204	Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201.	-
404	genericError	-
500	genericError	-

rejectLogoutRequestAsync

public okhttp3.Call rejectLogoutRequestAsync(String logoutChallenge,
                                             RejectRequest body,
                                             ApiCallback<Void> _callback)
                                      throws ApiException

Reject a Logout Request (asynchronously) When a user or an application requests ORY Hydra to log out a user, this endpoint is used to deny that logout request. No body is required. The response is empty as the logout provider has to chose what action to perform next.

Parameters:

logoutChallenge - (required)

body - (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
204	Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201.	-
404	genericError	-
500	genericError	-

revokeAuthenticationSessionCall

public okhttp3.Call revokeAuthenticationSessionCall(String subject,
                                                    ApiCallback _callback)
                                             throws ApiException

Build call for revokeAuthenticationSession

Parameters:

subject - (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
204	Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201.	-
400	genericError	-
404	genericError	-
500	genericError	-

revokeAuthenticationSession

public void revokeAuthenticationSession(String subject)
                                 throws ApiException

Invalidates All Login Sessions of a Certain User Invalidates a Subject's Authentication Session This endpoint invalidates a subject's authentication session. After revoking the authentication session, the subject has to re-authenticate at ORY Hydra. This endpoint does not invalidate any tokens and does not work with OpenID Connect Front- or Back-channel logout.

Parameters:

subject - (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
204	Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201.	-
400	genericError	-
404	genericError	-
500	genericError	-

revokeAuthenticationSessionWithHttpInfo

public ApiResponse<Void> revokeAuthenticationSessionWithHttpInfo(String subject)
                                                          throws ApiException

Invalidates All Login Sessions of a Certain User Invalidates a Subject's Authentication Session This endpoint invalidates a subject's authentication session. After revoking the authentication session, the subject has to re-authenticate at ORY Hydra. This endpoint does not invalidate any tokens and does not work with OpenID Connect Front- or Back-channel logout.

Parameters:

subject - (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
204	Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201.	-
400	genericError	-
404	genericError	-
500	genericError	-

revokeAuthenticationSessionAsync

public okhttp3.Call revokeAuthenticationSessionAsync(String subject,
                                                     ApiCallback<Void> _callback)
                                              throws ApiException

Invalidates All Login Sessions of a Certain User Invalidates a Subject's Authentication Session (asynchronously) This endpoint invalidates a subject's authentication session. After revoking the authentication session, the subject has to re-authenticate at ORY Hydra. This endpoint does not invalidate any tokens and does not work with OpenID Connect Front- or Back-channel logout.

Parameters:

subject - (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
204	Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201.	-
400	genericError	-
404	genericError	-
500	genericError	-

revokeConsentSessionsCall

public okhttp3.Call revokeConsentSessionsCall(String subject,
                                              String client,
                                              Boolean all,
                                              ApiCallback _callback)
                                       throws ApiException

Build call for revokeConsentSessions

Parameters:

subject - The subject (Subject) who's consent sessions should be deleted. (required)

client - If set, deletes only those consent sessions by the Subject that have been granted to the specified OAuth 2.0 Client ID (optional)

all - If set to `?all=true`, deletes all consent sessions by the Subject that have been granted. (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
204	Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201.	-
400	genericError	-
404	genericError	-
500	genericError	-

revokeConsentSessions

public void revokeConsentSessions(String subject,
                                  String client,
                                  Boolean all)
                           throws ApiException

Revokes Consent Sessions of a Subject for a Specific OAuth 2.0 Client This endpoint revokes a subject's granted consent sessions for a specific OAuth 2.0 Client and invalidates all associated OAuth 2.0 Access Tokens.

Parameters:

subject - The subject (Subject) who's consent sessions should be deleted. (required)

client - If set, deletes only those consent sessions by the Subject that have been granted to the specified OAuth 2.0 Client ID (optional)

all - If set to `?all=true`, deletes all consent sessions by the Subject that have been granted. (optional)

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
204	Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201.	-
400	genericError	-
404	genericError	-
500	genericError	-

revokeConsentSessionsWithHttpInfo

public ApiResponse<Void> revokeConsentSessionsWithHttpInfo(String subject,
                                                           String client,
                                                           Boolean all)
                                                    throws ApiException

Revokes Consent Sessions of a Subject for a Specific OAuth 2.0 Client This endpoint revokes a subject's granted consent sessions for a specific OAuth 2.0 Client and invalidates all associated OAuth 2.0 Access Tokens.

Parameters:

subject - The subject (Subject) who's consent sessions should be deleted. (required)

client - If set, deletes only those consent sessions by the Subject that have been granted to the specified OAuth 2.0 Client ID (optional)

all - If set to `?all=true`, deletes all consent sessions by the Subject that have been granted. (optional)

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
204	Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201.	-
400	genericError	-
404	genericError	-
500	genericError	-

revokeConsentSessionsAsync

public okhttp3.Call revokeConsentSessionsAsync(String subject,
                                               String client,
                                               Boolean all,
                                               ApiCallback<Void> _callback)
                                        throws ApiException

Revokes Consent Sessions of a Subject for a Specific OAuth 2.0 Client (asynchronously) This endpoint revokes a subject's granted consent sessions for a specific OAuth 2.0 Client and invalidates all associated OAuth 2.0 Access Tokens.

Parameters:

subject - The subject (Subject) who's consent sessions should be deleted. (required)

client - If set, deletes only those consent sessions by the Subject that have been granted to the specified OAuth 2.0 Client ID (optional)

all - If set to `?all=true`, deletes all consent sessions by the Subject that have been granted. (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
204	Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 201.	-
400	genericError	-
404	genericError	-
500	genericError	-

updateJsonWebKeyCall

public okhttp3.Call updateJsonWebKeyCall(String kid,
                                         String set,
                                         JSONWebKey body,
                                         ApiCallback _callback)
                                  throws ApiException

Build call for updateJsonWebKey

Parameters:

kid - The kid of the desired key (required)

set - The set (required)

body - (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	JSONWebKey	-
401	genericError	-
403	genericError	-
500	genericError	-

updateJsonWebKey
```
public JSONWebKey updateJsonWebKey(String kid,
                                   String set,
                                   JSONWebKey body)
                            throws ApiException
```
Update a JSON Web Key Use this method if you do not want to let Hydra generate the JWKs for you, but instead save your own. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.

Parameters:

kid - The kid of the desired key (required)

set - The set (required)

body - (optional)

Returns:

JSONWebKey

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 JSONWebKey -

401 genericError -

403 genericError -

500 genericError -

updateJsonWebKeyWithHttpInfo
```
public ApiResponse<JSONWebKey> updateJsonWebKeyWithHttpInfo(String kid,
                                                            String set,
                                                            JSONWebKey body)
                                                     throws ApiException
```
Update a JSON Web Key Use this method if you do not want to let Hydra generate the JWKs for you, but instead save your own. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.

Parameters:

kid - The kid of the desired key (required)

set - The set (required)

body - (optional)

Returns:

ApiResponse<JSONWebKey>

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 JSONWebKey -

401 genericError -

403 genericError -

500 genericError -

updateJsonWebKeyAsync
```
public okhttp3.Call updateJsonWebKeyAsync(String kid,
                                          String set,
                                          JSONWebKey body,
                                          ApiCallback<JSONWebKey> _callback)
                                   throws ApiException
```
Update a JSON Web Key (asynchronously) Use this method if you do not want to let Hydra generate the JWKs for you, but instead save your own. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.

Parameters:

kid - The kid of the desired key (required)

set - The set (required)

body - (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 JSONWebKey -

401 genericError -

403 genericError -

500 genericError -

updateJsonWebKeySetCall
```
public okhttp3.Call updateJsonWebKeySetCall(String set,
                                            JSONWebKeySet body,
                                            ApiCallback _callback)
                                     throws ApiException
```
Build call for updateJsonWebKeySet

Parameters:

set - The set (required)

body - (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 JSONWebKeySet -

401 genericError -

403 genericError -

500 genericError -

updateJsonWebKeySet
```
public JSONWebKeySet updateJsonWebKeySet(String set,
                                         JSONWebKeySet body)
                                  throws ApiException
```
Update a JSON Web Key Set Use this method if you do not want to let Hydra generate the JWKs for you, but instead save your own. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.

Parameters:

set - The set (required)

body - (optional)

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 -

401 genericError -

403 genericError -

500 genericError -

updateJsonWebKeySetWithHttpInfo
```
public ApiResponse<JSONWebKeySet> updateJsonWebKeySetWithHttpInfo(String set,
                                                                  JSONWebKeySet body)
                                                           throws ApiException
```
Update a JSON Web Key Set Use this method if you do not want to let Hydra generate the JWKs for you, but instead save your own. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.

Parameters:

set - The set (required)

body - (optional)

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 -

401 genericError -

403 genericError -

500 genericError -

updateJsonWebKeySetAsync
```
public okhttp3.Call updateJsonWebKeySetAsync(String set,
                                             JSONWebKeySet body,
                                             ApiCallback<JSONWebKeySet> _callback)
                                      throws ApiException
```
Update a JSON Web Key Set (asynchronously) Use this method if you do not want to let Hydra generate the JWKs for you, but instead save your own. A JSON Web Key (JWK) is a JavaScript Object Notation (JSON) data structure that represents a cryptographic key. A JWK Set is a JSON data structure that represents a set of JWKs. A JSON Web Key is identified by its set and key id. ORY Hydra uses this functionality to store cryptographic keys used for TLS and JSON Web Tokens (such as OpenID Connect ID tokens), and allows storing user-defined keys as well.

Parameters:

set - The set (required)

body - (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 JSONWebKeySet -

401 genericError -

403 genericError -

500 genericError -

updateOAuth2ClientCall

public okhttp3.Call updateOAuth2ClientCall(String id,
                                           OAuth2Client body,
                                           ApiCallback _callback)
                                    throws ApiException

Build call for updateOAuth2Client

Parameters:

id - (required)

body - (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	oAuth2Client	-
500	genericError	-

updateOAuth2Client
```
public OAuth2Client updateOAuth2Client(String id,
                                       OAuth2Client body)
                                throws ApiException
```
Update an OAuth 2.0 Client Update an existing OAuth 2.0 Client. If you pass `client_secret` the secret will be updated and returned via the API. This is the only time you will be able to retrieve the client secret, so write it down and keep it safe. OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities. To manage ORY Hydra, you will need an OAuth 2.0 Client as well. Make sure that this endpoint is well protected and only callable by first-party components.

Parameters:

id - (required)

body - (required)

Returns:

OAuth2Client

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 oAuth2Client -

500 genericError -

updateOAuth2ClientWithHttpInfo
```
public ApiResponse<OAuth2Client> updateOAuth2ClientWithHttpInfo(String id,
                                                                OAuth2Client body)
                                                         throws ApiException
```
Update an OAuth 2.0 Client Update an existing OAuth 2.0 Client. If you pass `client_secret` the secret will be updated and returned via the API. This is the only time you will be able to retrieve the client secret, so write it down and keep it safe. OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities. To manage ORY Hydra, you will need an OAuth 2.0 Client as well. Make sure that this endpoint is well protected and only callable by first-party components.

Parameters:

id - (required)

body - (required)

Returns:

ApiResponse<OAuth2Client>

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 oAuth2Client -

500 genericError -

updateOAuth2ClientAsync
```
public okhttp3.Call updateOAuth2ClientAsync(String id,
                                            OAuth2Client body,
                                            ApiCallback<OAuth2Client> _callback)
                                     throws ApiException
```
Update an OAuth 2.0 Client (asynchronously) Update an existing OAuth 2.0 Client. If you pass `client_secret` the secret will be updated and returned via the API. This is the only time you will be able to retrieve the client secret, so write it down and keep it safe. OAuth 2.0 clients are used to perform OAuth 2.0 and OpenID Connect flows. Usually, OAuth 2.0 clients are generated for applications which want to consume your OAuth 2.0 or OpenID Connect capabilities. To manage ORY Hydra, you will need an OAuth 2.0 Client as well. Make sure that this endpoint is well protected and only callable by first-party components.

Parameters:

id - (required)

body - (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 oAuth2Client -

500 genericError -

Class AdminApi

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

AdminApi

AdminApi

Method Detail

getApiClient

setApiClient

acceptConsentRequestCall

acceptConsentRequest

acceptConsentRequestWithHttpInfo

acceptConsentRequestAsync

acceptLoginRequestCall

acceptLoginRequest

acceptLoginRequestWithHttpInfo

acceptLoginRequestAsync

acceptLogoutRequestCall

acceptLogoutRequest

acceptLogoutRequestWithHttpInfo

acceptLogoutRequestAsync

createJsonWebKeySetCall

createJsonWebKeySet

createJsonWebKeySetWithHttpInfo

createJsonWebKeySetAsync

createOAuth2ClientCall

createOAuth2Client

createOAuth2ClientWithHttpInfo

createOAuth2ClientAsync

deleteJsonWebKeyCall

deleteJsonWebKey

deleteJsonWebKeyWithHttpInfo

deleteJsonWebKeyAsync

deleteJsonWebKeySetCall

deleteJsonWebKeySet

deleteJsonWebKeySetWithHttpInfo

deleteJsonWebKeySetAsync

deleteOAuth2ClientCall

deleteOAuth2Client

deleteOAuth2ClientWithHttpInfo

deleteOAuth2ClientAsync

deleteOAuth2TokenCall

deleteOAuth2Token

deleteOAuth2TokenWithHttpInfo

deleteOAuth2TokenAsync

flushInactiveOAuth2TokensCall

flushInactiveOAuth2Tokens

flushInactiveOAuth2TokensWithHttpInfo

flushInactiveOAuth2TokensAsync

getConsentRequestCall

getConsentRequest

getConsentRequestWithHttpInfo

getConsentRequestAsync

getJsonWebKeyCall

getJsonWebKey

getJsonWebKeyWithHttpInfo

getJsonWebKeyAsync

getJsonWebKeySetCall

getJsonWebKeySet

getJsonWebKeySetWithHttpInfo

getJsonWebKeySetAsync

getLoginRequestCall

getLoginRequest

getLoginRequestWithHttpInfo

getLoginRequestAsync

getLogoutRequestCall

getLogoutRequest

getLogoutRequestWithHttpInfo

getLogoutRequestAsync

getOAuth2ClientCall

getOAuth2Client

getOAuth2ClientWithHttpInfo

getOAuth2ClientAsync

getVersionCall

getVersion

getVersionWithHttpInfo

getVersionAsync

introspectOAuth2TokenCall

introspectOAuth2Token