# OryClient::AdminApi

All URIs are relative to *https://playground.projects.oryapis.com*

| Method | HTTP request | Description |
| ------ | ------------ | ----------- |
| [**accept_consent_request**](AdminApi.md#accept_consent_request) | **PUT** /oauth2/auth/requests/consent/accept | Accept a Consent Request |
| [**accept_login_request**](AdminApi.md#accept_login_request) | **PUT** /oauth2/auth/requests/login/accept | Accept a Login Request |
| [**accept_logout_request**](AdminApi.md#accept_logout_request) | **PUT** /oauth2/auth/requests/logout/accept | Accept a Logout Request |
| [**create_json_web_key_set**](AdminApi.md#create_json_web_key_set) | **POST** /keys/{set} | Generate a New JSON Web Key |
| [**create_o_auth2_client**](AdminApi.md#create_o_auth2_client) | **POST** /clients | Create an OAuth 2.0 Client |
| [**delete_json_web_key**](AdminApi.md#delete_json_web_key) | **DELETE** /keys/{set}/{kid} | Delete a JSON Web Key |
| [**delete_json_web_key_set**](AdminApi.md#delete_json_web_key_set) | **DELETE** /keys/{set} | Delete a JSON Web Key Set |
| [**delete_o_auth2_client**](AdminApi.md#delete_o_auth2_client) | **DELETE** /clients/{id} | Deletes an OAuth 2.0 Client |
| [**delete_o_auth2_token**](AdminApi.md#delete_o_auth2_token) | **DELETE** /oauth2/tokens | Delete OAuth2 Access Tokens from a Client |
| [**delete_trusted_jwt_grant_issuer**](AdminApi.md#delete_trusted_jwt_grant_issuer) | **DELETE** /trust/grants/jwt-bearer/issuers/{id} | Delete a Trusted OAuth2 JWT Bearer Grant Type Issuer |
| [**flush_inactive_o_auth2_tokens**](AdminApi.md#flush_inactive_o_auth2_tokens) | **POST** /oauth2/flush | Flush Expired OAuth2 Access Tokens |
| [**get_consent_request**](AdminApi.md#get_consent_request) | **GET** /oauth2/auth/requests/consent | Get Consent Request Information |
| [**get_json_web_key**](AdminApi.md#get_json_web_key) | **GET** /keys/{set}/{kid} | Fetch a JSON Web Key |
| [**get_json_web_key_set**](AdminApi.md#get_json_web_key_set) | **GET** /keys/{set} | Retrieve a JSON Web Key Set |
| [**get_login_request**](AdminApi.md#get_login_request) | **GET** /oauth2/auth/requests/login | Get a Login Request |
| [**get_logout_request**](AdminApi.md#get_logout_request) | **GET** /oauth2/auth/requests/logout | Get a Logout Request |
| [**get_o_auth2_client**](AdminApi.md#get_o_auth2_client) | **GET** /clients/{id} | Get an OAuth 2.0 Client |
| [**get_trusted_jwt_grant_issuer**](AdminApi.md#get_trusted_jwt_grant_issuer) | **GET** /trust/grants/jwt-bearer/issuers/{id} | Get a Trusted OAuth2 JWT Bearer Grant Type Issuer |
| [**introspect_o_auth2_token**](AdminApi.md#introspect_o_auth2_token) | **POST** /oauth2/introspect | Introspect OAuth2 Tokens |
| [**list_o_auth2_clients**](AdminApi.md#list_o_auth2_clients) | **GET** /clients | List OAuth 2.0 Clients |
| [**list_subject_consent_sessions**](AdminApi.md#list_subject_consent_sessions) | **GET** /oauth2/auth/sessions/consent | Lists All Consent Sessions of a Subject |
| [**list_trusted_jwt_grant_issuers**](AdminApi.md#list_trusted_jwt_grant_issuers) | **GET** /trust/grants/jwt-bearer/issuers | List Trusted OAuth2 JWT Bearer Grant Type Issuers |
| [**patch_o_auth2_client**](AdminApi.md#patch_o_auth2_client) | **PATCH** /clients/{id} | Patch an OAuth 2.0 Client |
| [**reject_consent_request**](AdminApi.md#reject_consent_request) | **PUT** /oauth2/auth/requests/consent/reject | Reject a Consent Request |
| [**reject_login_request**](AdminApi.md#reject_login_request) | **PUT** /oauth2/auth/requests/login/reject | Reject a Login Request |
| [**reject_logout_request**](AdminApi.md#reject_logout_request) | **PUT** /oauth2/auth/requests/logout/reject | Reject a Logout Request |
| [**revoke_authentication_session**](AdminApi.md#revoke_authentication_session) | **DELETE** /oauth2/auth/sessions/login | Invalidates All Login Sessions of a Certain User Invalidates a Subject's Authentication Session |
| [**revoke_consent_sessions**](AdminApi.md#revoke_consent_sessions) | **DELETE** /oauth2/auth/sessions/consent | Revokes Consent Sessions of a Subject for a Specific OAuth 2.0 Client |
| [**trust_jwt_grant_issuer**](AdminApi.md#trust_jwt_grant_issuer) | **POST** /trust/grants/jwt-bearer/issuers | Trust an OAuth2 JWT Bearer Grant Type Issuer |
| [**update_json_web_key**](AdminApi.md#update_json_web_key) | **PUT** /keys/{set}/{kid} | Update a JSON Web Key |
| [**update_json_web_key_set**](AdminApi.md#update_json_web_key_set) | **PUT** /keys/{set} | Update a JSON Web Key Set |
| [**update_o_auth2_client**](AdminApi.md#update_o_auth2_client) | **PUT** /clients/{id} | Update an OAuth 2.0 Client |


## accept_consent_request

> <CompletedRequest> accept_consent_request(consent_challenge, opts)

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.

### Examples

```ruby
require 'time'
require 'ory-client'

api_instance = OryClient::AdminApi.new
consent_challenge = 'consent_challenge_example' # String | 
opts = {
  accept_consent_request: OryClient::AcceptConsentRequest.new # AcceptConsentRequest | 
}

begin
  # Accept a Consent Request
  result = api_instance.accept_consent_request(consent_challenge, opts)
  p result
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->accept_consent_request: #{e}"
end
```

#### Using the accept_consent_request_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<CompletedRequest>, Integer, Hash)> accept_consent_request_with_http_info(consent_challenge, opts)

```ruby
begin
  # Accept a Consent Request
  data, status_code, headers = api_instance.accept_consent_request_with_http_info(consent_challenge, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CompletedRequest>
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->accept_consent_request_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **consent_challenge** | **String** |  |  |
| **accept_consent_request** | [**AcceptConsentRequest**](AcceptConsentRequest.md) |  | [optional] |

### Return type

[**CompletedRequest**](CompletedRequest.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json


## accept_login_request

> <CompletedRequest> accept_login_request(login_challenge, opts)

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.

### Examples

```ruby
require 'time'
require 'ory-client'

api_instance = OryClient::AdminApi.new
login_challenge = 'login_challenge_example' # String | 
opts = {
  accept_login_request: OryClient::AcceptLoginRequest.new({subject: 'subject_example'}) # AcceptLoginRequest | 
}

begin
  # Accept a Login Request
  result = api_instance.accept_login_request(login_challenge, opts)
  p result
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->accept_login_request: #{e}"
end
```

#### Using the accept_login_request_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<CompletedRequest>, Integer, Hash)> accept_login_request_with_http_info(login_challenge, opts)

```ruby
begin
  # Accept a Login Request
  data, status_code, headers = api_instance.accept_login_request_with_http_info(login_challenge, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CompletedRequest>
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->accept_login_request_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **login_challenge** | **String** |  |  |
| **accept_login_request** | [**AcceptLoginRequest**](AcceptLoginRequest.md) |  | [optional] |

### Return type

[**CompletedRequest**](CompletedRequest.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json


## accept_logout_request

> <CompletedRequest> accept_logout_request(logout_challenge)

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.

### Examples

```ruby
require 'time'
require 'ory-client'

api_instance = OryClient::AdminApi.new
logout_challenge = 'logout_challenge_example' # String | 

begin
  # Accept a Logout Request
  result = api_instance.accept_logout_request(logout_challenge)
  p result
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->accept_logout_request: #{e}"
end
```

#### Using the accept_logout_request_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<CompletedRequest>, Integer, Hash)> accept_logout_request_with_http_info(logout_challenge)

```ruby
begin
  # Accept a Logout Request
  data, status_code, headers = api_instance.accept_logout_request_with_http_info(logout_challenge)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CompletedRequest>
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->accept_logout_request_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **logout_challenge** | **String** |  |  |

### Return type

[**CompletedRequest**](CompletedRequest.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json


## create_json_web_key_set

> <JSONWebKeySet> create_json_web_key_set(set, opts)

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.

### Examples

```ruby
require 'time'
require 'ory-client'

api_instance = OryClient::AdminApi.new
set = 'set_example' # String | The set
opts = {
  json_web_key_set_generator_request: OryClient::JsonWebKeySetGeneratorRequest.new({alg: 'alg_example', kid: 'kid_example', use: 'use_example'}) # JsonWebKeySetGeneratorRequest | 
}

begin
  # Generate a New JSON Web Key
  result = api_instance.create_json_web_key_set(set, opts)
  p result
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->create_json_web_key_set: #{e}"
end
```

#### Using the create_json_web_key_set_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<JSONWebKeySet>, Integer, Hash)> create_json_web_key_set_with_http_info(set, opts)

```ruby
begin
  # Generate a New JSON Web Key
  data, status_code, headers = api_instance.create_json_web_key_set_with_http_info(set, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <JSONWebKeySet>
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->create_json_web_key_set_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **set** | **String** | The set |  |
| **json_web_key_set_generator_request** | [**JsonWebKeySetGeneratorRequest**](JsonWebKeySetGeneratorRequest.md) |  | [optional] |

### Return type

[**JSONWebKeySet**](JSONWebKeySet.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json


## create_o_auth2_client

> <OAuth2Client> create_o_auth2_client(o_auth2_client)

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.

### Examples

```ruby
require 'time'
require 'ory-client'

api_instance = OryClient::AdminApi.new
o_auth2_client = OryClient::OAuth2Client.new # OAuth2Client | 

begin
  # Create an OAuth 2.0 Client
  result = api_instance.create_o_auth2_client(o_auth2_client)
  p result
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->create_o_auth2_client: #{e}"
end
```

#### Using the create_o_auth2_client_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<OAuth2Client>, Integer, Hash)> create_o_auth2_client_with_http_info(o_auth2_client)

```ruby
begin
  # Create an OAuth 2.0 Client
  data, status_code, headers = api_instance.create_o_auth2_client_with_http_info(o_auth2_client)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <OAuth2Client>
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->create_o_auth2_client_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **o_auth2_client** | [**OAuth2Client**](OAuth2Client.md) |  |  |

### Return type

[**OAuth2Client**](OAuth2Client.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json


## delete_json_web_key

> delete_json_web_key(kid, set)

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.

### Examples

```ruby
require 'time'
require 'ory-client'

api_instance = OryClient::AdminApi.new
kid = 'kid_example' # String | The kid of the desired key
set = 'set_example' # String | The set

begin
  # Delete a JSON Web Key
  api_instance.delete_json_web_key(kid, set)
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->delete_json_web_key: #{e}"
end
```

#### Using the delete_json_web_key_with_http_info variant

This returns an Array which contains the response data (`nil` in this case), status code and headers.

> <Array(nil, Integer, Hash)> delete_json_web_key_with_http_info(kid, set)

```ruby
begin
  # Delete a JSON Web Key
  data, status_code, headers = api_instance.delete_json_web_key_with_http_info(kid, set)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->delete_json_web_key_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **kid** | **String** | The kid of the desired key |  |
| **set** | **String** | The set |  |

### Return type

nil (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json


## delete_json_web_key_set

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

### Examples

```ruby
require 'time'
require 'ory-client'

api_instance = OryClient::AdminApi.new
set = 'set_example' # String | The set

begin
  # Delete a JSON Web Key Set
  api_instance.delete_json_web_key_set(set)
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->delete_json_web_key_set: #{e}"
end
```

#### Using the delete_json_web_key_set_with_http_info variant

This returns an Array which contains the response data (`nil` in this case), status code and headers.

> <Array(nil, Integer, Hash)> delete_json_web_key_set_with_http_info(set)

```ruby
begin
  # Delete a JSON Web Key Set
  data, status_code, headers = api_instance.delete_json_web_key_set_with_http_info(set)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->delete_json_web_key_set_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **set** | **String** | The set |  |

### Return type

nil (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json


## delete_o_auth2_client

> delete_o_auth2_client(id)

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.  Make sure that this endpoint is well protected and only callable by first-party components.

### Examples

```ruby
require 'time'
require 'ory-client'

api_instance = OryClient::AdminApi.new
id = 'id_example' # String | The id of the OAuth 2.0 Client.

begin
  # Deletes an OAuth 2.0 Client
  api_instance.delete_o_auth2_client(id)
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->delete_o_auth2_client: #{e}"
end
```

#### Using the delete_o_auth2_client_with_http_info variant

This returns an Array which contains the response data (`nil` in this case), status code and headers.

> <Array(nil, Integer, Hash)> delete_o_auth2_client_with_http_info(id)

```ruby
begin
  # Deletes an OAuth 2.0 Client
  data, status_code, headers = api_instance.delete_o_auth2_client_with_http_info(id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->delete_o_auth2_client_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **id** | **String** | The id of the OAuth 2.0 Client. |  |

### Return type

nil (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json


## delete_o_auth2_token

> delete_o_auth2_token(client_id)

Delete OAuth2 Access Tokens from a Client

This endpoint deletes OAuth2 access tokens issued for a client from the database

### Examples

```ruby
require 'time'
require 'ory-client'

api_instance = OryClient::AdminApi.new
client_id = 'client_id_example' # String | 

begin
  # Delete OAuth2 Access Tokens from a Client
  api_instance.delete_o_auth2_token(client_id)
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->delete_o_auth2_token: #{e}"
end
```

#### Using the delete_o_auth2_token_with_http_info variant

This returns an Array which contains the response data (`nil` in this case), status code and headers.

> <Array(nil, Integer, Hash)> delete_o_auth2_token_with_http_info(client_id)

```ruby
begin
  # Delete OAuth2 Access Tokens from a Client
  data, status_code, headers = api_instance.delete_o_auth2_token_with_http_info(client_id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->delete_o_auth2_token_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **client_id** | **String** |  |  |

### Return type

nil (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json


## delete_trusted_jwt_grant_issuer

> delete_trusted_jwt_grant_issuer(id)

Delete a Trusted OAuth2 JWT Bearer Grant Type Issuer

Use this endpoint to delete trusted JWT Bearer Grant Type Issuer. The ID is the one returned when you created the trust relationship.  Once deleted, the associated issuer will no longer be able to perform the JSON Web Token (JWT) Profile for OAuth 2.0 Client Authentication and Authorization Grant.

### Examples

```ruby
require 'time'
require 'ory-client'

api_instance = OryClient::AdminApi.new
id = 'id_example' # String | The id of the desired grant

begin
  # Delete a Trusted OAuth2 JWT Bearer Grant Type Issuer
  api_instance.delete_trusted_jwt_grant_issuer(id)
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->delete_trusted_jwt_grant_issuer: #{e}"
end
```

#### Using the delete_trusted_jwt_grant_issuer_with_http_info variant

This returns an Array which contains the response data (`nil` in this case), status code and headers.

> <Array(nil, Integer, Hash)> delete_trusted_jwt_grant_issuer_with_http_info(id)

```ruby
begin
  # Delete a Trusted OAuth2 JWT Bearer Grant Type Issuer
  data, status_code, headers = api_instance.delete_trusted_jwt_grant_issuer_with_http_info(id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->delete_trusted_jwt_grant_issuer_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **id** | **String** | The id of the desired grant |  |

### Return type

nil (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json


## flush_inactive_o_auth2_tokens

> flush_inactive_o_auth2_tokens(opts)

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.

### Examples

```ruby
require 'time'
require 'ory-client'

api_instance = OryClient::AdminApi.new
opts = {
  flush_inactive_o_auth2_tokens_request: OryClient::FlushInactiveOAuth2TokensRequest.new # FlushInactiveOAuth2TokensRequest | 
}

begin
  # Flush Expired OAuth2 Access Tokens
  api_instance.flush_inactive_o_auth2_tokens(opts)
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->flush_inactive_o_auth2_tokens: #{e}"
end
```

#### Using the flush_inactive_o_auth2_tokens_with_http_info variant

This returns an Array which contains the response data (`nil` in this case), status code and headers.

> <Array(nil, Integer, Hash)> flush_inactive_o_auth2_tokens_with_http_info(opts)

```ruby
begin
  # Flush Expired OAuth2 Access Tokens
  data, status_code, headers = api_instance.flush_inactive_o_auth2_tokens_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->flush_inactive_o_auth2_tokens_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **flush_inactive_o_auth2_tokens_request** | [**FlushInactiveOAuth2TokensRequest**](FlushInactiveOAuth2TokensRequest.md) |  | [optional] |

### Return type

nil (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json


## get_consent_request

> <ConsentRequest> get_consent_request(consent_challenge)

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.

### Examples

```ruby
require 'time'
require 'ory-client'

api_instance = OryClient::AdminApi.new
consent_challenge = 'consent_challenge_example' # String | 

begin
  # Get Consent Request Information
  result = api_instance.get_consent_request(consent_challenge)
  p result
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->get_consent_request: #{e}"
end
```

#### Using the get_consent_request_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<ConsentRequest>, Integer, Hash)> get_consent_request_with_http_info(consent_challenge)

```ruby
begin
  # Get Consent Request Information
  data, status_code, headers = api_instance.get_consent_request_with_http_info(consent_challenge)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <ConsentRequest>
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->get_consent_request_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **consent_challenge** | **String** |  |  |

### Return type

[**ConsentRequest**](ConsentRequest.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json


## get_json_web_key

> <JSONWebKeySet> get_json_web_key(kid, set)

Fetch a JSON Web Key

This endpoint returns a singular JSON Web Key, identified by the set and the specific key ID (kid).

### Examples

```ruby
require 'time'
require 'ory-client'

api_instance = OryClient::AdminApi.new
kid = 'kid_example' # String | The kid of the desired key
set = 'set_example' # String | The set

begin
  # Fetch a JSON Web Key
  result = api_instance.get_json_web_key(kid, set)
  p result
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->get_json_web_key: #{e}"
end
```

#### Using the get_json_web_key_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<JSONWebKeySet>, Integer, Hash)> get_json_web_key_with_http_info(kid, set)

```ruby
begin
  # Fetch a JSON Web Key
  data, status_code, headers = api_instance.get_json_web_key_with_http_info(kid, set)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <JSONWebKeySet>
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->get_json_web_key_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **kid** | **String** | The kid of the desired key |  |
| **set** | **String** | The set |  |

### Return type

[**JSONWebKeySet**](JSONWebKeySet.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json


## get_json_web_key_set

> <JSONWebKeySet> get_json_web_key_set(set)

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.

### Examples

```ruby
require 'time'
require 'ory-client'

api_instance = OryClient::AdminApi.new
set = 'set_example' # String | The set

begin
  # Retrieve a JSON Web Key Set
  result = api_instance.get_json_web_key_set(set)
  p result
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->get_json_web_key_set: #{e}"
end
```

#### Using the get_json_web_key_set_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<JSONWebKeySet>, Integer, Hash)> get_json_web_key_set_with_http_info(set)

```ruby
begin
  # Retrieve a JSON Web Key Set
  data, status_code, headers = api_instance.get_json_web_key_set_with_http_info(set)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <JSONWebKeySet>
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->get_json_web_key_set_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **set** | **String** | The set |  |

### Return type

[**JSONWebKeySet**](JSONWebKeySet.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json


## get_login_request

> <LoginRequest> get_login_request(login_challenge)

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.

### Examples

```ruby
require 'time'
require 'ory-client'

api_instance = OryClient::AdminApi.new
login_challenge = 'login_challenge_example' # String | 

begin
  # Get a Login Request
  result = api_instance.get_login_request(login_challenge)
  p result
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->get_login_request: #{e}"
end
```

#### Using the get_login_request_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<LoginRequest>, Integer, Hash)> get_login_request_with_http_info(login_challenge)

```ruby
begin
  # Get a Login Request
  data, status_code, headers = api_instance.get_login_request_with_http_info(login_challenge)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <LoginRequest>
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->get_login_request_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **login_challenge** | **String** |  |  |

### Return type

[**LoginRequest**](LoginRequest.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json


## get_logout_request

> <LogoutRequest> get_logout_request(logout_challenge)

Get a Logout Request

Use this endpoint to fetch a logout request.

### Examples

```ruby
require 'time'
require 'ory-client'

api_instance = OryClient::AdminApi.new
logout_challenge = 'logout_challenge_example' # String | 

begin
  # Get a Logout Request
  result = api_instance.get_logout_request(logout_challenge)
  p result
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->get_logout_request: #{e}"
end
```

#### Using the get_logout_request_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<LogoutRequest>, Integer, Hash)> get_logout_request_with_http_info(logout_challenge)

```ruby
begin
  # Get a Logout Request
  data, status_code, headers = api_instance.get_logout_request_with_http_info(logout_challenge)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <LogoutRequest>
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->get_logout_request_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **logout_challenge** | **String** |  |  |

### Return type

[**LogoutRequest**](LogoutRequest.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json


## get_o_auth2_client

> <OAuth2Client> get_o_auth2_client(id)

Get an OAuth 2.0 Client

Get an OAuth 2.0 client by its ID. This endpoint never returns the client secret.  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.

### Examples

```ruby
require 'time'
require 'ory-client'

api_instance = OryClient::AdminApi.new
id = 'id_example' # String | The id of the OAuth 2.0 Client.

begin
  # Get an OAuth 2.0 Client
  result = api_instance.get_o_auth2_client(id)
  p result
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->get_o_auth2_client: #{e}"
end
```

#### Using the get_o_auth2_client_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<OAuth2Client>, Integer, Hash)> get_o_auth2_client_with_http_info(id)

```ruby
begin
  # Get an OAuth 2.0 Client
  data, status_code, headers = api_instance.get_o_auth2_client_with_http_info(id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <OAuth2Client>
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->get_o_auth2_client_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **id** | **String** | The id of the OAuth 2.0 Client. |  |

### Return type

[**OAuth2Client**](OAuth2Client.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json


## get_trusted_jwt_grant_issuer

> <TrustedJwtGrantIssuer> get_trusted_jwt_grant_issuer(id)

Get a Trusted OAuth2 JWT Bearer Grant Type Issuer

Use this endpoint to get a trusted JWT Bearer Grant Type Issuer. The ID is the one returned when you created the trust relationship.

### Examples

```ruby
require 'time'
require 'ory-client'

api_instance = OryClient::AdminApi.new
id = 'id_example' # String | The id of the desired grant

begin
  # Get a Trusted OAuth2 JWT Bearer Grant Type Issuer
  result = api_instance.get_trusted_jwt_grant_issuer(id)
  p result
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->get_trusted_jwt_grant_issuer: #{e}"
end
```

#### Using the get_trusted_jwt_grant_issuer_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<TrustedJwtGrantIssuer>, Integer, Hash)> get_trusted_jwt_grant_issuer_with_http_info(id)

```ruby
begin
  # Get a Trusted OAuth2 JWT Bearer Grant Type Issuer
  data, status_code, headers = api_instance.get_trusted_jwt_grant_issuer_with_http_info(id)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <TrustedJwtGrantIssuer>
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->get_trusted_jwt_grant_issuer_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **id** | **String** | The id of the desired grant |  |

### Return type

[**TrustedJwtGrantIssuer**](TrustedJwtGrantIssuer.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json


## introspect_o_auth2_token

> <OAuth2TokenIntrospection> introspect_o_auth2_token(token, opts)

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

### Examples

```ruby
require 'time'
require 'ory-client'

api_instance = OryClient::AdminApi.new
token = 'token_example' # String | 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.
opts = {
  scope: 'scope_example' # String | 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.
}

begin
  # Introspect OAuth2 Tokens
  result = api_instance.introspect_o_auth2_token(token, opts)
  p result
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->introspect_o_auth2_token: #{e}"
end
```

#### Using the introspect_o_auth2_token_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<OAuth2TokenIntrospection>, Integer, Hash)> introspect_o_auth2_token_with_http_info(token, opts)

```ruby
begin
  # Introspect OAuth2 Tokens
  data, status_code, headers = api_instance.introspect_o_auth2_token_with_http_info(token, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <OAuth2TokenIntrospection>
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->introspect_o_auth2_token_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **token** | **String** | The string value of the token. For access tokens, this is the \\\&quot;access_token\\\&quot; value returned from the token endpoint defined in OAuth 2.0. For refresh tokens, this is the \\\&quot;refresh_token\\\&quot; value returned. |  |
| **scope** | **String** | 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] |

### Return type

[**OAuth2TokenIntrospection**](OAuth2TokenIntrospection.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/x-www-form-urlencoded
- **Accept**: application/json


## list_o_auth2_clients

> <Array<OAuth2Client>> list_o_auth2_clients(opts)

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

### Examples

```ruby
require 'time'
require 'ory-client'

api_instance = OryClient::AdminApi.new
opts = {
  limit: 789, # Integer | The maximum amount of clients to returned, upper bound is 500 clients.
  offset: 789, # Integer | The offset from where to start looking.
  client_name: 'client_name_example', # String | The name of the clients to filter by.
  owner: 'owner_example' # String | The owner of the clients to filter by.
}

begin
  # List OAuth 2.0 Clients
  result = api_instance.list_o_auth2_clients(opts)
  p result
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->list_o_auth2_clients: #{e}"
end
```

#### Using the list_o_auth2_clients_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<Array<OAuth2Client>>, Integer, Hash)> list_o_auth2_clients_with_http_info(opts)

```ruby
begin
  # List OAuth 2.0 Clients
  data, status_code, headers = api_instance.list_o_auth2_clients_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Array<OAuth2Client>>
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->list_o_auth2_clients_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **limit** | **Integer** | The maximum amount of clients to returned, upper bound is 500 clients. | [optional] |
| **offset** | **Integer** | The offset from where to start looking. | [optional] |
| **client_name** | **String** | The name of the clients to filter by. | [optional] |
| **owner** | **String** | The owner of the clients to filter by. | [optional] |

### Return type

[**Array&lt;OAuth2Client&gt;**](OAuth2Client.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json


## list_subject_consent_sessions

> <Array<PreviousConsentSession>> list_subject_consent_sessions(subject, opts)

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.

### Examples

```ruby
require 'time'
require 'ory-client'

api_instance = OryClient::AdminApi.new
subject = 'subject_example' # String | 
opts = {
  limit: 789, # Integer | The maximum amount of consent sessions to be returned, upper bound is 500 sessions.
  offset: 789 # Integer | The offset from where to start looking.
}

begin
  # Lists All Consent Sessions of a Subject
  result = api_instance.list_subject_consent_sessions(subject, opts)
  p result
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->list_subject_consent_sessions: #{e}"
end
```

#### Using the list_subject_consent_sessions_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<Array<PreviousConsentSession>>, Integer, Hash)> list_subject_consent_sessions_with_http_info(subject, opts)

```ruby
begin
  # Lists All Consent Sessions of a Subject
  data, status_code, headers = api_instance.list_subject_consent_sessions_with_http_info(subject, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Array<PreviousConsentSession>>
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->list_subject_consent_sessions_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **subject** | **String** |  |  |
| **limit** | **Integer** | The maximum amount of consent sessions to be returned, upper bound is 500 sessions. | [optional] |
| **offset** | **Integer** | The offset from where to start looking. | [optional] |

### Return type

[**Array&lt;PreviousConsentSession&gt;**](PreviousConsentSession.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json


## list_trusted_jwt_grant_issuers

> <Array<TrustedJwtGrantIssuer>> list_trusted_jwt_grant_issuers(opts)

List Trusted OAuth2 JWT Bearer Grant Type Issuers

Use this endpoint to list all trusted JWT Bearer Grant Type Issuers.

### Examples

```ruby
require 'time'
require 'ory-client'

api_instance = OryClient::AdminApi.new
opts = {
  issuer: 'issuer_example', # String | If optional \"issuer\" is supplied, only jwt-bearer grants with this issuer will be returned.
  limit: 789, # Integer | The maximum amount of policies returned, upper bound is 500 policies
  offset: 789 # Integer | The offset from where to start looking.
}

begin
  # List Trusted OAuth2 JWT Bearer Grant Type Issuers
  result = api_instance.list_trusted_jwt_grant_issuers(opts)
  p result
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->list_trusted_jwt_grant_issuers: #{e}"
end
```

#### Using the list_trusted_jwt_grant_issuers_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<Array<TrustedJwtGrantIssuer>>, Integer, Hash)> list_trusted_jwt_grant_issuers_with_http_info(opts)

```ruby
begin
  # List Trusted OAuth2 JWT Bearer Grant Type Issuers
  data, status_code, headers = api_instance.list_trusted_jwt_grant_issuers_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <Array<TrustedJwtGrantIssuer>>
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->list_trusted_jwt_grant_issuers_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **issuer** | **String** | If optional \&quot;issuer\&quot; is supplied, only jwt-bearer grants with this issuer will be returned. | [optional] |
| **limit** | **Integer** | The maximum amount of policies returned, upper bound is 500 policies | [optional] |
| **offset** | **Integer** | The offset from where to start looking. | [optional] |

### Return type

[**Array&lt;TrustedJwtGrantIssuer&gt;**](TrustedJwtGrantIssuer.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json


## patch_o_auth2_client

> <OAuth2Client> patch_o_auth2_client(id, patch_document)

Patch an OAuth 2.0 Client

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

### Examples

```ruby
require 'time'
require 'ory-client'

api_instance = OryClient::AdminApi.new
id = 'id_example' # String | The id of the OAuth 2.0 Client.
patch_document = [OryClient::PatchDocument.new({op: '"replace"', path: '"/name"'})] # Array<PatchDocument> | 

begin
  # Patch an OAuth 2.0 Client
  result = api_instance.patch_o_auth2_client(id, patch_document)
  p result
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->patch_o_auth2_client: #{e}"
end
```

#### Using the patch_o_auth2_client_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<OAuth2Client>, Integer, Hash)> patch_o_auth2_client_with_http_info(id, patch_document)

```ruby
begin
  # Patch an OAuth 2.0 Client
  data, status_code, headers = api_instance.patch_o_auth2_client_with_http_info(id, patch_document)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <OAuth2Client>
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->patch_o_auth2_client_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **id** | **String** | The id of the OAuth 2.0 Client. |  |
| **patch_document** | [**Array&lt;PatchDocument&gt;**](PatchDocument.md) |  |  |

### Return type

[**OAuth2Client**](OAuth2Client.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json


## reject_consent_request

> <CompletedRequest> reject_consent_request(consent_challenge, opts)

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.

### Examples

```ruby
require 'time'
require 'ory-client'

api_instance = OryClient::AdminApi.new
consent_challenge = 'consent_challenge_example' # String | 
opts = {
  reject_request: OryClient::RejectRequest.new # RejectRequest | 
}

begin
  # Reject a Consent Request
  result = api_instance.reject_consent_request(consent_challenge, opts)
  p result
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->reject_consent_request: #{e}"
end
```

#### Using the reject_consent_request_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<CompletedRequest>, Integer, Hash)> reject_consent_request_with_http_info(consent_challenge, opts)

```ruby
begin
  # Reject a Consent Request
  data, status_code, headers = api_instance.reject_consent_request_with_http_info(consent_challenge, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CompletedRequest>
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->reject_consent_request_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **consent_challenge** | **String** |  |  |
| **reject_request** | [**RejectRequest**](RejectRequest.md) |  | [optional] |

### Return type

[**CompletedRequest**](CompletedRequest.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json


## reject_login_request

> <CompletedRequest> reject_login_request(login_challenge, opts)

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.

### Examples

```ruby
require 'time'
require 'ory-client'

api_instance = OryClient::AdminApi.new
login_challenge = 'login_challenge_example' # String | 
opts = {
  reject_request: OryClient::RejectRequest.new # RejectRequest | 
}

begin
  # Reject a Login Request
  result = api_instance.reject_login_request(login_challenge, opts)
  p result
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->reject_login_request: #{e}"
end
```

#### Using the reject_login_request_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<CompletedRequest>, Integer, Hash)> reject_login_request_with_http_info(login_challenge, opts)

```ruby
begin
  # Reject a Login Request
  data, status_code, headers = api_instance.reject_login_request_with_http_info(login_challenge, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <CompletedRequest>
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->reject_login_request_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **login_challenge** | **String** |  |  |
| **reject_request** | [**RejectRequest**](RejectRequest.md) |  | [optional] |

### Return type

[**CompletedRequest**](CompletedRequest.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json


## reject_logout_request

> reject_logout_request(logout_challenge, opts)

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.

### Examples

```ruby
require 'time'
require 'ory-client'

api_instance = OryClient::AdminApi.new
logout_challenge = 'logout_challenge_example' # String | 
opts = {
  reject_request: OryClient::RejectRequest.new # RejectRequest | 
}

begin
  # Reject a Logout Request
  api_instance.reject_logout_request(logout_challenge, opts)
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->reject_logout_request: #{e}"
end
```

#### Using the reject_logout_request_with_http_info variant

This returns an Array which contains the response data (`nil` in this case), status code and headers.

> <Array(nil, Integer, Hash)> reject_logout_request_with_http_info(logout_challenge, opts)

```ruby
begin
  # Reject a Logout Request
  data, status_code, headers = api_instance.reject_logout_request_with_http_info(logout_challenge, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->reject_logout_request_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **logout_challenge** | **String** |  |  |
| **reject_request** | [**RejectRequest**](RejectRequest.md) |  | [optional] |

### Return type

nil (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json, application/x-www-form-urlencoded
- **Accept**: application/json


## revoke_authentication_session

> revoke_authentication_session(subject)

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.

### Examples

```ruby
require 'time'
require 'ory-client'

api_instance = OryClient::AdminApi.new
subject = 'subject_example' # String | 

begin
  # Invalidates All Login Sessions of a Certain User Invalidates a Subject's Authentication Session
  api_instance.revoke_authentication_session(subject)
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->revoke_authentication_session: #{e}"
end
```

#### Using the revoke_authentication_session_with_http_info variant

This returns an Array which contains the response data (`nil` in this case), status code and headers.

> <Array(nil, Integer, Hash)> revoke_authentication_session_with_http_info(subject)

```ruby
begin
  # Invalidates All Login Sessions of a Certain User Invalidates a Subject's Authentication Session
  data, status_code, headers = api_instance.revoke_authentication_session_with_http_info(subject)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->revoke_authentication_session_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **subject** | **String** |  |  |

### Return type

nil (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json


## revoke_consent_sessions

> revoke_consent_sessions(subject, opts)

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.

### Examples

```ruby
require 'time'
require 'ory-client'

api_instance = OryClient::AdminApi.new
subject = 'subject_example' # String | The subject (Subject) who's consent sessions should be deleted.
opts = {
  client: 'client_example', # String | If set, deletes only those consent sessions by the Subject that have been granted to the specified OAuth 2.0 Client ID
  all: true # Boolean | If set to `?all=true`, deletes all consent sessions by the Subject that have been granted.
}

begin
  # Revokes Consent Sessions of a Subject for a Specific OAuth 2.0 Client
  api_instance.revoke_consent_sessions(subject, opts)
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->revoke_consent_sessions: #{e}"
end
```

#### Using the revoke_consent_sessions_with_http_info variant

This returns an Array which contains the response data (`nil` in this case), status code and headers.

> <Array(nil, Integer, Hash)> revoke_consent_sessions_with_http_info(subject, opts)

```ruby
begin
  # Revokes Consent Sessions of a Subject for a Specific OAuth 2.0 Client
  data, status_code, headers = api_instance.revoke_consent_sessions_with_http_info(subject, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => nil
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->revoke_consent_sessions_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **subject** | **String** | The subject (Subject) who&#39;s consent sessions should be deleted. |  |
| **client** | **String** | If set, deletes only those consent sessions by the Subject that have been granted to the specified OAuth 2.0 Client ID | [optional] |
| **all** | **Boolean** | If set to &#x60;?all&#x3D;true&#x60;, deletes all consent sessions by the Subject that have been granted. | [optional] |

### Return type

nil (empty response body)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json


## trust_jwt_grant_issuer

> <TrustedJwtGrantIssuer> trust_jwt_grant_issuer(opts)

Trust an OAuth2 JWT Bearer Grant Type Issuer

Use this endpoint to establish a trust relationship for a JWT issuer to perform JSON Web Token (JWT) Profile for OAuth 2.0 Client Authentication and Authorization Grants [RFC7523](https://datatracker.ietf.org/doc/html/rfc7523).

### Examples

```ruby
require 'time'
require 'ory-client'

api_instance = OryClient::AdminApi.new
opts = {
  trust_jwt_grant_issuer_body: OryClient::TrustJwtGrantIssuerBody.new({expires_at: Time.now, issuer: 'https://jwt-idp.example.com', jwk: OryClient::JSONWebKey.new({alg: 'RS256', kid: '1603dfe0af8f4596', kty: 'RSA', use: 'sig'}), scope: ["openid", "offline"]}) # TrustJwtGrantIssuerBody | 
}

begin
  # Trust an OAuth2 JWT Bearer Grant Type Issuer
  result = api_instance.trust_jwt_grant_issuer(opts)
  p result
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->trust_jwt_grant_issuer: #{e}"
end
```

#### Using the trust_jwt_grant_issuer_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<TrustedJwtGrantIssuer>, Integer, Hash)> trust_jwt_grant_issuer_with_http_info(opts)

```ruby
begin
  # Trust an OAuth2 JWT Bearer Grant Type Issuer
  data, status_code, headers = api_instance.trust_jwt_grant_issuer_with_http_info(opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <TrustedJwtGrantIssuer>
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->trust_jwt_grant_issuer_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **trust_jwt_grant_issuer_body** | [**TrustJwtGrantIssuerBody**](TrustJwtGrantIssuerBody.md) |  | [optional] |

### Return type

[**TrustedJwtGrantIssuer**](TrustedJwtGrantIssuer.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json


## update_json_web_key

> <JSONWebKey> update_json_web_key(kid, set, opts)

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.

### Examples

```ruby
require 'time'
require 'ory-client'

api_instance = OryClient::AdminApi.new
kid = 'kid_example' # String | The kid of the desired key
set = 'set_example' # String | The set
opts = {
  json_web_key: OryClient::JSONWebKey.new({alg: 'RS256', kid: '1603dfe0af8f4596', kty: 'RSA', use: 'sig'}) # JSONWebKey | 
}

begin
  # Update a JSON Web Key
  result = api_instance.update_json_web_key(kid, set, opts)
  p result
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->update_json_web_key: #{e}"
end
```

#### Using the update_json_web_key_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<JSONWebKey>, Integer, Hash)> update_json_web_key_with_http_info(kid, set, opts)

```ruby
begin
  # Update a JSON Web Key
  data, status_code, headers = api_instance.update_json_web_key_with_http_info(kid, set, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <JSONWebKey>
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->update_json_web_key_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **kid** | **String** | The kid of the desired key |  |
| **set** | **String** | The set |  |
| **json_web_key** | [**JSONWebKey**](JSONWebKey.md) |  | [optional] |

### Return type

[**JSONWebKey**](JSONWebKey.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json


## update_json_web_key_set

> <JSONWebKeySet> update_json_web_key_set(set, opts)

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.

### Examples

```ruby
require 'time'
require 'ory-client'

api_instance = OryClient::AdminApi.new
set = 'set_example' # String | The set
opts = {
  json_web_key_set: OryClient::JSONWebKeySet.new # JSONWebKeySet | 
}

begin
  # Update a JSON Web Key Set
  result = api_instance.update_json_web_key_set(set, opts)
  p result
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->update_json_web_key_set: #{e}"
end
```

#### Using the update_json_web_key_set_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<JSONWebKeySet>, Integer, Hash)> update_json_web_key_set_with_http_info(set, opts)

```ruby
begin
  # Update a JSON Web Key Set
  data, status_code, headers = api_instance.update_json_web_key_set_with_http_info(set, opts)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <JSONWebKeySet>
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->update_json_web_key_set_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **set** | **String** | The set |  |
| **json_web_key_set** | [**JSONWebKeySet**](JSONWebKeySet.md) |  | [optional] |

### Return type

[**JSONWebKeySet**](JSONWebKeySet.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json


## update_o_auth2_client

> <OAuth2Client> update_o_auth2_client(id, o_auth2_client)

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.

### Examples

```ruby
require 'time'
require 'ory-client'

api_instance = OryClient::AdminApi.new
id = 'id_example' # String | The id of the OAuth 2.0 Client.
o_auth2_client = OryClient::OAuth2Client.new # OAuth2Client | 

begin
  # Update an OAuth 2.0 Client
  result = api_instance.update_o_auth2_client(id, o_auth2_client)
  p result
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->update_o_auth2_client: #{e}"
end
```

#### Using the update_o_auth2_client_with_http_info variant

This returns an Array which contains the response data, status code and headers.

> <Array(<OAuth2Client>, Integer, Hash)> update_o_auth2_client_with_http_info(id, o_auth2_client)

```ruby
begin
  # Update an OAuth 2.0 Client
  data, status_code, headers = api_instance.update_o_auth2_client_with_http_info(id, o_auth2_client)
  p status_code # => 2xx
  p headers # => { ... }
  p data # => <OAuth2Client>
rescue OryClient::ApiError => e
  puts "Error when calling AdminApi->update_o_auth2_client_with_http_info: #{e}"
end
```

### Parameters

| Name | Type | Description | Notes |
| ---- | ---- | ----------- | ----- |
| **id** | **String** | The id of the OAuth 2.0 Client. |  |
| **o_auth2_client** | [**OAuth2Client**](OAuth2Client.md) |  |  |

### Return type

[**OAuth2Client**](OAuth2Client.md)

### Authorization

No authorization required

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json