Ory.Api.Jwk (ory_client v1.1.23)

API calls for all endpoints tagged Jwk.

Link to this section Summary

Functions

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

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

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

Get JSON Web Key This endpoint returns a singular JSON Web Key contained in a set. It is identified by the set and the specific key ID (kid).

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.

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

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.

Link to this section Functions

Link to this function

create_json_web_key_set(connection, set, create_json_web_key_set, opts \\ [])

@spec create_json_web_key_set(
  Tesla.Env.client(),
  String.t(),
  Ory.Model.CreateJsonWebKeySet.t(),
  keyword()
) ::
  {:ok, Ory.Model.ErrorOAuth2.t()}
  | {:ok, Ory.Model.JsonWebKeySet.t()}
  | {:error, Tesla.Env.t()}

Create 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

Parameters

  • connection (Ory.Connection): Connection to server
  • set (String.t): The JSON Web Key Set ID
  • create_json_web_key_set (CreateJsonWebKeySet):
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, Ory.Model.JsonWebKeySet.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

delete_json_web_key(connection, set, kid, opts \\ [])

@spec delete_json_web_key(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, nil} | {:ok, Ory.Model.ErrorOAuth2.t()} | {:error, Tesla.Env.t()}

Delete 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

Parameters

  • connection (Ory.Connection): Connection to server
  • set (String.t): The JSON Web Key Set
  • kid (String.t): The JSON Web Key ID (kid)
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

delete_json_web_key_set(connection, set, opts \\ [])

@spec delete_json_web_key_set(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, nil} | {:ok, Ory.Model.ErrorOAuth2.t()} | {:error, Tesla.Env.t()}

Delete 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

Parameters

  • connection (Ory.Connection): Connection to server
  • set (String.t): The JSON Web Key Set
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_json_web_key(connection, set, kid, opts \\ [])

@spec get_json_web_key(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, Ory.Model.ErrorOAuth2.t()}
  | {:ok, Ory.Model.JsonWebKeySet.t()}
  | {:error, Tesla.Env.t()}

Get JSON Web Key This endpoint returns a singular JSON Web Key contained in a set. It is identified by the set and the specific key ID (kid).

parameters

Parameters

  • connection (Ory.Connection): Connection to server
  • set (String.t): JSON Web Key Set ID
  • kid (String.t): JSON Web Key ID
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, Ory.Model.JsonWebKeySet.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

get_json_web_key_set(connection, set, opts \\ [])

@spec get_json_web_key_set(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, Ory.Model.ErrorOAuth2.t()}
  | {:ok, Ory.Model.JsonWebKeySet.t()}
  | {:error, Tesla.Env.t()}

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

Parameters

  • connection (Ory.Connection): Connection to server
  • set (String.t): JSON Web Key Set ID
  • opts (keyword): Optional parameters

returns

Returns

  • {:ok, Ory.Model.JsonWebKeySet.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

set_json_web_key(connection, set, kid, opts \\ [])

@spec set_json_web_key(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, Ory.Model.ErrorOAuth2.t()}
  | {:ok, Ory.Model.JsonWebKey.t()}
  | {:error, Tesla.Env.t()}

Set 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

Parameters

  • connection (Ory.Connection): Connection to server
  • set (String.t): The JSON Web Key Set ID
  • kid (String.t): JSON Web Key ID
  • opts (keyword): Optional parameters
    • :body (JsonWebKey):

returns

Returns

  • {:ok, Ory.Model.JsonWebKey.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

set_json_web_key_set(connection, set, opts \\ [])

@spec set_json_web_key_set(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, Ory.Model.ErrorOAuth2.t()}
  | {:ok, Ory.Model.JsonWebKeySet.t()}
  | {:error, Tesla.Env.t()}

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

Parameters

  • connection (Ory.Connection): Connection to server
  • set (String.t): The JSON Web Key Set ID
  • opts (keyword): Optional parameters
    • :body (JsonWebKeySet):

returns

Returns

  • {:ok, Ory.Model.JsonWebKeySet.t} on success
  • {:error, Tesla.Env.t} on failure