ory_hydra

ORY.Hydra (ory_hydra v1.2.2)

ORY Hydra is an open source OAuth 2.0 and OpenID Connect 1.0 provider. This project provides an Elixir client for interacting with ORY Hydra's administrative REST API.

For additional information about ORY Hydra please refer to their official documentation.

Link to this section Summary

Types

http_headers_t()
http_method_t()
response_t()

Functions

accept_consent_request(params)

Accept a consent request.

accept_login_request(params)

Accept a login request.

accept_logout_request(params)

Accepts a logout request.

check_alive()

Check whether an ORY Hydra service is alive.

create_client(params \\ %{})

Create an OAuth 2.0 client.

delete_client(id)

Delete an OAuth 2.0 client.

delete_jwk(set, kid)

Delete a JSON Web Key.

delete_jwk_set(set)

Delete a JSON Web Key set.

flush_expired_access_tokens(params \\ %{})

Delete expired OAuth2 access tokens.

generate_jwk_set(set, params)

Generate a JSON Web Key set.

get_client(id)

Retrieve an OAuth 2.0 client.

get_consent_request(params)

Retrieve consent request.

get_jwk(set, kid)

Retrieve a JSON Web Key.

get_jwk_set(set)

Retrieve a JSON Web Key set.

get_login_request(params)

Retrieve login request.

get_logout_request(params)

Retrieve logout request.

get_metrics()

Retrieve a metric snapshot from an ORY Hydra service.

get_version()

Retrieve the version of the ORY Hydra service.

introspect(params)

Check whether a token is active.

list_clients(params \\ %{})

List all OAuth 2.0 clients.

list_consent_sessions(params)

List all consent sessions.

reject_consent_request(params)

Reject a consent request.

reject_login_request(params)

Reject a login request.

reject_logout_request(params)

Reject a logout request.

request(operation, config)

Issue a request to the ORY Hydra administrative API.

revoke_consent_sessions(params)

Revoke consent sessions.

revoke_login_sessions(params)

Revoke login sessions.

update_client(id, params)

Update an OAuth 2.0 client.

update_jwk(set, kid, params)

Update a JSON Web Key.

update_jwk_set(set, params)

Update a JSON Web Key set.

Link to this section Types

Link to this type

http_headers_t()

Specs

http_headers_t() :: [{String.t(), String.t()}]
Link to this type

http_method_t()

Specs

http_method_t() :: :delete | :get | :post | :put
Link to this type

response_t()

Specs

response_t() ::
  {:ok, ORY.Hydra.Response.t()} | {:error, ORY.Hydra.Response.t() | any()}

Link to this section Functions

Link to this function

accept_login_request(params)

Specs

accept_login_request(map()) :: ORY.Hydra.Operation.t()

Accept a login request.

Link to this function

accept_logout_request(params)

Specs

accept_logout_request(map()) :: ORY.Hydra.Operation.t()

Accepts a logout request.

Link to this function

check_alive()

Specs

check_alive() :: ORY.Hydra.Operation.t()

Check whether an ORY Hydra service is alive.

Link to this function

create_client(params \\ %{})

Specs

create_client(map()) :: ORY.Hydra.Operation.t()

Create an OAuth 2.0 client.

Link to this function

delete_client(id)

Specs

delete_client(String.t()) :: ORY.Hydra.Operation.t()

Delete an OAuth 2.0 client.

Link to this function

delete_jwk(set, kid)

Specs

delete_jwk(String.t(), String.t()) :: ORY.Hydra.Operation.t()

Delete a JSON Web Key.

Link to this function

delete_jwk_set(set)

Specs

delete_jwk_set(String.t()) :: ORY.Hydra.Operation.t()

Delete a JSON Web Key set.

Link to this function

flush_expired_access_tokens(params \\ %{})

Specs

flush_expired_access_tokens(map()) :: ORY.Hydra.Operation.t()

Delete expired OAuth2 access tokens.

Link to this function

generate_jwk_set(set, params)

Specs

generate_jwk_set(String.t(), map()) :: ORY.Hydra.Operation.t()

Generate a JSON Web Key set.

Link to this function

get_client(id)

Specs

get_client(String.t()) :: ORY.Hydra.Operation.t()

Retrieve an OAuth 2.0 client.

Link to this function

get_jwk(set, kid)

Specs

get_jwk(String.t(), String.t()) :: ORY.Hydra.Operation.t()

Retrieve a JSON Web Key.

Link to this function

get_jwk_set(set)

Specs

get_jwk_set(String.t()) :: ORY.Hydra.Operation.t()

Retrieve a JSON Web Key set.

Link to this function

get_login_request(params)

Specs

get_login_request(map()) :: ORY.Hydra.Operation.t()

Retrieve login request.

Link to this function

get_logout_request(params)

Specs

get_logout_request(map()) :: ORY.Hydra.Operation.t()

Retrieve logout request.

Link to this function

get_metrics()

Specs

get_metrics() :: ORY.Hydra.Operation.t()

Retrieve a metric snapshot from an ORY Hydra service.

Link to this function

get_version()

Specs

get_version() :: ORY.Hydra.Operation.t()

Retrieve the version of the ORY Hydra service.

Link to this function

introspect(params)

Specs

introspect(map()) :: ORY.Hydra.Operation.t()

Check whether a token is active.

Link to this function

list_clients(params \\ %{})

Specs

list_clients(map()) :: ORY.Hydra.Operation.t()

List all OAuth 2.0 clients.

Link to this function

reject_login_request(params)

Specs

reject_login_request(map()) :: ORY.Hydra.Operation.t()

Reject a login request.

Link to this function

reject_logout_request(params)

Specs

reject_logout_request(map()) :: ORY.Hydra.Operation.t()

Reject a logout request.

Link to this function

request(operation, config)

Specs

request(ORY.Hydra.Operation.t(), map()) :: response_t()

Issue a request to the ORY Hydra administrative API.

Link to this function

revoke_login_sessions(params)

Specs

revoke_login_sessions(map()) :: ORY.Hydra.Operation.t()

Revoke login sessions.

Link to this function

update_client(id, params)

Specs

update_client(String.t(), map()) :: ORY.Hydra.Operation.t()

Update an OAuth 2.0 client.

Link to this function

update_jwk(set, kid, params)

Specs

update_jwk(String.t(), String.t(), map()) :: ORY.Hydra.Operation.t()

Update a JSON Web Key.

Link to this function

update_jwk_set(set, params)

Specs

update_jwk_set(String.t(), map()) :: ORY.Hydra.Operation.t()

Update a JSON Web Key set.