Class: OryClient::AdminApi

#accept_consent_request(consent_challenge, opts = {}) ⇒ `CompletedRequest`

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:

consent_challenge (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:accept_consent_request (AcceptConsentRequest)

Returns:

(CompletedRequest)

# File 'lib/ory-client/api/admin_api.rb', line 28

def accept_consent_request(consent_challenge, opts = {})
  data, _status_code, _headers = accept_consent_request_with_http_info(consent_challenge, opts)
  data
end

#accept_consent_request_with_http_info(consent_challenge, opts = {}) ⇒ `Array<(CompletedRequest, Integer, Hash)>`

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:

consent_challenge (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:accept_consent_request (AcceptConsentRequest)

Returns:

(Array<(CompletedRequest, Integer, Hash)>) —

CompletedRequest data, response status code and response headers

# File 'lib/ory-client/api/admin_api.rb', line 39

def accept_consent_request_with_http_info(consent_challenge, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.accept_consent_request ...'
  end
  # verify the required parameter 'consent_challenge' is set
  if @api_client.config.client_side_validation && consent_challenge.nil?
    fail ArgumentError, "Missing the required parameter 'consent_challenge' when calling AdminApi.accept_consent_request"
  end
  # resource path
  local_var_path = '/oauth2/auth/requests/consent/accept'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'consent_challenge'] = consent_challenge

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'accept_consent_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'CompletedRequest'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"AdminApi.accept_consent_request",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdminApi#accept_consent_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#accept_login_request(login_challenge, opts = {}) ⇒ `CompletedRequest`

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:

login_challenge (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:accept_login_request (AcceptLoginRequest)

Returns:

(CompletedRequest)

# File 'lib/ory-client/api/admin_api.rb', line 99

def accept_login_request(login_challenge, opts = {})
  data, _status_code, _headers = accept_login_request_with_http_info(login_challenge, opts)
  data
end

#accept_login_request_with_http_info(login_challenge, opts = {}) ⇒ `Array<(CompletedRequest, Integer, Hash)>`

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:

login_challenge (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:accept_login_request (AcceptLoginRequest)

Returns:

(Array<(CompletedRequest, Integer, Hash)>) —

CompletedRequest data, response status code and response headers

# File 'lib/ory-client/api/admin_api.rb', line 110

def accept_login_request_with_http_info(login_challenge, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.accept_login_request ...'
  end
  # verify the required parameter 'login_challenge' is set
  if @api_client.config.client_side_validation && login_challenge.nil?
    fail ArgumentError, "Missing the required parameter 'login_challenge' when calling AdminApi.accept_login_request"
  end
  # resource path
  local_var_path = '/oauth2/auth/requests/login/accept'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'login_challenge'] = login_challenge

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'accept_login_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'CompletedRequest'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"AdminApi.accept_login_request",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdminApi#accept_login_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#accept_logout_request(logout_challenge, opts = {}) ⇒ `CompletedRequest`

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:

logout_challenge (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(CompletedRequest)

# File 'lib/ory-client/api/admin_api.rb', line 169

def accept_logout_request(logout_challenge, opts = {})
  data, _status_code, _headers = accept_logout_request_with_http_info(logout_challenge, opts)
  data
end

#accept_logout_request_with_http_info(logout_challenge, opts = {}) ⇒ `Array<(CompletedRequest, Integer, Hash)>`

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:

logout_challenge (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(CompletedRequest, Integer, Hash)>) —

CompletedRequest data, response status code and response headers

# File 'lib/ory-client/api/admin_api.rb', line 179

def accept_logout_request_with_http_info(logout_challenge, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.accept_logout_request ...'
  end
  # verify the required parameter 'logout_challenge' is set
  if @api_client.config.client_side_validation && logout_challenge.nil?
    fail ArgumentError, "Missing the required parameter 'logout_challenge' when calling AdminApi.accept_logout_request"
  end
  # resource path
  local_var_path = '/oauth2/auth/requests/logout/accept'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'logout_challenge'] = logout_challenge

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'CompletedRequest'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"AdminApi.accept_logout_request",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdminApi#accept_logout_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_json_web_key_set(set, opts = {}) ⇒ `JSONWebKeySet`

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 (String) —

The set
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:json_web_key_set_generator_request (JsonWebKeySetGeneratorRequest)

Returns:

(JSONWebKeySet)

# File 'lib/ory-client/api/admin_api.rb', line 234

def create_json_web_key_set(set, opts = {})
  data, _status_code, _headers = create_json_web_key_set_with_http_info(set, opts)
  data
end

#create_json_web_key_set_with_http_info(set, opts = {}) ⇒ `Array<(JSONWebKeySet, Integer, Hash)>`

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 (String) —

The set
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:json_web_key_set_generator_request (JsonWebKeySetGeneratorRequest)

Returns:

(Array<(JSONWebKeySet, Integer, Hash)>) —

JSONWebKeySet data, response status code and response headers

# File 'lib/ory-client/api/admin_api.rb', line 245

def create_json_web_key_set_with_http_info(set, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.create_json_web_key_set ...'
  end
  # verify the required parameter 'set' is set
  if @api_client.config.client_side_validation && set.nil?
    fail ArgumentError, "Missing the required parameter 'set' when calling AdminApi.create_json_web_key_set"
  end
  # resource path
  local_var_path = '/keys/{set}'.sub('{' + 'set' + '}', CGI.escape(set.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'json_web_key_set_generator_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'JSONWebKeySet'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"AdminApi.create_json_web_key_set",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdminApi#create_json_web_key_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#create_o_auth2_client(o_auth2_client, opts = {}) ⇒ `OAuth2Client`

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.

Parameters:

o_auth2_client (OAuth2Client)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(OAuth2Client)

# File 'lib/ory-client/api/admin_api.rb', line 303

def create_o_auth2_client(o_auth2_client, opts = {})
  data, _status_code, _headers = create_o_auth2_client_with_http_info(o_auth2_client, opts)
  data
end

#create_o_auth2_client_with_http_info(o_auth2_client, opts = {}) ⇒ `Array<(OAuth2Client, Integer, Hash)>`

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.

Parameters:

o_auth2_client (OAuth2Client)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(OAuth2Client, Integer, Hash)>) —

OAuth2Client data, response status code and response headers

# File 'lib/ory-client/api/admin_api.rb', line 313

def create_o_auth2_client_with_http_info(o_auth2_client, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.create_o_auth2_client ...'
  end
  # verify the required parameter 'o_auth2_client' is set
  if @api_client.config.client_side_validation && o_auth2_client.nil?
    fail ArgumentError, "Missing the required parameter 'o_auth2_client' when calling AdminApi.create_o_auth2_client"
  end
  # resource path
  local_var_path = '/clients'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(o_auth2_client)

  # return_type
  return_type = opts[:debug_return_type] || 'OAuth2Client'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"AdminApi.create_o_auth2_client",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdminApi#create_o_auth2_client\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_json_web_key(kid, set, opts = {}) ⇒ `nil`

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 (String) —

The kid of the desired key
set (String) —

The set
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(nil)

# File 'lib/ory-client/api/admin_api.rb', line 372

def delete_json_web_key(kid, set, opts = {})
  delete_json_web_key_with_http_info(kid, set, opts)
  nil
end

#delete_json_web_key_set(set, opts = {}) ⇒ `nil`

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 (String) —

The set
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(nil)

# File 'lib/ory-client/api/admin_api.rb', line 440

def delete_json_web_key_set(set, opts = {})
  delete_json_web_key_set_with_http_info(set, opts)
  nil
end

#delete_json_web_key_set_with_http_info(set, opts = {}) ⇒ `Array<(nil, Integer, Hash)>`

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 (String) —

The set
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(nil, Integer, Hash)>) —

nil, response status code and response headers

# File 'lib/ory-client/api/admin_api.rb', line 450

def delete_json_web_key_set_with_http_info(set, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.delete_json_web_key_set ...'
  end
  # verify the required parameter 'set' is set
  if @api_client.config.client_side_validation && set.nil?
    fail ArgumentError, "Missing the required parameter 'set' when calling AdminApi.delete_json_web_key_set"
  end
  # resource path
  local_var_path = '/keys/{set}'.sub('{' + 'set' + '}', CGI.escape(set.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"AdminApi.delete_json_web_key_set",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdminApi#delete_json_web_key_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_json_web_key_with_http_info(kid, set, opts = {}) ⇒ `Array<(nil, Integer, Hash)>`

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 (String) —

The kid of the desired key
set (String) —

The set
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(nil, Integer, Hash)>) —

nil, response status code and response headers

# File 'lib/ory-client/api/admin_api.rb', line 383

def delete_json_web_key_with_http_info(kid, set, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.delete_json_web_key ...'
  end
  # verify the required parameter 'kid' is set
  if @api_client.config.client_side_validation && kid.nil?
    fail ArgumentError, "Missing the required parameter 'kid' when calling AdminApi.delete_json_web_key"
  end
  # verify the required parameter 'set' is set
  if @api_client.config.client_side_validation && set.nil?
    fail ArgumentError, "Missing the required parameter 'set' when calling AdminApi.delete_json_web_key"
  end
  # resource path
  local_var_path = '/keys/{set}/{kid}'.sub('{' + 'kid' + '}', CGI.escape(kid.to_s)).sub('{' + 'set' + '}', CGI.escape(set.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"AdminApi.delete_json_web_key",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdminApi#delete_json_web_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_o_auth2_client(id, opts = {}) ⇒ `nil`

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.

Parameters:

id (String) —

The id of the OAuth 2.0 Client.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(nil)

# File 'lib/ory-client/api/admin_api.rb', line 503

def delete_o_auth2_client(id, opts = {})
  delete_o_auth2_client_with_http_info(id, opts)
  nil
end

#delete_o_auth2_client_with_http_info(id, opts = {}) ⇒ `Array<(nil, Integer, Hash)>`

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.

Parameters:

id (String) —

The id of the OAuth 2.0 Client.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(nil, Integer, Hash)>) —

nil, response status code and response headers

# File 'lib/ory-client/api/admin_api.rb', line 513

def delete_o_auth2_client_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.delete_o_auth2_client ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AdminApi.delete_o_auth2_client"
  end
  # resource path
  local_var_path = '/clients/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"AdminApi.delete_o_auth2_client",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdminApi#delete_o_auth2_client\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_o_auth2_token(client_id, opts = {}) ⇒ `nil`

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

Parameters:

client_id (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(nil)

# File 'lib/ory-client/api/admin_api.rb', line 566

def delete_o_auth2_token(client_id, opts = {})
  delete_o_auth2_token_with_http_info(client_id, opts)
  nil
end

#delete_o_auth2_token_with_http_info(client_id, opts = {}) ⇒ `Array<(nil, Integer, Hash)>`

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

Parameters:

client_id (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(nil, Integer, Hash)>) —

nil, response status code and response headers

# File 'lib/ory-client/api/admin_api.rb', line 576

def delete_o_auth2_token_with_http_info(client_id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.delete_o_auth2_token ...'
  end
  # verify the required parameter 'client_id' is set
  if @api_client.config.client_side_validation && client_id.nil?
    fail ArgumentError, "Missing the required parameter 'client_id' when calling AdminApi.delete_o_auth2_token"
  end
  # resource path
  local_var_path = '/oauth2/tokens'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'client_id'] = client_id

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"AdminApi.delete_o_auth2_token",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdminApi#delete_o_auth2_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#delete_trusted_jwt_grant_issuer(id, opts = {}) ⇒ `nil`

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.

Parameters:

id (String) —

The id of the desired grant
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(nil)

# File 'lib/ory-client/api/admin_api.rb', line 630

def delete_trusted_jwt_grant_issuer(id, opts = {})
  delete_trusted_jwt_grant_issuer_with_http_info(id, opts)
  nil
end

#delete_trusted_jwt_grant_issuer_with_http_info(id, opts = {}) ⇒ `Array<(nil, Integer, Hash)>`

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.

Parameters:

id (String) —

The id of the desired grant
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(nil, Integer, Hash)>) —

nil, response status code and response headers

# File 'lib/ory-client/api/admin_api.rb', line 640

def delete_trusted_jwt_grant_issuer_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.delete_trusted_jwt_grant_issuer ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AdminApi.delete_trusted_jwt_grant_issuer"
  end
  # resource path
  local_var_path = '/trust/grants/jwt-bearer/issuers/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"AdminApi.delete_trusted_jwt_grant_issuer",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdminApi#delete_trusted_jwt_grant_issuer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#flush_inactive_o_auth2_tokens(opts = {}) ⇒ `nil`

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:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:flush_inactive_o_auth2_tokens_request (FlushInactiveOAuth2TokensRequest)

Returns:

(nil)

# File 'lib/ory-client/api/admin_api.rb', line 693

def flush_inactive_o_auth2_tokens(opts = {})
  flush_inactive_o_auth2_tokens_with_http_info(opts)
  nil
end

#flush_inactive_o_auth2_tokens_with_http_info(opts = {}) ⇒ `Array<(nil, Integer, Hash)>`

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:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:flush_inactive_o_auth2_tokens_request (FlushInactiveOAuth2TokensRequest)

Returns:

(Array<(nil, Integer, Hash)>) —

nil, response status code and response headers

# File 'lib/ory-client/api/admin_api.rb', line 703

def flush_inactive_o_auth2_tokens_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.flush_inactive_o_auth2_tokens ...'
  end
  # resource path
  local_var_path = '/oauth2/flush'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'flush_inactive_o_auth2_tokens_request'])

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"AdminApi.flush_inactive_o_auth2_tokens",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdminApi#flush_inactive_o_auth2_tokens\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_consent_request(consent_challenge, opts = {}) ⇒ `ConsentRequest`

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:

consent_challenge (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(ConsentRequest)

# File 'lib/ory-client/api/admin_api.rb', line 757

def get_consent_request(consent_challenge, opts = {})
  data, _status_code, _headers = get_consent_request_with_http_info(consent_challenge, opts)
  data
end

#get_consent_request_with_http_info(consent_challenge, opts = {}) ⇒ `Array<(ConsentRequest, Integer, Hash)>`

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:

consent_challenge (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(ConsentRequest, Integer, Hash)>) —

ConsentRequest data, response status code and response headers

# File 'lib/ory-client/api/admin_api.rb', line 767

def get_consent_request_with_http_info(consent_challenge, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.get_consent_request ...'
  end
  # verify the required parameter 'consent_challenge' is set
  if @api_client.config.client_side_validation && consent_challenge.nil?
    fail ArgumentError, "Missing the required parameter 'consent_challenge' when calling AdminApi.get_consent_request"
  end
  # resource path
  local_var_path = '/oauth2/auth/requests/consent'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'consent_challenge'] = consent_challenge

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'ConsentRequest'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"AdminApi.get_consent_request",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdminApi#get_consent_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_json_web_key(kid, set, opts = {}) ⇒ `JSONWebKeySet`

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 (String) —

The kid of the desired key
set (String) —

The set
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(JSONWebKeySet)

# File 'lib/ory-client/api/admin_api.rb', line 822

def get_json_web_key(kid, set, opts = {})
  data, _status_code, _headers = get_json_web_key_with_http_info(kid, set, opts)
  data
end

#get_json_web_key_set(set, opts = {}) ⇒ `JSONWebKeySet`

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 (String) —

The set
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(JSONWebKeySet)

# File 'lib/ory-client/api/admin_api.rb', line 890

def get_json_web_key_set(set, opts = {})
  data, _status_code, _headers = get_json_web_key_set_with_http_info(set, opts)
  data
end

#get_json_web_key_set_with_http_info(set, opts = {}) ⇒ `Array<(JSONWebKeySet, Integer, Hash)>`

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 (String) —

The set
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(JSONWebKeySet, Integer, Hash)>) —

JSONWebKeySet data, response status code and response headers

# File 'lib/ory-client/api/admin_api.rb', line 900

def get_json_web_key_set_with_http_info(set, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.get_json_web_key_set ...'
  end
  # verify the required parameter 'set' is set
  if @api_client.config.client_side_validation && set.nil?
    fail ArgumentError, "Missing the required parameter 'set' when calling AdminApi.get_json_web_key_set"
  end
  # resource path
  local_var_path = '/keys/{set}'.sub('{' + 'set' + '}', CGI.escape(set.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'JSONWebKeySet'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"AdminApi.get_json_web_key_set",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdminApi#get_json_web_key_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_json_web_key_with_http_info(kid, set, opts = {}) ⇒ `Array<(JSONWebKeySet, Integer, Hash)>`

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 (String) —

The kid of the desired key
set (String) —

The set
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(JSONWebKeySet, Integer, Hash)>) —

JSONWebKeySet data, response status code and response headers

# File 'lib/ory-client/api/admin_api.rb', line 833

def get_json_web_key_with_http_info(kid, set, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.get_json_web_key ...'
  end
  # verify the required parameter 'kid' is set
  if @api_client.config.client_side_validation && kid.nil?
    fail ArgumentError, "Missing the required parameter 'kid' when calling AdminApi.get_json_web_key"
  end
  # verify the required parameter 'set' is set
  if @api_client.config.client_side_validation && set.nil?
    fail ArgumentError, "Missing the required parameter 'set' when calling AdminApi.get_json_web_key"
  end
  # resource path
  local_var_path = '/keys/{set}/{kid}'.sub('{' + 'kid' + '}', CGI.escape(kid.to_s)).sub('{' + 'set' + '}', CGI.escape(set.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'JSONWebKeySet'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"AdminApi.get_json_web_key",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdminApi#get_json_web_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_login_request(login_challenge, opts = {}) ⇒ `LoginRequest`

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:

login_challenge (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(LoginRequest)

# File 'lib/ory-client/api/admin_api.rb', line 953

def get_login_request(login_challenge, opts = {})
  data, _status_code, _headers = get_login_request_with_http_info(login_challenge, opts)
  data
end

#get_login_request_with_http_info(login_challenge, opts = {}) ⇒ `Array<(LoginRequest, Integer, Hash)>`

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:

login_challenge (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(LoginRequest, Integer, Hash)>) —

LoginRequest data, response status code and response headers

# File 'lib/ory-client/api/admin_api.rb', line 963

def get_login_request_with_http_info(login_challenge, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.get_login_request ...'
  end
  # verify the required parameter 'login_challenge' is set
  if @api_client.config.client_side_validation && login_challenge.nil?
    fail ArgumentError, "Missing the required parameter 'login_challenge' when calling AdminApi.get_login_request"
  end
  # resource path
  local_var_path = '/oauth2/auth/requests/login'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'login_challenge'] = login_challenge

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LoginRequest'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"AdminApi.get_login_request",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdminApi#get_login_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_logout_request(logout_challenge, opts = {}) ⇒ `LogoutRequest`

Get a Logout Request Use this endpoint to fetch a logout request.

Parameters:

logout_challenge (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(LogoutRequest)

# File 'lib/ory-client/api/admin_api.rb', line 1017

def get_logout_request(logout_challenge, opts = {})
  data, _status_code, _headers = get_logout_request_with_http_info(logout_challenge, opts)
  data
end

#get_logout_request_with_http_info(logout_challenge, opts = {}) ⇒ `Array<(LogoutRequest, Integer, Hash)>`

Get a Logout Request Use this endpoint to fetch a logout request.

Parameters:

logout_challenge (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(LogoutRequest, Integer, Hash)>) —

LogoutRequest data, response status code and response headers

# File 'lib/ory-client/api/admin_api.rb', line 1027

def get_logout_request_with_http_info(logout_challenge, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.get_logout_request ...'
  end
  # verify the required parameter 'logout_challenge' is set
  if @api_client.config.client_side_validation && logout_challenge.nil?
    fail ArgumentError, "Missing the required parameter 'logout_challenge' when calling AdminApi.get_logout_request"
  end
  # resource path
  local_var_path = '/oauth2/auth/requests/logout'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'logout_challenge'] = logout_challenge

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'LogoutRequest'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"AdminApi.get_logout_request",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdminApi#get_logout_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_o_auth2_client(id, opts = {}) ⇒ `OAuth2Client`

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.

Parameters:

id (String) —

The id of the OAuth 2.0 Client.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(OAuth2Client)

# File 'lib/ory-client/api/admin_api.rb', line 1081

def get_o_auth2_client(id, opts = {})
  data, _status_code, _headers = get_o_auth2_client_with_http_info(id, opts)
  data
end

#get_o_auth2_client_with_http_info(id, opts = {}) ⇒ `Array<(OAuth2Client, Integer, Hash)>`

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.

Parameters:

id (String) —

The id of the OAuth 2.0 Client.
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(OAuth2Client, Integer, Hash)>) —

OAuth2Client data, response status code and response headers

# File 'lib/ory-client/api/admin_api.rb', line 1091

def get_o_auth2_client_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.get_o_auth2_client ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AdminApi.get_o_auth2_client"
  end
  # resource path
  local_var_path = '/clients/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'OAuth2Client'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"AdminApi.get_o_auth2_client",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdminApi#get_o_auth2_client\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#get_trusted_jwt_grant_issuer(id, opts = {}) ⇒ `TrustedJwtGrantIssuer`

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.

Parameters:

id (String) —

The id of the desired grant
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(TrustedJwtGrantIssuer)

# File 'lib/ory-client/api/admin_api.rb', line 1144

def get_trusted_jwt_grant_issuer(id, opts = {})
  data, _status_code, _headers = get_trusted_jwt_grant_issuer_with_http_info(id, opts)
  data
end

#get_trusted_jwt_grant_issuer_with_http_info(id, opts = {}) ⇒ `Array<(TrustedJwtGrantIssuer, Integer, Hash)>`

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.

Parameters:

id (String) —

The id of the desired grant
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(TrustedJwtGrantIssuer, Integer, Hash)>) —

TrustedJwtGrantIssuer data, response status code and response headers

# File 'lib/ory-client/api/admin_api.rb', line 1154

def get_trusted_jwt_grant_issuer_with_http_info(id, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.get_trusted_jwt_grant_issuer ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AdminApi.get_trusted_jwt_grant_issuer"
  end
  # resource path
  local_var_path = '/trust/grants/jwt-bearer/issuers/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'TrustedJwtGrantIssuer'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"AdminApi.get_trusted_jwt_grant_issuer",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdminApi#get_trusted_jwt_grant_issuer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#introspect_o_auth2_token(token, opts = {}) ⇒ `OAuth2TokenIntrospection`

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](www.oauth.com/oauth2-servers/token-introspection-endpoint/).

Parameters:

token (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 (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

Returns:

(OAuth2TokenIntrospection)

# File 'lib/ory-client/api/admin_api.rb', line 1208

def introspect_o_auth2_token(token, opts = {})
  data, _status_code, _headers = introspect_o_auth2_token_with_http_info(token, opts)
  data
end

#introspect_o_auth2_token_with_http_info(token, opts = {}) ⇒ `Array<(OAuth2TokenIntrospection, Integer, Hash)>`

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](www.oauth.com/oauth2-servers/token-introspection-endpoint/).

Parameters:

token (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 (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

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

Returns:

(Array<(OAuth2TokenIntrospection, Integer, Hash)>) —

OAuth2TokenIntrospection data, response status code and response headers

# File 'lib/ory-client/api/admin_api.rb', line 1219

def introspect_o_auth2_token_with_http_info(token, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.introspect_o_auth2_token ...'
  end
  # verify the required parameter 'token' is set
  if @api_client.config.client_side_validation && token.nil?
    fail ArgumentError, "Missing the required parameter 'token' when calling AdminApi.introspect_o_auth2_token"
  end
  # resource path
  local_var_path = '/oauth2/introspect'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/x-www-form-urlencoded'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}
  form_params['token'] = token
  form_params['scope'] = opts[:'scope'] if !opts[:'scope'].nil?

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'OAuth2TokenIntrospection'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"AdminApi.introspect_o_auth2_token",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdminApi#introspect_o_auth2_token\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_o_auth2_clients(opts = {}) ⇒ `Array<OAuth2Client>`

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: '<

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:limit (Integer) —

The maximum amount of clients to returned, upper bound is 500 clients.
:offset (Integer) —

The offset from where to start looking.
:client_name (String) —

The name of the clients to filter by.
:owner (String) —

The owner of the clients to filter by.

Returns:

(Array<OAuth2Client>)

# File 'lib/ory-client/api/admin_api.rb', line 1282

def list_o_auth2_clients(opts = {})
  data, _status_code, _headers = list_o_auth2_clients_with_http_info(opts)
  data
end

#list_o_auth2_clients_with_http_info(opts = {}) ⇒ `Array<(Array<OAuth2Client>, Integer, Hash)>`

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: '<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:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:limit (Integer) —

The maximum amount of clients to returned, upper bound is 500 clients.
:offset (Integer) —

The offset from where to start looking.
:client_name (String) —

The name of the clients to filter by.
:owner (String) —

The owner of the clients to filter by.

Returns:

(Array<(Array<OAuth2Client>, Integer, Hash)>) —

Array<OAuth2Client> data, response status code and response headers

# File 'lib/ory-client/api/admin_api.rb', line 1295

def list_o_auth2_clients_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.list_o_auth2_clients ...'
  end
  # resource path
  local_var_path = '/clients'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?
  query_params[:'client_name'] = opts[:'client_name'] if !opts[:'client_name'].nil?
  query_params[:'owner'] = opts[:'owner'] if !opts[:'owner'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<OAuth2Client>'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"AdminApi.list_o_auth2_clients",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdminApi#list_o_auth2_clients\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_subject_consent_sessions(subject, opts = {}) ⇒ `Array<PreviousConsentSession>`

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: '<

Parameters:

subject (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:limit (Integer) —

The maximum amount of consent sessions to be returned, upper bound is 500 sessions.
:offset (Integer) —

The offset from where to start looking.

Returns:

(Array<PreviousConsentSession>)

# File 'lib/ory-client/api/admin_api.rb', line 1350

def list_subject_consent_sessions(subject, opts = {})
  data, _status_code, _headers = list_subject_consent_sessions_with_http_info(subject, opts)
  data
end

#list_subject_consent_sessions_with_http_info(subject, opts = {}) ⇒ `Array<(Array<PreviousConsentSession>, Integer, Hash)>`

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: '<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 (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:limit (Integer) —

The maximum amount of consent sessions to be returned, upper bound is 500 sessions.
:offset (Integer) —

The offset from where to start looking.

Returns:

(Array<(Array<PreviousConsentSession>, Integer, Hash)>) —

Array<PreviousConsentSession> data, response status code and response headers

# File 'lib/ory-client/api/admin_api.rb', line 1362

def list_subject_consent_sessions_with_http_info(subject, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.list_subject_consent_sessions ...'
  end
  # verify the required parameter 'subject' is set
  if @api_client.config.client_side_validation && subject.nil?
    fail ArgumentError, "Missing the required parameter 'subject' when calling AdminApi.list_subject_consent_sessions"
  end
  # resource path
  local_var_path = '/oauth2/auth/sessions/consent'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'subject'] = subject
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<PreviousConsentSession>'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"AdminApi.list_subject_consent_sessions",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdminApi#list_subject_consent_sessions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#list_trusted_jwt_grant_issuers(opts = {}) ⇒ `Array<TrustedJwtGrantIssuer>`

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

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:issuer (String) —

If optional "issuer" is supplied, only jwt-bearer grants with this issuer will be returned.
:limit (Integer) —

The maximum amount of policies returned, upper bound is 500 policies
:offset (Integer) —

The offset from where to start looking.

Returns:

(Array<TrustedJwtGrantIssuer>)

# File 'lib/ory-client/api/admin_api.rb', line 1420

def list_trusted_jwt_grant_issuers(opts = {})
  data, _status_code, _headers = list_trusted_jwt_grant_issuers_with_http_info(opts)
  data
end

#list_trusted_jwt_grant_issuers_with_http_info(opts = {}) ⇒ `Array<(Array<TrustedJwtGrantIssuer>, Integer, Hash)>`

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

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:issuer (String) —

If optional "issuer" is supplied, only jwt-bearer grants with this issuer will be returned.
:limit (Integer) —

The maximum amount of policies returned, upper bound is 500 policies
:offset (Integer) —

The offset from where to start looking.

Returns:

(Array<(Array<TrustedJwtGrantIssuer>, Integer, Hash)>) —

Array<TrustedJwtGrantIssuer> data, response status code and response headers

# File 'lib/ory-client/api/admin_api.rb', line 1432

def list_trusted_jwt_grant_issuers_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.list_trusted_jwt_grant_issuers ...'
  end
  # resource path
  local_var_path = '/trust/grants/jwt-bearer/issuers'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'issuer'] = opts[:'issuer'] if !opts[:'issuer'].nil?
  query_params[:'limit'] = opts[:'limit'] if !opts[:'limit'].nil?
  query_params[:'offset'] = opts[:'offset'] if !opts[:'offset'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type] || 'Array<TrustedJwtGrantIssuer>'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"AdminApi.list_trusted_jwt_grant_issuers",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdminApi#list_trusted_jwt_grant_issuers\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#patch_o_auth2_client(id, patch_document, opts = {}) ⇒ `OAuth2Client`

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.

Parameters:

id (String) —

The id of the OAuth 2.0 Client.
patch_document (Array<PatchDocument>)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(OAuth2Client)

# File 'lib/ory-client/api/admin_api.rb', line 1485

def patch_o_auth2_client(id, patch_document, opts = {})
  data, _status_code, _headers = patch_o_auth2_client_with_http_info(id, patch_document, opts)
  data
end

#patch_o_auth2_client_with_http_info(id, patch_document, opts = {}) ⇒ `Array<(OAuth2Client, Integer, Hash)>`

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.

Parameters:

id (String) —

The id of the OAuth 2.0 Client.
patch_document (Array<PatchDocument>)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(OAuth2Client, Integer, Hash)>) —

OAuth2Client data, response status code and response headers

# File 'lib/ory-client/api/admin_api.rb', line 1496

def patch_o_auth2_client_with_http_info(id, patch_document, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.patch_o_auth2_client ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AdminApi.patch_o_auth2_client"
  end
  # verify the required parameter 'patch_document' is set
  if @api_client.config.client_side_validation && patch_document.nil?
    fail ArgumentError, "Missing the required parameter 'patch_document' when calling AdminApi.patch_o_auth2_client"
  end
  # resource path
  local_var_path = '/clients/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(patch_document)

  # return_type
  return_type = opts[:debug_return_type] || 'OAuth2Client'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"AdminApi.patch_o_auth2_client",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PATCH, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdminApi#patch_o_auth2_client\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#reject_consent_request(consent_challenge, opts = {}) ⇒ `CompletedRequest`

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:

consent_challenge (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:reject_request (RejectRequest)

Returns:

(CompletedRequest)

# File 'lib/ory-client/api/admin_api.rb', line 1559

def reject_consent_request(consent_challenge, opts = {})
  data, _status_code, _headers = reject_consent_request_with_http_info(consent_challenge, opts)
  data
end

#reject_consent_request_with_http_info(consent_challenge, opts = {}) ⇒ `Array<(CompletedRequest, Integer, Hash)>`

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:

consent_challenge (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:reject_request (RejectRequest)

Returns:

(Array<(CompletedRequest, Integer, Hash)>) —

CompletedRequest data, response status code and response headers

# File 'lib/ory-client/api/admin_api.rb', line 1570

def reject_consent_request_with_http_info(consent_challenge, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.reject_consent_request ...'
  end
  # verify the required parameter 'consent_challenge' is set
  if @api_client.config.client_side_validation && consent_challenge.nil?
    fail ArgumentError, "Missing the required parameter 'consent_challenge' when calling AdminApi.reject_consent_request"
  end
  # resource path
  local_var_path = '/oauth2/auth/requests/consent/reject'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'consent_challenge'] = consent_challenge

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'reject_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'CompletedRequest'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"AdminApi.reject_consent_request",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdminApi#reject_consent_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#reject_login_request(login_challenge, opts = {}) ⇒ `CompletedRequest`

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:

login_challenge (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:reject_request (RejectRequest)

Returns:

(CompletedRequest)

# File 'lib/ory-client/api/admin_api.rb', line 1630

def reject_login_request(login_challenge, opts = {})
  data, _status_code, _headers = reject_login_request_with_http_info(login_challenge, opts)
  data
end

#reject_login_request_with_http_info(login_challenge, opts = {}) ⇒ `Array<(CompletedRequest, Integer, Hash)>`

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:

login_challenge (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:reject_request (RejectRequest)

Returns:

(Array<(CompletedRequest, Integer, Hash)>) —

CompletedRequest data, response status code and response headers

# File 'lib/ory-client/api/admin_api.rb', line 1641

def reject_login_request_with_http_info(login_challenge, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.reject_login_request ...'
  end
  # verify the required parameter 'login_challenge' is set
  if @api_client.config.client_side_validation && login_challenge.nil?
    fail ArgumentError, "Missing the required parameter 'login_challenge' when calling AdminApi.reject_login_request"
  end
  # resource path
  local_var_path = '/oauth2/auth/requests/login/reject'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'login_challenge'] = login_challenge

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'reject_request'])

  # return_type
  return_type = opts[:debug_return_type] || 'CompletedRequest'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"AdminApi.reject_login_request",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdminApi#reject_login_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#reject_logout_request(logout_challenge, opts = {}) ⇒ `nil`

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:

logout_challenge (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:reject_request (RejectRequest)

Returns:

(nil)

# File 'lib/ory-client/api/admin_api.rb', line 1701

def reject_logout_request(logout_challenge, opts = {})
  reject_logout_request_with_http_info(logout_challenge, opts)
  nil
end

#reject_logout_request_with_http_info(logout_challenge, opts = {}) ⇒ `Array<(nil, Integer, Hash)>`

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:

logout_challenge (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:reject_request (RejectRequest)

Returns:

(Array<(nil, Integer, Hash)>) —

nil, response status code and response headers

# File 'lib/ory-client/api/admin_api.rb', line 1712

def reject_logout_request_with_http_info(logout_challenge, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.reject_logout_request ...'
  end
  # verify the required parameter 'logout_challenge' is set
  if @api_client.config.client_side_validation && logout_challenge.nil?
    fail ArgumentError, "Missing the required parameter 'logout_challenge' when calling AdminApi.reject_logout_request"
  end
  # resource path
  local_var_path = '/oauth2/auth/requests/logout/reject'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'logout_challenge'] = logout_challenge

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json', 'application/x-www-form-urlencoded'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'reject_request'])

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"AdminApi.reject_logout_request",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdminApi#reject_logout_request\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#revoke_authentication_session(subject, opts = {}) ⇒ `nil`

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 (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(nil)

# File 'lib/ory-client/api/admin_api.rb', line 1771

def revoke_authentication_session(subject, opts = {})
  revoke_authentication_session_with_http_info(subject, opts)
  nil
end

#revoke_authentication_session_with_http_info(subject, opts = {}) ⇒ `Array<(nil, Integer, Hash)>`

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 (String)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(nil, Integer, Hash)>) —

nil, response status code and response headers

# File 'lib/ory-client/api/admin_api.rb', line 1781

def revoke_authentication_session_with_http_info(subject, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.revoke_authentication_session ...'
  end
  # verify the required parameter 'subject' is set
  if @api_client.config.client_side_validation && subject.nil?
    fail ArgumentError, "Missing the required parameter 'subject' when calling AdminApi.revoke_authentication_session"
  end
  # resource path
  local_var_path = '/oauth2/auth/sessions/login'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'subject'] = subject

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"AdminApi.revoke_authentication_session",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdminApi#revoke_authentication_session\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#revoke_consent_sessions(subject, opts = {}) ⇒ `nil`

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 (String) —

The subject (Subject) who's consent sessions should be deleted.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:client (String) —

If set, deletes only those consent sessions by the Subject that have been granted to the specified OAuth 2.0 Client ID
:all (Boolean) —

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

Returns:

(nil)

# File 'lib/ory-client/api/admin_api.rb', line 1837

def revoke_consent_sessions(subject, opts = {})
  revoke_consent_sessions_with_http_info(subject, opts)
  nil
end

#revoke_consent_sessions_with_http_info(subject, opts = {}) ⇒ `Array<(nil, Integer, Hash)>`

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 (String) —

The subject (Subject) who's consent sessions should be deleted.
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:client (String) —

If set, deletes only those consent sessions by the Subject that have been granted to the specified OAuth 2.0 Client ID
:all (Boolean) —

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

Returns:

(Array<(nil, Integer, Hash)>) —

nil, response status code and response headers

# File 'lib/ory-client/api/admin_api.rb', line 1849

def revoke_consent_sessions_with_http_info(subject, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.revoke_consent_sessions ...'
  end
  # verify the required parameter 'subject' is set
  if @api_client.config.client_side_validation && subject.nil?
    fail ArgumentError, "Missing the required parameter 'subject' when calling AdminApi.revoke_consent_sessions"
  end
  # resource path
  local_var_path = '/oauth2/auth/sessions/consent'

  # query parameters
  query_params = opts[:query_params] || {}
  query_params[:'subject'] = subject
  query_params[:'client'] = opts[:'client'] if !opts[:'client'].nil?
  query_params[:'all'] = opts[:'all'] if !opts[:'all'].nil?

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body]

  # return_type
  return_type = opts[:debug_return_type]

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"AdminApi.revoke_consent_sessions",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:DELETE, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdminApi#revoke_consent_sessions\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#trust_jwt_grant_issuer(opts = {}) ⇒ `TrustedJwtGrantIssuer`

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](datatracker.ietf.org/doc/html/rfc7523).

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:trust_jwt_grant_issuer_body (TrustJwtGrantIssuerBody)

Returns:

(TrustedJwtGrantIssuer)

# File 'lib/ory-client/api/admin_api.rb', line 1905

def trust_jwt_grant_issuer(opts = {})
  data, _status_code, _headers = trust_jwt_grant_issuer_with_http_info(opts)
  data
end

#trust_jwt_grant_issuer_with_http_info(opts = {}) ⇒ `Array<(TrustedJwtGrantIssuer, Integer, Hash)>`

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](datatracker.ietf.org/doc/html/rfc7523).

Parameters:

opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:trust_jwt_grant_issuer_body (TrustJwtGrantIssuerBody)

Returns:

(Array<(TrustedJwtGrantIssuer, Integer, Hash)>) —

TrustedJwtGrantIssuer data, response status code and response headers

# File 'lib/ory-client/api/admin_api.rb', line 1915

def trust_jwt_grant_issuer_with_http_info(opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.trust_jwt_grant_issuer ...'
  end
  # resource path
  local_var_path = '/trust/grants/jwt-bearer/issuers'

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'trust_jwt_grant_issuer_body'])

  # return_type
  return_type = opts[:debug_return_type] || 'TrustedJwtGrantIssuer'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"AdminApi.trust_jwt_grant_issuer",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:POST, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdminApi#trust_jwt_grant_issuer\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_json_web_key(kid, set, opts = {}) ⇒ `JSONWebKey`

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 (String) —

The kid of the desired key
set (String) —

The set
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:json_web_key (JSONWebKey)

Returns:

(JSONWebKey)

# File 'lib/ory-client/api/admin_api.rb', line 1971

def update_json_web_key(kid, set, opts = {})
  data, _status_code, _headers = update_json_web_key_with_http_info(kid, set, opts)
  data
end

#update_json_web_key_set(set, opts = {}) ⇒ `JSONWebKeySet`

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 (String) —

The set
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:json_web_key_set (JSONWebKeySet)

Returns:

(JSONWebKeySet)

# File 'lib/ory-client/api/admin_api.rb', line 2046

def update_json_web_key_set(set, opts = {})
  data, _status_code, _headers = update_json_web_key_set_with_http_info(set, opts)
  data
end

#update_json_web_key_set_with_http_info(set, opts = {}) ⇒ `Array<(JSONWebKeySet, Integer, Hash)>`

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 (String) —

The set
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:json_web_key_set (JSONWebKeySet)

Returns:

(Array<(JSONWebKeySet, Integer, Hash)>) —

JSONWebKeySet data, response status code and response headers

# File 'lib/ory-client/api/admin_api.rb', line 2057

def update_json_web_key_set_with_http_info(set, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.update_json_web_key_set ...'
  end
  # verify the required parameter 'set' is set
  if @api_client.config.client_side_validation && set.nil?
    fail ArgumentError, "Missing the required parameter 'set' when calling AdminApi.update_json_web_key_set"
  end
  # resource path
  local_var_path = '/keys/{set}'.sub('{' + 'set' + '}', CGI.escape(set.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'json_web_key_set'])

  # return_type
  return_type = opts[:debug_return_type] || 'JSONWebKeySet'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"AdminApi.update_json_web_key_set",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdminApi#update_json_web_key_set\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_json_web_key_with_http_info(kid, set, opts = {}) ⇒ `Array<(JSONWebKey, Integer, Hash)>`

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 (String) —

The kid of the desired key
set (String) —

The set
opts (Hash) (defaults to: {}) —

the optional parameters

Options Hash (opts):

:json_web_key (JSONWebKey)

Returns:

(Array<(JSONWebKey, Integer, Hash)>) —

JSONWebKey data, response status code and response headers

# File 'lib/ory-client/api/admin_api.rb', line 1983

def update_json_web_key_with_http_info(kid, set, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.update_json_web_key ...'
  end
  # verify the required parameter 'kid' is set
  if @api_client.config.client_side_validation && kid.nil?
    fail ArgumentError, "Missing the required parameter 'kid' when calling AdminApi.update_json_web_key"
  end
  # verify the required parameter 'set' is set
  if @api_client.config.client_side_validation && set.nil?
    fail ArgumentError, "Missing the required parameter 'set' when calling AdminApi.update_json_web_key"
  end
  # resource path
  local_var_path = '/keys/{set}/{kid}'.sub('{' + 'kid' + '}', CGI.escape(kid.to_s)).sub('{' + 'set' + '}', CGI.escape(set.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(opts[:'json_web_key'])

  # return_type
  return_type = opts[:debug_return_type] || 'JSONWebKey'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"AdminApi.update_json_web_key",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdminApi#update_json_web_key\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

#update_o_auth2_client(id, o_auth2_client, opts = {}) ⇒ `OAuth2Client`

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.

Parameters:

id (String) —

The id of the OAuth 2.0 Client.
o_auth2_client (OAuth2Client)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(OAuth2Client)

# File 'lib/ory-client/api/admin_api.rb', line 2116

def update_o_auth2_client(id, o_auth2_client, opts = {})
  data, _status_code, _headers = update_o_auth2_client_with_http_info(id, o_auth2_client, opts)
  data
end

#update_o_auth2_client_with_http_info(id, o_auth2_client, opts = {}) ⇒ `Array<(OAuth2Client, Integer, Hash)>`

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.

Parameters:

id (String) —

The id of the OAuth 2.0 Client.
o_auth2_client (OAuth2Client)
opts (Hash) (defaults to: {}) —

the optional parameters

Returns:

(Array<(OAuth2Client, Integer, Hash)>) —

OAuth2Client data, response status code and response headers

# File 'lib/ory-client/api/admin_api.rb', line 2127

def update_o_auth2_client_with_http_info(id, o_auth2_client, opts = {})
  if @api_client.config.debugging
    @api_client.config.logger.debug 'Calling API: AdminApi.update_o_auth2_client ...'
  end
  # verify the required parameter 'id' is set
  if @api_client.config.client_side_validation && id.nil?
    fail ArgumentError, "Missing the required parameter 'id' when calling AdminApi.update_o_auth2_client"
  end
  # verify the required parameter 'o_auth2_client' is set
  if @api_client.config.client_side_validation && o_auth2_client.nil?
    fail ArgumentError, "Missing the required parameter 'o_auth2_client' when calling AdminApi.update_o_auth2_client"
  end
  # resource path
  local_var_path = '/clients/{id}'.sub('{' + 'id' + '}', CGI.escape(id.to_s))

  # query parameters
  query_params = opts[:query_params] || {}

  # header parameters
  header_params = opts[:header_params] || {}
  # HTTP header 'Accept' (if needed)
  header_params['Accept'] = @api_client.select_header_accept(['application/json'])
  # HTTP header 'Content-Type'
  content_type = @api_client.select_header_content_type(['application/json'])
  if !content_type.nil?
      header_params['Content-Type'] = content_type
  end

  # form parameters
  form_params = opts[:form_params] || {}

  # http body (model)
  post_body = opts[:debug_body] || @api_client.object_to_http_body(o_auth2_client)

  # return_type
  return_type = opts[:debug_return_type] || 'OAuth2Client'

  # auth_names
  auth_names = opts[:debug_auth_names] || []

  new_options = opts.merge(
    :operation => :"AdminApi.update_o_auth2_client",
    :header_params => header_params,
    :query_params => query_params,
    :form_params => form_params,
    :body => post_body,
    :auth_names => auth_names,
    :return_type => return_type
  )

  data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
  if @api_client.config.debugging
    @api_client.config.logger.debug "API called: AdminApi#update_o_auth2_client\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
  end
  return data, status_code, headers
end

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(api_client = ApiClient.default) ⇒ AdminApi

Instance Attribute Details

#api_client ⇒ Object

Instance Method Details

#accept_consent_request(consent_challenge, opts = {}) ⇒ CompletedRequest

#accept_consent_request_with_http_info(consent_challenge, opts = {}) ⇒ Array<(CompletedRequest, Integer, Hash)>

#accept_login_request(login_challenge, opts = {}) ⇒ CompletedRequest

#accept_login_request_with_http_info(login_challenge, opts = {}) ⇒ Array<(CompletedRequest, Integer, Hash)>

#accept_logout_request(logout_challenge, opts = {}) ⇒ CompletedRequest

#accept_logout_request_with_http_info(logout_challenge, opts = {}) ⇒ Array<(CompletedRequest, Integer, Hash)>

#create_json_web_key_set(set, opts = {}) ⇒ JSONWebKeySet

#create_json_web_key_set_with_http_info(set, opts = {}) ⇒ Array<(JSONWebKeySet, Integer, Hash)>

#create_o_auth2_client(o_auth2_client, opts = {}) ⇒ OAuth2Client

#create_o_auth2_client_with_http_info(o_auth2_client, opts = {}) ⇒ Array<(OAuth2Client, Integer, Hash)>

#delete_json_web_key(kid, set, opts = {}) ⇒ nil

#delete_json_web_key_set(set, opts = {}) ⇒ nil

#delete_json_web_key_set_with_http_info(set, opts = {}) ⇒ Array<(nil, Integer, Hash)>

#delete_json_web_key_with_http_info(kid, set, opts = {}) ⇒ Array<(nil, Integer, Hash)>

#delete_o_auth2_client(id, opts = {}) ⇒ nil

#delete_o_auth2_client_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

#delete_o_auth2_token(client_id, opts = {}) ⇒ nil

#delete_o_auth2_token_with_http_info(client_id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

#delete_trusted_jwt_grant_issuer(id, opts = {}) ⇒ nil

#delete_trusted_jwt_grant_issuer_with_http_info(id, opts = {}) ⇒ Array<(nil, Integer, Hash)>

#flush_inactive_o_auth2_tokens(opts = {}) ⇒ nil

#flush_inactive_o_auth2_tokens_with_http_info(opts = {}) ⇒ Array<(nil, Integer, Hash)>

#get_consent_request(consent_challenge, opts = {}) ⇒ ConsentRequest

#get_consent_request_with_http_info(consent_challenge, opts = {}) ⇒ Array<(ConsentRequest, Integer, Hash)>

#get_json_web_key(kid, set, opts = {}) ⇒ JSONWebKeySet

#get_json_web_key_set(set, opts = {}) ⇒ JSONWebKeySet

#get_json_web_key_set_with_http_info(set, opts = {}) ⇒ Array<(JSONWebKeySet, Integer, Hash)>

#get_json_web_key_with_http_info(kid, set, opts = {}) ⇒ Array<(JSONWebKeySet, Integer, Hash)>

#get_login_request(login_challenge, opts = {}) ⇒ LoginRequest

#get_login_request_with_http_info(login_challenge, opts = {}) ⇒ Array<(LoginRequest, Integer, Hash)>

#get_logout_request(logout_challenge, opts = {}) ⇒ LogoutRequest

#get_logout_request_with_http_info(logout_challenge, opts = {}) ⇒ Array<(LogoutRequest, Integer, Hash)>

#get_o_auth2_client(id, opts = {}) ⇒ OAuth2Client

#get_o_auth2_client_with_http_info(id, opts = {}) ⇒ Array<(OAuth2Client, Integer, Hash)>

#get_trusted_jwt_grant_issuer(id, opts = {}) ⇒ TrustedJwtGrantIssuer

#get_trusted_jwt_grant_issuer_with_http_info(id, opts = {}) ⇒ Array<(TrustedJwtGrantIssuer, Integer, Hash)>

#introspect_o_auth2_token(token, opts = {}) ⇒ OAuth2TokenIntrospection

#introspect_o_auth2_token_with_http_info(token, opts = {}) ⇒ Array<(OAuth2TokenIntrospection, Integer, Hash)>

#list_o_auth2_clients(opts = {}) ⇒ Array<OAuth2Client>

#list_o_auth2_clients_with_http_info(opts = {}) ⇒ Array<(Array<OAuth2Client>, Integer, Hash)>

#list_subject_consent_sessions(subject, opts = {}) ⇒ Array<PreviousConsentSession>

#list_subject_consent_sessions_with_http_info(subject, opts = {}) ⇒ Array<(Array<PreviousConsentSession>, Integer, Hash)>

#list_trusted_jwt_grant_issuers(opts = {}) ⇒ Array<TrustedJwtGrantIssuer>

#list_trusted_jwt_grant_issuers_with_http_info(opts = {}) ⇒ Array<(Array<TrustedJwtGrantIssuer>, Integer, Hash)>

#patch_o_auth2_client(id, patch_document, opts = {}) ⇒ OAuth2Client

#patch_o_auth2_client_with_http_info(id, patch_document, opts = {}) ⇒ Array<(OAuth2Client, Integer, Hash)>

#reject_consent_request(consent_challenge, opts = {}) ⇒ CompletedRequest

#reject_consent_request_with_http_info(consent_challenge, opts = {}) ⇒ Array<(CompletedRequest, Integer, Hash)>

#reject_login_request(login_challenge, opts = {}) ⇒ CompletedRequest

#reject_login_request_with_http_info(login_challenge, opts = {}) ⇒ Array<(CompletedRequest, Integer, Hash)>

#reject_logout_request(logout_challenge, opts = {}) ⇒ nil

#reject_logout_request_with_http_info(logout_challenge, opts = {}) ⇒ Array<(nil, Integer, Hash)>

#revoke_authentication_session(subject, opts = {}) ⇒ nil

#revoke_authentication_session_with_http_info(subject, opts = {}) ⇒ Array<(nil, Integer, Hash)>

#revoke_consent_sessions(subject, opts = {}) ⇒ nil

#revoke_consent_sessions_with_http_info(subject, opts = {}) ⇒ Array<(nil, Integer, Hash)>

#trust_jwt_grant_issuer(opts = {}) ⇒ TrustedJwtGrantIssuer

#trust_jwt_grant_issuer_with_http_info(opts = {}) ⇒ Array<(TrustedJwtGrantIssuer, Integer, Hash)>

#update_json_web_key(kid, set, opts = {}) ⇒ JSONWebKey

#update_json_web_key_set(set, opts = {}) ⇒ JSONWebKeySet

#update_json_web_key_set_with_http_info(set, opts = {}) ⇒ Array<(JSONWebKeySet, Integer, Hash)>

#update_json_web_key_with_http_info(kid, set, opts = {}) ⇒ Array<(JSONWebKey, Integer, Hash)>

#update_o_auth2_client(id, o_auth2_client, opts = {}) ⇒ OAuth2Client

#update_o_auth2_client_with_http_info(id, o_auth2_client, opts = {}) ⇒ Array<(OAuth2Client, Integer, Hash)>

#initialize(api_client = ApiClient.default) ⇒ `AdminApi`

#api_client ⇒ `Object`

#accept_consent_request(consent_challenge, opts = {}) ⇒ `CompletedRequest`

#accept_consent_request_with_http_info(consent_challenge, opts = {}) ⇒ `Array<(CompletedRequest, Integer, Hash)>`

#accept_login_request(login_challenge, opts = {}) ⇒ `CompletedRequest`

#accept_login_request_with_http_info(login_challenge, opts = {}) ⇒ `Array<(CompletedRequest, Integer, Hash)>`

#accept_logout_request(logout_challenge, opts = {}) ⇒ `CompletedRequest`

#accept_logout_request_with_http_info(logout_challenge, opts = {}) ⇒ `Array<(CompletedRequest, Integer, Hash)>`

#create_json_web_key_set(set, opts = {}) ⇒ `JSONWebKeySet`

#create_json_web_key_set_with_http_info(set, opts = {}) ⇒ `Array<(JSONWebKeySet, Integer, Hash)>`

#create_o_auth2_client(o_auth2_client, opts = {}) ⇒ `OAuth2Client`

#create_o_auth2_client_with_http_info(o_auth2_client, opts = {}) ⇒ `Array<(OAuth2Client, Integer, Hash)>`

#delete_json_web_key(kid, set, opts = {}) ⇒ `nil`

#delete_json_web_key_set(set, opts = {}) ⇒ `nil`

#delete_json_web_key_set_with_http_info(set, opts = {}) ⇒ `Array<(nil, Integer, Hash)>`

#delete_json_web_key_with_http_info(kid, set, opts = {}) ⇒ `Array<(nil, Integer, Hash)>`

#delete_o_auth2_client(id, opts = {}) ⇒ `nil`

#delete_o_auth2_client_with_http_info(id, opts = {}) ⇒ `Array<(nil, Integer, Hash)>`

#delete_o_auth2_token(client_id, opts = {}) ⇒ `nil`

#delete_o_auth2_token_with_http_info(client_id, opts = {}) ⇒ `Array<(nil, Integer, Hash)>`

#delete_trusted_jwt_grant_issuer(id, opts = {}) ⇒ `nil`

#delete_trusted_jwt_grant_issuer_with_http_info(id, opts = {}) ⇒ `Array<(nil, Integer, Hash)>`

#flush_inactive_o_auth2_tokens(opts = {}) ⇒ `nil`

#flush_inactive_o_auth2_tokens_with_http_info(opts = {}) ⇒ `Array<(nil, Integer, Hash)>`

#get_consent_request(consent_challenge, opts = {}) ⇒ `ConsentRequest`

#get_consent_request_with_http_info(consent_challenge, opts = {}) ⇒ `Array<(ConsentRequest, Integer, Hash)>`

#get_json_web_key(kid, set, opts = {}) ⇒ `JSONWebKeySet`

#get_json_web_key_set(set, opts = {}) ⇒ `JSONWebKeySet`

#get_json_web_key_set_with_http_info(set, opts = {}) ⇒ `Array<(JSONWebKeySet, Integer, Hash)>`

#get_json_web_key_with_http_info(kid, set, opts = {}) ⇒ `Array<(JSONWebKeySet, Integer, Hash)>`

#get_login_request(login_challenge, opts = {}) ⇒ `LoginRequest`

#get_login_request_with_http_info(login_challenge, opts = {}) ⇒ `Array<(LoginRequest, Integer, Hash)>`

#get_logout_request(logout_challenge, opts = {}) ⇒ `LogoutRequest`

#get_logout_request_with_http_info(logout_challenge, opts = {}) ⇒ `Array<(LogoutRequest, Integer, Hash)>`

#get_o_auth2_client(id, opts = {}) ⇒ `OAuth2Client`

#get_o_auth2_client_with_http_info(id, opts = {}) ⇒ `Array<(OAuth2Client, Integer, Hash)>`

#get_trusted_jwt_grant_issuer(id, opts = {}) ⇒ `TrustedJwtGrantIssuer`

#get_trusted_jwt_grant_issuer_with_http_info(id, opts = {}) ⇒ `Array<(TrustedJwtGrantIssuer, Integer, Hash)>`

#introspect_o_auth2_token(token, opts = {}) ⇒ `OAuth2TokenIntrospection`

#introspect_o_auth2_token_with_http_info(token, opts = {}) ⇒ `Array<(OAuth2TokenIntrospection, Integer, Hash)>`

#list_o_auth2_clients(opts = {}) ⇒ `Array<OAuth2Client>`

#list_o_auth2_clients_with_http_info(opts = {}) ⇒ `Array<(Array<OAuth2Client>, Integer, Hash)>`

#list_subject_consent_sessions(subject, opts = {}) ⇒ `Array<PreviousConsentSession>`

#list_subject_consent_sessions_with_http_info(subject, opts = {}) ⇒ `Array<(Array<PreviousConsentSession>, Integer, Hash)>`

#list_trusted_jwt_grant_issuers(opts = {}) ⇒ `Array<TrustedJwtGrantIssuer>`

#list_trusted_jwt_grant_issuers_with_http_info(opts = {}) ⇒ `Array<(Array<TrustedJwtGrantIssuer>, Integer, Hash)>`

#patch_o_auth2_client(id, patch_document, opts = {}) ⇒ `OAuth2Client`

#patch_o_auth2_client_with_http_info(id, patch_document, opts = {}) ⇒ `Array<(OAuth2Client, Integer, Hash)>`

#reject_consent_request(consent_challenge, opts = {}) ⇒ `CompletedRequest`

#reject_consent_request_with_http_info(consent_challenge, opts = {}) ⇒ `Array<(CompletedRequest, Integer, Hash)>`

#reject_login_request(login_challenge, opts = {}) ⇒ `CompletedRequest`

#reject_login_request_with_http_info(login_challenge, opts = {}) ⇒ `Array<(CompletedRequest, Integer, Hash)>`

#reject_logout_request(logout_challenge, opts = {}) ⇒ `nil`

#reject_logout_request_with_http_info(logout_challenge, opts = {}) ⇒ `Array<(nil, Integer, Hash)>`

#revoke_authentication_session(subject, opts = {}) ⇒ `nil`

#revoke_authentication_session_with_http_info(subject, opts = {}) ⇒ `Array<(nil, Integer, Hash)>`

#revoke_consent_sessions(subject, opts = {}) ⇒ `nil`

#revoke_consent_sessions_with_http_info(subject, opts = {}) ⇒ `Array<(nil, Integer, Hash)>`

#trust_jwt_grant_issuer(opts = {}) ⇒ `TrustedJwtGrantIssuer`

#trust_jwt_grant_issuer_with_http_info(opts = {}) ⇒ `Array<(TrustedJwtGrantIssuer, Integer, Hash)>`

#update_json_web_key(kid, set, opts = {}) ⇒ `JSONWebKey`

#update_json_web_key_set(set, opts = {}) ⇒ `JSONWebKeySet`

#update_json_web_key_set_with_http_info(set, opts = {}) ⇒ `Array<(JSONWebKeySet, Integer, Hash)>`

#update_json_web_key_with_http_info(kid, set, opts = {}) ⇒ `Array<(JSONWebKey, Integer, Hash)>`

#update_o_auth2_client(id, o_auth2_client, opts = {}) ⇒ `OAuth2Client`

#update_o_auth2_client_with_http_info(id, o_auth2_client, opts = {}) ⇒ `Array<(OAuth2Client, Integer, Hash)>`