OryHydra.API.Jwk

Operations

Jwk

createJsonWebKeySet0

createJsonWebKeySet0

Arguments

:: (Consumes CreateJsonWebKeySet0 MimeJSON, MimeRender MimeJSON CreateJsonWebKeySet)

=> CreateJsonWebKeySet

"createJsonWebKeySet"

-> Set

"set" - The JSON Web Key Set ID

-> OryHydraRequest CreateJsonWebKeySet0 MimeJSON JsonWebKeySet MimeJSON

POST /admin/keys/{set}

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.

data CreateJsonWebKeySet0

Instances

HasBodyParam CreateJsonWebKeySet0 CreateJsonWebKeySet

Defined in OryHydra.API.Jwk

Methods

setBodyParam :: (Consumes CreateJsonWebKeySet0 contentType, MimeRender contentType CreateJsonWebKeySet) => OryHydraRequest CreateJsonWebKeySet0 contentType res accept -> CreateJsonWebKeySet -> OryHydraRequest CreateJsonWebKeySet0 contentType res accept

Consumes CreateJsonWebKeySet0 MimeJSON

application/json

Defined in OryHydra.API.Jwk

Produces CreateJsonWebKeySet0 MimeJSON

application/json

Defined in OryHydra.API.Jwk

deleteJsonWebKey

deleteJsonWebKey

Arguments

:: Set

"set" - The JSON Web Key Set

-> Kid

"kid" - The JSON Web Key ID (kid)

-> OryHydraRequest DeleteJsonWebKey MimeNoContent NoContent MimeNoContent

DELETE /admin/keys/{set}/{kid}

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.

data DeleteJsonWebKey

Instances

Produces DeleteJsonWebKey MimeNoContent

Defined in OryHydra.API.Jwk

deleteJsonWebKeySet

deleteJsonWebKeySet

Arguments

:: Set

"set" - The JSON Web Key Set

-> OryHydraRequest DeleteJsonWebKeySet MimeNoContent NoContent MimeNoContent

DELETE /admin/keys/{set}

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.

data DeleteJsonWebKeySet

Instances

Produces DeleteJsonWebKeySet MimeNoContent

Defined in OryHydra.API.Jwk

getJsonWebKey

getJsonWebKey

Arguments

:: Set

"set" - JSON Web Key Set ID

-> Kid

"kid" - JSON Web Key ID

-> OryHydraRequest GetJsonWebKey MimeNoContent JsonWebKeySet MimeJSON

GET /admin/keys/{set}/{kid}

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

data GetJsonWebKey

Instances

Produces GetJsonWebKey MimeJSON

application/json

Defined in OryHydra.API.Jwk

getJsonWebKeySet

getJsonWebKeySet

Arguments

:: Set

"set" - JSON Web Key Set ID

-> OryHydraRequest GetJsonWebKeySet MimeNoContent JsonWebKeySet MimeJSON

GET /admin/keys/{set}

Retrieve a JSON Web Key Set

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

data GetJsonWebKeySet

Instances

Produces GetJsonWebKeySet MimeJSON

application/json

Defined in OryHydra.API.Jwk

setJsonWebKey

setJsonWebKey

Arguments

:: Consumes SetJsonWebKey MimeJSON

=> Set

"set" - The JSON Web Key Set ID

-> Kid

"kid" - JSON Web Key ID

-> OryHydraRequest SetJsonWebKey MimeJSON JsonWebKey MimeJSON

PUT /admin/keys/{set}/{kid}

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.

data SetJsonWebKey

Instances

HasBodyParam SetJsonWebKey JsonWebKey

Defined in OryHydra.API.Jwk

Methods

setBodyParam :: (Consumes SetJsonWebKey contentType, MimeRender contentType JsonWebKey) => OryHydraRequest SetJsonWebKey contentType res accept -> JsonWebKey -> OryHydraRequest SetJsonWebKey contentType res accept

Consumes SetJsonWebKey MimeJSON

application/json

Defined in OryHydra.API.Jwk

Produces SetJsonWebKey MimeJSON

application/json

Defined in OryHydra.API.Jwk

setJsonWebKeySet

setJsonWebKeySet

Arguments

:: Consumes SetJsonWebKeySet MimeJSON

=> Set

"set" - The JSON Web Key Set ID

-> OryHydraRequest SetJsonWebKeySet MimeJSON JsonWebKeySet MimeJSON

PUT /admin/keys/{set}

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.

data SetJsonWebKeySet

Instances

HasBodyParam SetJsonWebKeySet JsonWebKeySet

Defined in OryHydra.API.Jwk

Methods

setBodyParam :: (Consumes SetJsonWebKeySet contentType, MimeRender contentType JsonWebKeySet) => OryHydraRequest SetJsonWebKeySet contentType res accept -> JsonWebKeySet -> OryHydraRequest SetJsonWebKeySet contentType res accept

Consumes SetJsonWebKeySet MimeJSON

application/json

Defined in OryHydra.API.Jwk

Produces SetJsonWebKeySet MimeJSON

application/json

Defined in OryHydra.API.Jwk