Version: v1.5

REST API

Welcome to the ORY Hydra HTTP API documentation. You will find documentation for all HTTP APIs here.

info

You are viewing REST API documentation. This documentation is auto-generated from a swagger specification which itself is generated from annotations in the source code of the project. It is possible that this documentation includes bugs and that code samples are incomplete or wrong.

If you find issues in the respective documentation, please do not edit the Markdown files directly (as they are generated) but raise an issue on the project's GitHub presence instead. This documentation will improve over time with your help! If you have ideas how to improve this part of the documentation, feel free to share them in a GitHub issue any time.

Authentication

  • HTTP Authentication, scheme: basic - OAuth 2.0 Authorization. - Flow: authorizationCode

    • OAuth 2.0 Authorization URL = /oauth2/auth

    • OAuth 2.0 Token URL = /oauth2/token

    • OAuth 2.0 Scope

      ScopeScope Description
      offlineA scope required when requesting refresh tokens (alias for offline_access)
      offline_accessA scope required when requesting refresh tokens
      openidRequest an OpenID Connect ID Token

Public Endpoints

JSON Web Keys Discovery

GET /.well-known/jwks.json HTTP/1.1
Accept: application/json

This endpoint returns JSON Web Keys to be used as public keys for verifying OpenID Connect ID Tokens and, if enabled, OAuth 2.0 JWT Access Tokens. This endpoint can be used with client libraries like node-jwks-rsa among others.

Responses

Overview
StatusMeaningDescriptionSchema
200OKJSONWebKeySetJSONWebKeySet
500Internal Server ErrorgenericErrorgenericError
Examples
200 response
{
"keys": [
{
"alg": "RS256",
"crv": "P-256",
"d": "T_N8I-6He3M8a7X1vWt6TGIx4xB_GP3Mb4SsZSA4v-orvJzzRiQhLlRR81naWYxfQAYt5isDI6_C2L9bdWo4FFPjGQFvNoRX-_sBJyBI_rl-TBgsZYoUlAj3J92WmY2inbA-PwyJfsaIIDceYBC-eX-xiCu6qMqkZi3MwQAFL6bMdPEM0z4JBcwFT3VdiWAIRUuACWQwrXMq672x7fMuaIaHi7XDGgt1ith23CLfaREmJku9PQcchbt_uEY-hqrFY6ntTtS4paWWQj86xLL94S-Tf6v6xkL918PfLSOTq6XCzxvlFwzBJqApnAhbwqLjpPhgUG04EDRrqrSBc5Y1BLevn6Ip5h1AhessBp3wLkQgz_roeckt-ybvzKTjESMuagnpqLvOT7Y9veIug2MwPJZI2VjczRc1vzMs25XrFQ8DpUy-bNdp89TmvAXwctUMiJdgHloJw23Cv03gIUAkDnsTqZmkpbIf-crpgNKFmQP_EDKoe8p_PXZZgfbRri3NoEVGP7Mk6yEu8LjJhClhZaBNjuWw2-KlBfOA3g79mhfBnkInee5KO9mGR50qPk1V-MorUYNTFMZIm0kFE6eYVWFBwJHLKYhHU34DoiK1VP-svZpC2uAMFNA_UJEwM9CQ2b8qe4-5e9aywMvwcuArRkAB5mBIfOaOJao3mfukKAE",
"dp": "G4sPXkc6Ya9y8oJW9_ILj4xuppu0lzi_H7VTkS8xj5SdX3coE0oimYwxIi2emTAue0UOa5dpgFGyBJ4c8tQ2VF402XRugKDTP8akYhFo5tAA77Qe_NmtuYZc3C3m3I24G2GvR5sSDxUyAN2zq8Lfn9EUms6rY3Ob8YeiKkTiBj0",
"dq": "s9lAH9fggBsoFR8Oac2R_E2gw282rT2kGOAhvIllETE1efrA6huUUvMfBcMpn8lqeW6vzznYY5SSQF7pMdC_agI3nG8Ibp1BUb0JUiraRNqUfLhcQb_d9GF4Dh7e74WbRsobRonujTYN1xCaP6TO61jvWrX-L18txXw494Q_cgk",
"e": "AQAB",
"k": "GawgguFyGrWKav7AX4VKUg",
"kid": "1603dfe0af8f4596",
"kty": "RSA",
"n": "vTqrxUyQPl_20aqf5kXHwDZrel-KovIp8s7ewJod2EXHl8tWlRB3_Rem34KwBfqlKQGp1nqah-51H4Jzruqe0cFP58hPEIt6WqrvnmJCXxnNuIB53iX_uUUXXHDHBeaPCSRoNJzNysjoJ30TIUsKBiirhBa7f235PXbKiHducLevV6PcKxJ5cY8zO286qJLBWSPm-OIevwqsIsSIH44Qtm9sioFikhkbLwoqwWORGAY0nl6XvVOlhADdLjBSqSAeT1FPuCDCnXwzCDR8N9IFB_IjdStFkC-rVt2K5BYfPd0c3yFp_vHR15eRd0zJ8XQ7woBC8Vnsac6Et1pKS59pX6256DPWu8UDdEOolKAPgcd_g2NpA76cAaF_jcT80j9KrEzw8Tv0nJBGesuCjPNjGs_KzdkWTUXt23Hn9QJsdc1MZuaW0iqXBepHYfYoqNelzVte117t4BwVp0kUM6we0IqyXClaZgOI8S-WDBw2_Ovdm8e5NmhYAblEVoygcX8Y46oH6bKiaCQfKCFDMcRgChme7AoE1yZZYsPbaG_3IjPrC4LBMHQw8rM9dWjJ8ImjicvZ1pAm0dx-KHCP3y5PVKrxBDf1zSOsBRkOSjB8TPODnJMz6-jd5hTtZxpZPwPoIdCanTZ3ZD6uRBpTmDwtpRGm63UQs1m5FWPwb0T2IF0",
"p": "6NbkXwDWUhi-eR55Cgbf27FkQDDWIamOaDr0rj1q0f1fFEz1W5A_09YvG09Fiv1AO2-D8Rl8gS1Vkz2i0zCSqnyy8A025XOcRviOMK7nIxE4OH_PEsko8dtIrb3TmE2hUXvCkmzw9EsTF1LQBOGC6iusLTXepIC1x9ukCKFZQvdgtEObQ5kzd9Nhq-cdqmSeMVLoxPLd1blviVT9Vm8-y12CtYpeJHOaIDtVPLlBhJiBoPKWg3vxSm4XxIliNOefqegIlsmTIa3MpS6WWlCK3yHhat0Q-rRxDxdyiVdG_wzJvp0Iw_2wms7pe-PgNPYvUWH9JphWP5K38YqEBiJFXQ",
"q": "0A1FmpOWR91_RAWpqreWSavNaZb9nXeKiBo0DQGBz32DbqKqQ8S4aBJmbRhJcctjCLjain-ivut477tAUMmzJwVJDDq2MZFwC9Q-4VYZmFU4HJityQuSzHYe64RjN-E_NQ02TWhG3QGW6roq6c57c99rrUsETwJJiwS8M5p15Miuz53DaOjv-uqqFAFfywN5WkxHbraBcjHtMiQuyQbQqkCFh-oanHkwYNeytsNhTu2mQmwR5DR2roZ2nPiFjC6nsdk-A7E3S3wMzYYFw7jvbWWoYWo9vB40_MY2Y0FYQSqcDzcBIcq_0tnnasf3VW4Fdx6m80RzOb2Fsnln7vKXAQ",
"qi": "GyM_p6JrXySiz1toFgKbWV-JdI3jQ4ypu9rbMWx3rQJBfmt0FoYzgUIZEVFEcOqwemRN81zoDAaa-Bk0KWNGDjJHZDdDmFhW3AN7lI-puxk_mHZGJ11rxyR8O55XLSe3SPmRfKwZI6yU24ZxvQKFYItdldUKGzO6Ia6zTKhAVRU",
"use": "sig",
"x": "f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU",
"x5c": [
"string"
],
"y": "x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0"
}
]
}

Code samples

curl -X GET /.well-known/jwks.json \
-H 'Accept: application/json'

OpenID Connect Discovery

GET /.well-known/openid-configuration HTTP/1.1
Accept: application/json

The well known endpoint an be used to retrieve information for OpenID Connect clients. We encourage you to not roll your own OpenID Connect client but to use an OpenID Connect client library instead. You can learn more on this flow at https://openid.net/specs/openid-connect-discovery-1_0.html .

Popular libraries for OpenID Connect clients include oidc-client-js (JavaScript), go-oidc (Golang), and others. For a full list of clients go here: https://openid.net/developers/certified/

Responses

Overview
StatusMeaningDescriptionSchema
200OKwellKnownwellKnown
401UnauthorizedgenericErrorgenericError
500Internal Server ErrorgenericErrorgenericError
Examples
200 response
{
"authorization_endpoint": "https://playground.ory.sh/ory-hydra/public/oauth2/auth",
"backchannel_logout_session_supported": true,
"backchannel_logout_supported": true,
"claims_parameter_supported": true,
"claims_supported": [
"string"
],
"end_session_endpoint": "string",
"frontchannel_logout_session_supported": true,
"frontchannel_logout_supported": true,
"grant_types_supported": [
"string"
],
"id_token_signing_alg_values_supported": [
"string"
],
"issuer": "https://playground.ory.sh/ory-hydra/public/",
"jwks_uri": "https://playground.ory.sh/ory-hydra/public/.well-known/jwks.json",
"registration_endpoint": "https://playground.ory.sh/ory-hydra/admin/client",
"request_parameter_supported": true,
"request_uri_parameter_supported": true,
"require_request_uri_registration": true,
"response_modes_supported": [
"string"
],
"response_types_supported": [
"string"
],
"revocation_endpoint": "string",
"scopes_supported": [
"string"
],
"subject_types_supported": [
"string"
],
"token_endpoint": "https://playground.ory.sh/ory-hydra/public/oauth2/token",
"token_endpoint_auth_methods_supported": [
"string"
],
"userinfo_endpoint": "string",
"userinfo_signing_alg_values_supported": [
"string"
]
}

Code samples

curl -X GET /.well-known/openid-configuration \
-H 'Accept: application/json'

Check readiness status

GET /health/ready HTTP/1.1
Accept: application/json

This endpoint returns a 200 status code when the HTTP server is up running and the environment dependencies (e.g. the database) are responsive as well.

If the service supports TLS Edge Termination, this endpoint does not require the X-Forwarded-Proto header to be set.

Be aware that if you are running multiple nodes of this service, the health status will never refer to the cluster state, only to a single instance.

Responses

Overview
StatusMeaningDescriptionSchema
200OKhealthStatushealthStatus
503Service UnavailablehealthNotReadyStatushealthNotReadyStatus
Examples
200 response
{
"status": "string"
}

Code samples

curl -X GET /health/ready \
-H 'Accept: application/json'

The OAuth 2.0 authorize endpoint

GET /oauth2/auth HTTP/1.1
Accept: application/json

This endpoint is not documented here because you should never use your own implementation to perform OAuth2 flows. OAuth2 is a very popular protocol and a library for your programming language will exists.

To learn more about this flow please refer to the specification: https://tools.ietf.org/html/rfc6749

Responses

Overview
StatusMeaningDescriptionSchema
302FoundEmpty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is
typically 201.None
401UnauthorizedgenericErrorgenericError
500Internal Server ErrorgenericErrorgenericError
Examples
401 response
{
"debug": "The database adapter was unable to find the element",
"error": "The requested resource could not be found",
"error_description": "Object with ID 12345 does not exist",
"status_code": 404
}

Code samples

curl -X GET /oauth2/auth \
-H 'Accept: application/json'

Revoke OAuth2 tokens

POST /oauth2/revoke HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: application/json

Revoking a token (both access and refresh) means that the tokens will be invalid. A revoked access token can no longer be used to make access requests, and a revoked refresh token can no longer be used to refresh an access token. Revoking a refresh token also invalidates the access token that was created with it. A token may only be revoked by the client the token was generated for.

Request body

token: string

Parameters

ParameterInTypeRequiredDescription
bodybodyobjectfalsenone
» tokenbodystringtruenone

Responses

Overview
StatusMeaningDescriptionSchema
200OKEmpty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is
typically 201.None
401UnauthorizedgenericErrorgenericError
500Internal Server ErrorgenericErrorgenericError
Examples
401 response
{
"debug": "The database adapter was unable to find the element",
"error": "The requested resource could not be found",
"error_description": "Object with ID 12345 does not exist",
"status_code": 404
}

Code samples

curl -X POST /oauth2/revoke \
-H 'Content-Type: application/x-www-form-urlencoded' \ -H 'Accept: application/json'

OpenID Connect Front-Backchannel enabled Logout

GET /oauth2/sessions/logout HTTP/1.1

This endpoint initiates and completes user logout at ORY Hydra and initiates OpenID Connect Front-/Back-channel logout:

https://openid.net/specs/openid-connect-frontchannel-1_0.html https://openid.net/specs/openid-connect-backchannel-1_0.html

Responses

Overview
StatusMeaningDescriptionSchema
302FoundEmpty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is
typically 201.None

Code samples

curl -X GET /oauth2/sessions/logout

The OAuth 2.0 token endpoint

POST /oauth2/token HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: application/json

The client makes a request to the token endpoint by sending the following parameters using the "application/x-www-form-urlencoded" HTTP request entity-body.

Do not implement a client for this endpoint yourself. Use a library. There are many libraries available for any programming language. You can find a list of libraries here: https://oauth.net/code/

Do note that Hydra SDK does not implement this endpoint properly. Use one of the libraries listed above!

Request body

grant_type: string
code: string
refresh_token: string
redirect_uri: string
client_id: string

Parameters

ParameterInTypeRequiredDescription
bodybodyobjectfalsenone
» grant_typebodystringtruenone
» codebodystringfalsenone
» refresh_tokenbodystringfalsenone
» redirect_uribodystringfalsenone
» client_idbodystringfalsenone

Responses

Overview
StatusMeaningDescriptionSchema
200OKoauth2TokenResponseoauth2TokenResponse
401UnauthorizedgenericErrorgenericError
500Internal Server ErrorgenericErrorgenericError
Examples
200 response
{
"access_token": "string",
"expires_in": 0,
"id_token": "string",
"refresh_token": "string",
"scope": "string",
"token_type": "string"
}

Code samples

curl -X POST /oauth2/token \
-H 'Content-Type: application/x-www-form-urlencoded' \ -H 'Accept: application/json'

OpenID Connect Userinfo

GET /userinfo HTTP/1.1
Accept: application/json

This endpoint returns the payload of the ID Token, including the idTokenExtra values, of the provided OAuth 2.0 Access Token.

For more information please refer to the spec.

Responses

Overview
StatusMeaningDescriptionSchema
200OKuserinfoResponseuserinfoResponse
401UnauthorizedgenericErrorgenericError
500Internal Server ErrorgenericErrorgenericError
Examples
200 response
{
"birthdate": "string",
"email": "string",
"email_verified": true,
"family_name": "string",
"gender": "string",
"given_name": "string",
"locale": "string",
"middle_name": "string",
"name": "string",
"nickname": "string",
"phone_number": "string",
"phone_number_verified": true,
"picture": "string",
"preferred_username": "string",
"profile": "string",
"sub": "string",
"updated_at": 0,
"website": "string",
"zoneinfo": "string"
}

Code samples

curl -X GET /userinfo \
-H 'Accept: application/json' \ -H 'Authorization: Bearer {access-token}'

Administrative Endpoints

List OAuth 2.0 Clients

GET /clients HTTP/1.1
Accept: application/json

This endpoint lists all clients in the database, and never returns client secrets.

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. To manage ORY Hydra, you will need an OAuth 2.0 Client as well. Make sure that this endpoint is well protected and only callable by first-party components. The "Link" header is also included in successful responses, which contains one or more links for pagination, formatted like so: 'https://hydra-url/admin/clients?limit={limit}&offset={offset}; rel="{page}"', where page is one of the following applicable pages: 'first', 'next', 'last', and 'previous'. Multiple links can be included in this header, and will be separated by a comma.

Parameters

ParameterInTypeRequiredDescription
limitqueryinteger(int64)falseThe maximum amount of policies returned.
offsetqueryinteger(int64)falseThe offset from where to start looking.

Responses

Overview
StatusMeaningDescriptionSchema
200OKA list of clients.Inline
500Internal Server ErrorgenericErrorgenericError
##### Response Schema

Status Code 200

NameTypeRequiredRestrictionsDescription
anonymous[oAuth2Client]falsenonenone
» Client represents an OAuth 2.0 Client.oAuth2Clientfalsenonenone
»» allowed_cors_origins[string]falsenonenone
»» audience[string]falsenonenone
»» backchannel_logout_session_requiredbooleanfalsenoneBoolean value specifying whether the RP requires that a sid (session ID) Claim be included in the Logout Token to identify the RP session with the OP when the backchannel_logout_uri is used. If omitted, the default value is false.
»» backchannel_logout_uristringfalsenoneRP URL that will cause the RP to log itself out when sent a Logout Token by the OP.
»» client_idstringfalsenoneID is the id for this client.
»» client_namestringfalsenoneName is the human-readable string name of the client to be presented to the end-user during authorization.
»» client_secretstringfalsenoneSecret is the client's secret. The secret will be included in the create request as cleartext, and then never again. The secret is stored using BCrypt so it is impossible to recover it. Tell your users that they need to write the secret down as it will not be made available again.
»» client_secret_expires_atinteger(int64)falsenoneSecretExpiresAt is an integer holding the time at which the client secret will expire or 0 if it will not expire. The time is represented as the number of seconds from 1970-01-01T00:00:00Z as measured in UTC until the date/time of expiration. This feature is currently not supported and it's value will always be set to 0.
»» client_uristringfalsenoneClientURI is an URL string of a web page providing information about the client. If present, the server SHOULD display this URL to the end-user in a clickable fashion.
»» contacts[string]falsenonenone
»» created_atstring(date-time)falsenoneCreatedAt returns the timestamp of the client's creation.
»» frontchannel_logout_session_requiredbooleanfalsenoneBoolean value specifying whether the RP requires that iss (issuer) and sid (session ID) query parameters be included to identify the RP session with the OP when the frontchannel_logout_uri is used. If omitted, the default value is false.
»» frontchannel_logout_uristringfalsenoneRP URL that will cause the RP to log itself out when rendered in an iframe by the OP. An iss (issuer) query parameter and a sid (session ID) query parameter MAY be included by the OP to enable the RP to validate the request and to determine which of the potentially multiple sessions is to be logged out; if either is included, both MUST be.
»» grant_types[string]falsenonenone
»» jwksJoseJSONWebKeySetfalsenonenone
»» jwks_uristringfalsenoneURL for the Client's JSON Web Key Set [JWK] document. If the Client signs requests to the Server, it contains the signing key(s) the Server uses to validate signatures from the Client. The JWK Set MAY also contain the Client's encryption keys(s), which are used by the Server to encrypt responses to the Client. When both signing and encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced JWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both signatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used to provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST match those in the certificate.
»» logo_uristringfalsenoneLogoURI is an URL string that references a logo for the client.
»» metadataJSONRawMessagefalsenonenone
»» ownerstringfalsenoneOwner is a string identifying the owner of the OAuth 2.0 Client.
»» policy_uristringfalsenonePolicyURI is a URL string that points to a human-readable privacy policy document that describes how the deployment organization collects, uses, retains, and discloses personal data.
»» post_logout_redirect_uris[string]falsenonenone
»» redirect_uris[string]falsenonenone
»» request_object_signing_algstringfalsenoneJWS [JWS] alg algorithm [JWA] that MUST be used for signing Request Objects sent to the OP. All Request Objects from this Client MUST be rejected, if not signed with this algorithm.
»» request_uris[string]falsenonenone
»» response_types[string]falsenonenone
»» scopestringfalsenoneScope is a string containing a space-separated list of scope values (as described in Section 3.3 of OAuth 2.0 [RFC6749]) that the client can use when requesting access tokens.
»» sector_identifier_uristringfalsenoneURL using the https scheme to be used in calculating Pseudonymous Identifiers by the OP. The URL references a file with a single JSON array of redirect_uri values.
»» subject_typestringfalsenoneSubjectType requested for responses to this Client. The subject_types_supported Discovery parameter contains a list of the supported subject_type values for this server. Valid types include pairwise and public.
»» token_endpoint_auth_methodstringfalsenoneRequested Client Authentication method for the Token Endpoint. The options are client_secret_post, client_secret_basic, private_key_jwt, and none.
»» token_endpoint_auth_signing_algstringfalsenoneRequested Client Authentication signing algorithm for the Token Endpoint.
»» tos_uristringfalsenoneTermsOfServiceURI is a URL string that points to a human-readable terms of service document for the client that describes a contractual relationship between the end-user and the client that the end-user accepts when authorizing the client.
»» updated_atstring(date-time)falsenoneUpdatedAt returns the timestamp of the last update.
»» userinfo_signed_response_algstringfalsenoneJWS alg algorithm [JWA] REQUIRED for signing UserInfo Responses. If this is specified, the response will be JWT [JWT] serialized, and signed using JWS. The default, if omitted, is for the UserInfo Response to return the Claims as a UTF-8 encoded JSON object using the application/json content-type.
Examples
200 response
[
{
"allowed_cors_origins": [
"string"
],
"audience": [
"string"
],
"backchannel_logout_session_required": true,
"backchannel_logout_uri": "string",
"client_id": "string",
"client_name": "string",
"client_secret": "string",
"client_secret_expires_at": 0,
"client_uri": "string",
"contacts": [
"string"
],
"created_at": "2020-06-23T09:16:53Z",
"frontchannel_logout_session_required": true,
"frontchannel_logout_uri": "string",
"grant_types": [
"string"
],
"jwks": {},
"jwks_uri": "string",
"logo_uri": "string",
"metadata": {},
"owner": "string",
"policy_uri": "string",
"post_logout_redirect_uris": [
"string"
],
"redirect_uris": [
"string"
],
"request_object_signing_alg": "string",
"request_uris": [
"string"
],
"response_types": [
"string"
],
"scope": "string",
"sector_identifier_uri": "string",
"subject_type": "string",
"token_endpoint_auth_method": "string",
"token_endpoint_auth_signing_alg": "string",
"tos_uri": "string",
"updated_at": "2020-06-23T09:16:53Z",
"userinfo_signed_response_alg": "string"
}
]

Code samples

curl -X GET /clients \
-H 'Accept: application/json'

Create an OAuth 2.0 client

POST /clients HTTP/1.1
Content-Type: application/json
Accept: application/json

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. To manage ORY Hydra, you will need an OAuth 2.0 Client as well. Make sure that this endpoint is well protected and only callable by first-party components.

Request body

{
"allowed_cors_origins": [
"string"
],
"audience": [
"string"
],
"backchannel_logout_session_required": true,
"backchannel_logout_uri": "string",
"client_id": "string",
"client_name": "string",
"client_secret": "string",
"client_secret_expires_at": 0,
"client_uri": "string",
"contacts": [
"string"
],
"created_at": "2020-06-23T09:16:53Z",
"frontchannel_logout_session_required": true,
"frontchannel_logout_uri": "string",
"grant_types": [
"string"
],
"jwks": {},
"jwks_uri": "string",
"logo_uri": "string",
"metadata": {},
"owner": "string",
"policy_uri": "string",
"post_logout_redirect_uris": [
"string"
],
"redirect_uris": [
"string"
],
"request_object_signing_alg": "string",
"request_uris": [
"string"
],
"response_types": [
"string"
],
"scope": "string",
"sector_identifier_uri": "string",
"subject_type": "string",
"token_endpoint_auth_method": "string",
"token_endpoint_auth_signing_alg": "string",
"tos_uri": "string",
"updated_at": "2020-06-23T09:16:53Z",
"userinfo_signed_response_alg": "string"
}

Parameters

ParameterInTypeRequiredDescription
bodybodyoAuth2Clienttruenone

Responses

Overview
StatusMeaningDescriptionSchema
201CreatedoAuth2ClientoAuth2Client
400Bad RequestgenericErrorgenericError
409ConflictgenericErrorgenericError
500Internal Server ErrorgenericErrorgenericError
Examples
201 response
{
"allowed_cors_origins": [
"string"
],
"audience": [
"string"
],
"backchannel_logout_session_required": true,
"backchannel_logout_uri": "string",
"client_id": "string",
"client_name": "string",
"client_secret": "string",
"client_secret_expires_at": 0,
"client_uri": "string",
"contacts": [
"string"
],
"created_at": "2020-06-23T09:16:53Z",
"frontchannel_logout_session_required": true,
"frontchannel_logout_uri": "string",
"grant_types": [
"string"
],
"jwks": {},
"jwks_uri": "string",
"logo_uri": "string",
"metadata": {},
"owner": "string",
"policy_uri": "string",
"post_logout_redirect_uris": [
"string"
],
"redirect_uris": [
"string"
],
"request_object_signing_alg": "string",
"request_uris": [
"string"
],
"response_types": [
"string"
],
"scope": "string",
"sector_identifier_uri": "string",
"subject_type": "string",
"token_endpoint_auth_method": "string",
"token_endpoint_auth_signing_alg": "string",
"tos_uri": "string",
"updated_at": "2020-06-23T09:16:53Z",
"userinfo_signed_response_alg": "string"
}

Code samples

curl -X POST /clients \
-H 'Content-Type: application/json' \ -H 'Accept: application/json'

Get an OAuth 2.0 Client.

GET /clients/{id} HTTP/1.1
Accept: application/json

Get an OAUth 2.0 client by its ID. This endpoint never returns passwords.

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. To manage ORY Hydra, you will need an OAuth 2.0 Client as well. Make sure that this endpoint is well protected and only callable by first-party components.

Parameters

ParameterInTypeRequiredDescription
idpathstringtrueThe id of the OAuth 2.0 Client.

Responses

Overview
StatusMeaningDescriptionSchema
200OKoAuth2ClientoAuth2Client
401UnauthorizedgenericErrorgenericError
500Internal Server ErrorgenericErrorgenericError
Examples
200 response
{
"allowed_cors_origins": [
"string"
],
"audience": [
"string"
],
"backchannel_logout_session_required": true,
"backchannel_logout_uri": "string",
"client_id": "string",
"client_name": "string",
"client_secret": "string",
"client_secret_expires_at": 0,
"client_uri": "string",
"contacts": [
"string"
],
"created_at": "2020-06-23T09:16:53Z",
"frontchannel_logout_session_required": true,
"frontchannel_logout_uri": "string",
"grant_types": [
"string"
],
"jwks": {},
"jwks_uri": "string",
"logo_uri": "string",
"metadata": {},
"owner": "string",
"policy_uri": "string",
"post_logout_redirect_uris": [
"string"
],
"redirect_uris": [
"string"
],
"request_object_signing_alg": "string",
"request_uris": [
"string"
],
"response_types": [
"string"
],
"scope": "string",
"sector_identifier_uri": "string",
"subject_type": "string",
"token_endpoint_auth_method": "string",
"token_endpoint_auth_signing_alg": "string",
"tos_uri": "string",
"updated_at": "2020-06-23T09:16:53Z",
"userinfo_signed_response_alg": "string"
}

Code samples

curl -X GET /clients/{id} \
-H 'Accept: application/json'

Update an OAuth 2.0 Client

PUT /clients/{id} HTTP/1.1
Content-Type: application/json
Accept: application/json

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. To manage ORY Hydra, you will need an OAuth 2.0 Client as well. Make sure that this endpoint is well protected and only callable by first-party components.

Request body

{
"allowed_cors_origins": [
"string"
],
"audience": [
"string"
],
"backchannel_logout_session_required": true,
"backchannel_logout_uri": "string",
"client_id": "string",
"client_name": "string",
"client_secret": "string",
"client_secret_expires_at": 0,
"client_uri": "string",
"contacts": [
"string"
],
"created_at": "2020-06-23T09:16:53Z",
"frontchannel_logout_session_required": true,
"frontchannel_logout_uri": "string",
"grant_types": [
"string"
],
"jwks": {},
"jwks_uri": "string",
"logo_uri": "string",
"metadata": {},
"owner": "string",
"policy_uri": "string",
"post_logout_redirect_uris": [
"string"
],
"redirect_uris": [
"string"
],
"request_object_signing_alg": "string",
"request_uris": [
"string"
],
"response_types": [
"string"
],
"scope": "string",
"sector_identifier_uri": "string",
"subject_type": "string",
"token_endpoint_auth_method": "string",
"token_endpoint_auth_signing_alg": "string",
"tos_uri": "string",
"updated_at": "2020-06-23T09:16:53Z",
"userinfo_signed_response_alg": "string"
}

Parameters

ParameterInTypeRequiredDescription
idpathstringtruenone
bodybodyoAuth2Clienttruenone

Responses

Overview
StatusMeaningDescriptionSchema
200OKoAuth2ClientoAuth2Client
500Internal Server ErrorgenericErrorgenericError
Examples
200 response
{
"allowed_cors_origins": [
"string"
],
"audience": [
"string"
],
"backchannel_logout_session_required": true,
"backchannel_logout_uri": "string",
"client_id": "string",
"client_name": "string",
"client_secret": "string",
"client_secret_expires_at": 0,
"client_uri": "string",
"contacts": [
"string"
],
"created_at": "2020-06-23T09:16:53Z",
"frontchannel_logout_session_required": true,
"frontchannel_logout_uri": "string",
"grant_types": [
"string"
],
"jwks": {},
"jwks_uri": "string",
"logo_uri": "string",
"metadata": {},
"owner": "string",
"policy_uri": "string",
"post_logout_redirect_uris": [
"string"
],
"redirect_uris": [
"string"
],
"request_object_signing_alg": "string",
"request_uris": [
"string"
],
"response_types": [
"string"
],
"scope": "string",
"sector_identifier_uri": "string",
"subject_type": "string",
"token_endpoint_auth_method": "string",
"token_endpoint_auth_signing_alg": "string",
"tos_uri": "string",
"updated_at": "2020-06-23T09:16:53Z",
"userinfo_signed_response_alg": "string"
}

Code samples

curl -X PUT /clients/{id} \
-H 'Content-Type: application/json' \ -H 'Accept: application/json'

Deletes an OAuth 2.0 Client

DELETE /clients/{id} HTTP/1.1
Accept: application/json

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. To manage ORY Hydra, you will need an OAuth 2.0 Client as well. Make sure that this endpoint is well protected and only callable by first-party components.

Parameters

ParameterInTypeRequiredDescription
idpathstringtrueThe id of the OAuth 2.0 Client.

Responses

Overview
StatusMeaningDescriptionSchema
204No ContentEmpty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is
typically 201.None
404Not FoundgenericErrorgenericError
500Internal Server ErrorgenericErrorgenericError
Examples
404 response
{
"debug": "The database adapter was unable to find the element",
"error": "The requested resource could not be found",
"error_description": "Object with ID 12345 does not exist",
"status_code": 404
}

Code samples

curl -X DELETE /clients/{id} \
-H 'Accept: application/json'

Check alive status

GET /health/alive HTTP/1.1
Accept: application/json

This endpoint returns a 200 status code when the HTTP server is up running. This status does currently not include checks whether the database connection is working.

If the service supports TLS Edge Termination, this endpoint does not require the X-Forwarded-Proto header to be set.

Be aware that if you are running multiple nodes of this service, the health status will never refer to the cluster state, only to a single instance.

Responses

Overview
StatusMeaningDescriptionSchema
200OKhealthStatushealthStatus
500Internal Server ErrorgenericErrorgenericError
Examples
200 response
{
"status": "string"
}

Code samples

curl -X GET /health/alive \
-H 'Accept: application/json'

Retrieve a JSON Web Key Set

GET /keys/{set} HTTP/1.1
Accept: application/json

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

ParameterInTypeRequiredDescription
setpathstringtrueThe set

Responses

Overview
StatusMeaningDescriptionSchema
200OKJSONWebKeySetJSONWebKeySet
401UnauthorizedgenericErrorgenericError
403ForbiddengenericErrorgenericError
500Internal Server ErrorgenericErrorgenericError
Examples
200 response
{
"keys": [
{
"alg": "RS256",
"crv": "P-256",
"d": "T_N8I-6He3M8a7X1vWt6TGIx4xB_GP3Mb4SsZSA4v-orvJzzRiQhLlRR81naWYxfQAYt5isDI6_C2L9bdWo4FFPjGQFvNoRX-_sBJyBI_rl-TBgsZYoUlAj3J92WmY2inbA-PwyJfsaIIDceYBC-eX-xiCu6qMqkZi3MwQAFL6bMdPEM0z4JBcwFT3VdiWAIRUuACWQwrXMq672x7fMuaIaHi7XDGgt1ith23CLfaREmJku9PQcchbt_uEY-hqrFY6ntTtS4paWWQj86xLL94S-Tf6v6xkL918PfLSOTq6XCzxvlFwzBJqApnAhbwqLjpPhgUG04EDRrqrSBc5Y1BLevn6Ip5h1AhessBp3wLkQgz_roeckt-ybvzKTjESMuagnpqLvOT7Y9veIug2MwPJZI2VjczRc1vzMs25XrFQ8DpUy-bNdp89TmvAXwctUMiJdgHloJw23Cv03gIUAkDnsTqZmkpbIf-crpgNKFmQP_EDKoe8p_PXZZgfbRri3NoEVGP7Mk6yEu8LjJhClhZaBNjuWw2-KlBfOA3g79mhfBnkInee5KO9mGR50qPk1V-MorUYNTFMZIm0kFE6eYVWFBwJHLKYhHU34DoiK1VP-svZpC2uAMFNA_UJEwM9CQ2b8qe4-5e9aywMvwcuArRkAB5mBIfOaOJao3mfukKAE",
"dp": "G4sPXkc6Ya9y8oJW9_ILj4xuppu0lzi_H7VTkS8xj5SdX3coE0oimYwxIi2emTAue0UOa5dpgFGyBJ4c8tQ2VF402XRugKDTP8akYhFo5tAA77Qe_NmtuYZc3C3m3I24G2GvR5sSDxUyAN2zq8Lfn9EUms6rY3Ob8YeiKkTiBj0",
"dq": "s9lAH9fggBsoFR8Oac2R_E2gw282rT2kGOAhvIllETE1efrA6huUUvMfBcMpn8lqeW6vzznYY5SSQF7pMdC_agI3nG8Ibp1BUb0JUiraRNqUfLhcQb_d9GF4Dh7e74WbRsobRonujTYN1xCaP6TO61jvWrX-L18txXw494Q_cgk",
"e": "AQAB",
"k": "GawgguFyGrWKav7AX4VKUg",
"kid": "1603dfe0af8f4596",
"kty": "RSA",
"n": "vTqrxUyQPl_20aqf5kXHwDZrel-KovIp8s7ewJod2EXHl8tWlRB3_Rem34KwBfqlKQGp1nqah-51H4Jzruqe0cFP58hPEIt6WqrvnmJCXxnNuIB53iX_uUUXXHDHBeaPCSRoNJzNysjoJ30TIUsKBiirhBa7f235PXbKiHducLevV6PcKxJ5cY8zO286qJLBWSPm-OIevwqsIsSIH44Qtm9sioFikhkbLwoqwWORGAY0nl6XvVOlhADdLjBSqSAeT1FPuCDCnXwzCDR8N9IFB_IjdStFkC-rVt2K5BYfPd0c3yFp_vHR15eRd0zJ8XQ7woBC8Vnsac6Et1pKS59pX6256DPWu8UDdEOolKAPgcd_g2NpA76cAaF_jcT80j9KrEzw8Tv0nJBGesuCjPNjGs_KzdkWTUXt23Hn9QJsdc1MZuaW0iqXBepHYfYoqNelzVte117t4BwVp0kUM6we0IqyXClaZgOI8S-WDBw2_Ovdm8e5NmhYAblEVoygcX8Y46oH6bKiaCQfKCFDMcRgChme7AoE1yZZYsPbaG_3IjPrC4LBMHQw8rM9dWjJ8ImjicvZ1pAm0dx-KHCP3y5PVKrxBDf1zSOsBRkOSjB8TPODnJMz6-jd5hTtZxpZPwPoIdCanTZ3ZD6uRBpTmDwtpRGm63UQs1m5FWPwb0T2IF0",
"p": "6NbkXwDWUhi-eR55Cgbf27FkQDDWIamOaDr0rj1q0f1fFEz1W5A_09YvG09Fiv1AO2-D8Rl8gS1Vkz2i0zCSqnyy8A025XOcRviOMK7nIxE4OH_PEsko8dtIrb3TmE2hUXvCkmzw9EsTF1LQBOGC6iusLTXepIC1x9ukCKFZQvdgtEObQ5kzd9Nhq-cdqmSeMVLoxPLd1blviVT9Vm8-y12CtYpeJHOaIDtVPLlBhJiBoPKWg3vxSm4XxIliNOefqegIlsmTIa3MpS6WWlCK3yHhat0Q-rRxDxdyiVdG_wzJvp0Iw_2wms7pe-PgNPYvUWH9JphWP5K38YqEBiJFXQ",
"q": "0A1FmpOWR91_RAWpqreWSavNaZb9nXeKiBo0DQGBz32DbqKqQ8S4aBJmbRhJcctjCLjain-ivut477tAUMmzJwVJDDq2MZFwC9Q-4VYZmFU4HJityQuSzHYe64RjN-E_NQ02TWhG3QGW6roq6c57c99rrUsETwJJiwS8M5p15Miuz53DaOjv-uqqFAFfywN5WkxHbraBcjHtMiQuyQbQqkCFh-oanHkwYNeytsNhTu2mQmwR5DR2roZ2nPiFjC6nsdk-A7E3S3wMzYYFw7jvbWWoYWo9vB40_MY2Y0FYQSqcDzcBIcq_0tnnasf3VW4Fdx6m80RzOb2Fsnln7vKXAQ",
"qi": "GyM_p6JrXySiz1toFgKbWV-JdI3jQ4ypu9rbMWx3rQJBfmt0FoYzgUIZEVFEcOqwemRN81zoDAaa-Bk0KWNGDjJHZDdDmFhW3AN7lI-puxk_mHZGJ11rxyR8O55XLSe3SPmRfKwZI6yU24ZxvQKFYItdldUKGzO6Ia6zTKhAVRU",
"use": "sig",
"x": "f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU",
"x5c": [
"string"
],
"y": "x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0"
}
]
}

Code samples

curl -X GET /keys/{set} \
-H 'Accept: application/json'

Update a JSON Web Key Set

PUT /keys/{set} HTTP/1.1
Content-Type: application/json
Accept: application/json

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.

Request body

{
"keys": [
{
"alg": "RS256",
"crv": "P-256",
"d": "T_N8I-6He3M8a7X1vWt6TGIx4xB_GP3Mb4SsZSA4v-orvJzzRiQhLlRR81naWYxfQAYt5isDI6_C2L9bdWo4FFPjGQFvNoRX-_sBJyBI_rl-TBgsZYoUlAj3J92WmY2inbA-PwyJfsaIIDceYBC-eX-xiCu6qMqkZi3MwQAFL6bMdPEM0z4JBcwFT3VdiWAIRUuACWQwrXMq672x7fMuaIaHi7XDGgt1ith23CLfaREmJku9PQcchbt_uEY-hqrFY6ntTtS4paWWQj86xLL94S-Tf6v6xkL918PfLSOTq6XCzxvlFwzBJqApnAhbwqLjpPhgUG04EDRrqrSBc5Y1BLevn6Ip5h1AhessBp3wLkQgz_roeckt-ybvzKTjESMuagnpqLvOT7Y9veIug2MwPJZI2VjczRc1vzMs25XrFQ8DpUy-bNdp89TmvAXwctUMiJdgHloJw23Cv03gIUAkDnsTqZmkpbIf-crpgNKFmQP_EDKoe8p_PXZZgfbRri3NoEVGP7Mk6yEu8LjJhClhZaBNjuWw2-KlBfOA3g79mhfBnkInee5KO9mGR50qPk1V-MorUYNTFMZIm0kFE6eYVWFBwJHLKYhHU34DoiK1VP-svZpC2uAMFNA_UJEwM9CQ2b8qe4-5e9aywMvwcuArRkAB5mBIfOaOJao3mfukKAE",
"dp": "G4sPXkc6Ya9y8oJW9_ILj4xuppu0lzi_H7VTkS8xj5SdX3coE0oimYwxIi2emTAue0UOa5dpgFGyBJ4c8tQ2VF402XRugKDTP8akYhFo5tAA77Qe_NmtuYZc3C3m3I24G2GvR5sSDxUyAN2zq8Lfn9EUms6rY3Ob8YeiKkTiBj0",
"dq": "s9lAH9fggBsoFR8Oac2R_E2gw282rT2kGOAhvIllETE1efrA6huUUvMfBcMpn8lqeW6vzznYY5SSQF7pMdC_agI3nG8Ibp1BUb0JUiraRNqUfLhcQb_d9GF4Dh7e74WbRsobRonujTYN1xCaP6TO61jvWrX-L18txXw494Q_cgk",
"e": "AQAB",
"k": "GawgguFyGrWKav7AX4VKUg",
"kid": "1603dfe0af8f4596",
"kty": "RSA",
"n": "vTqrxUyQPl_20aqf5kXHwDZrel-KovIp8s7ewJod2EXHl8tWlRB3_Rem34KwBfqlKQGp1nqah-51H4Jzruqe0cFP58hPEIt6WqrvnmJCXxnNuIB53iX_uUUXXHDHBeaPCSRoNJzNysjoJ30TIUsKBiirhBa7f235PXbKiHducLevV6PcKxJ5cY8zO286qJLBWSPm-OIevwqsIsSIH44Qtm9sioFikhkbLwoqwWORGAY0nl6XvVOlhADdLjBSqSAeT1FPuCDCnXwzCDR8N9IFB_IjdStFkC-rVt2K5BYfPd0c3yFp_vHR15eRd0zJ8XQ7woBC8Vnsac6Et1pKS59pX6256DPWu8UDdEOolKAPgcd_g2NpA76cAaF_jcT80j9KrEzw8Tv0nJBGesuCjPNjGs_KzdkWTUXt23Hn9QJsdc1MZuaW0iqXBepHYfYoqNelzVte117t4BwVp0kUM6we0IqyXClaZgOI8S-WDBw2_Ovdm8e5NmhYAblEVoygcX8Y46oH6bKiaCQfKCFDMcRgChme7AoE1yZZYsPbaG_3IjPrC4LBMHQw8rM9dWjJ8ImjicvZ1pAm0dx-KHCP3y5PVKrxBDf1zSOsBRkOSjB8TPODnJMz6-jd5hTtZxpZPwPoIdCanTZ3ZD6uRBpTmDwtpRGm63UQs1m5FWPwb0T2IF0",
"p": "6NbkXwDWUhi-eR55Cgbf27FkQDDWIamOaDr0rj1q0f1fFEz1W5A_09YvG09Fiv1AO2-D8Rl8gS1Vkz2i0zCSqnyy8A025XOcRviOMK7nIxE4OH_PEsko8dtIrb3TmE2hUXvCkmzw9EsTF1LQBOGC6iusLTXepIC1x9ukCKFZQvdgtEObQ5kzd9Nhq-cdqmSeMVLoxPLd1blviVT9Vm8-y12CtYpeJHOaIDtVPLlBhJiBoPKWg3vxSm4XxIliNOefqegIlsmTIa3MpS6WWlCK3yHhat0Q-rRxDxdyiVdG_wzJvp0Iw_2wms7pe-PgNPYvUWH9JphWP5K38YqEBiJFXQ",
"q": "0A1FmpOWR91_RAWpqreWSavNaZb9nXeKiBo0DQGBz32DbqKqQ8S4aBJmbRhJcctjCLjain-ivut477tAUMmzJwVJDDq2MZFwC9Q-4VYZmFU4HJityQuSzHYe64RjN-E_NQ02TWhG3QGW6roq6c57c99rrUsETwJJiwS8M5p15Miuz53DaOjv-uqqFAFfywN5WkxHbraBcjHtMiQuyQbQqkCFh-oanHkwYNeytsNhTu2mQmwR5DR2roZ2nPiFjC6nsdk-A7E3S3wMzYYFw7jvbWWoYWo9vB40_MY2Y0FYQSqcDzcBIcq_0tnnasf3VW4Fdx6m80RzOb2Fsnln7vKXAQ",
"qi": "GyM_p6JrXySiz1toFgKbWV-JdI3jQ4ypu9rbMWx3rQJBfmt0FoYzgUIZEVFEcOqwemRN81zoDAaa-Bk0KWNGDjJHZDdDmFhW3AN7lI-puxk_mHZGJ11rxyR8O55XLSe3SPmRfKwZI6yU24ZxvQKFYItdldUKGzO6Ia6zTKhAVRU",
"use": "sig",
"x": "f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU",
"x5c": [
"string"
],
"y": "x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0"
}
]
}

Parameters

ParameterInTypeRequiredDescription
setpathstringtrueThe set
bodybodyJSONWebKeySetfalsenone

Responses

Overview
StatusMeaningDescriptionSchema
200OKJSONWebKeySetJSONWebKeySet
401UnauthorizedgenericErrorgenericError
403ForbiddengenericErrorgenericError
500Internal Server ErrorgenericErrorgenericError
Examples
200 response
{
"keys": [
{
"alg": "RS256",
"crv": "P-256",
"d": "T_N8I-6He3M8a7X1vWt6TGIx4xB_GP3Mb4SsZSA4v-orvJzzRiQhLlRR81naWYxfQAYt5isDI6_C2L9bdWo4FFPjGQFvNoRX-_sBJyBI_rl-TBgsZYoUlAj3J92WmY2inbA-PwyJfsaIIDceYBC-eX-xiCu6qMqkZi3MwQAFL6bMdPEM0z4JBcwFT3VdiWAIRUuACWQwrXMq672x7fMuaIaHi7XDGgt1ith23CLfaREmJku9PQcchbt_uEY-hqrFY6ntTtS4paWWQj86xLL94S-Tf6v6xkL918PfLSOTq6XCzxvlFwzBJqApnAhbwqLjpPhgUG04EDRrqrSBc5Y1BLevn6Ip5h1AhessBp3wLkQgz_roeckt-ybvzKTjESMuagnpqLvOT7Y9veIug2MwPJZI2VjczRc1vzMs25XrFQ8DpUy-bNdp89TmvAXwctUMiJdgHloJw23Cv03gIUAkDnsTqZmkpbIf-crpgNKFmQP_EDKoe8p_PXZZgfbRri3NoEVGP7Mk6yEu8LjJhClhZaBNjuWw2-KlBfOA3g79mhfBnkInee5KO9mGR50qPk1V-MorUYNTFMZIm0kFE6eYVWFBwJHLKYhHU34DoiK1VP-svZpC2uAMFNA_UJEwM9CQ2b8qe4-5e9aywMvwcuArRkAB5mBIfOaOJao3mfukKAE",
"dp": "G4sPXkc6Ya9y8oJW9_ILj4xuppu0lzi_H7VTkS8xj5SdX3coE0oimYwxIi2emTAue0UOa5dpgFGyBJ4c8tQ2VF402XRugKDTP8akYhFo5tAA77Qe_NmtuYZc3C3m3I24G2GvR5sSDxUyAN2zq8Lfn9EUms6rY3Ob8YeiKkTiBj0",
"dq": "s9lAH9fggBsoFR8Oac2R_E2gw282rT2kGOAhvIllETE1efrA6huUUvMfBcMpn8lqeW6vzznYY5SSQF7pMdC_agI3nG8Ibp1BUb0JUiraRNqUfLhcQb_d9GF4Dh7e74WbRsobRonujTYN1xCaP6TO61jvWrX-L18txXw494Q_cgk",
"e": "AQAB",
"k": "GawgguFyGrWKav7AX4VKUg",
"kid": "1603dfe0af8f4596",
"kty": "RSA",
"n": "vTqrxUyQPl_20aqf5kXHwDZrel-KovIp8s7ewJod2EXHl8tWlRB3_Rem34KwBfqlKQGp1nqah-51H4Jzruqe0cFP58hPEIt6WqrvnmJCXxnNuIB53iX_uUUXXHDHBeaPCSRoNJzNysjoJ30TIUsKBiirhBa7f235PXbKiHducLevV6PcKxJ5cY8zO286qJLBWSPm-OIevwqsIsSIH44Qtm9sioFikhkbLwoqwWORGAY0nl6XvVOlhADdLjBSqSAeT1FPuCDCnXwzCDR8N9IFB_IjdStFkC-rVt2K5BYfPd0c3yFp_vHR15eRd0zJ8XQ7woBC8Vnsac6Et1pKS59pX6256DPWu8UDdEOolKAPgcd_g2NpA76cAaF_jcT80j9KrEzw8Tv0nJBGesuCjPNjGs_KzdkWTUXt23Hn9QJsdc1MZuaW0iqXBepHYfYoqNelzVte117t4BwVp0kUM6we0IqyXClaZgOI8S-WDBw2_Ovdm8e5NmhYAblEVoygcX8Y46oH6bKiaCQfKCFDMcRgChme7AoE1yZZYsPbaG_3IjPrC4LBMHQw8rM9dWjJ8ImjicvZ1pAm0dx-KHCP3y5PVKrxBDf1zSOsBRkOSjB8TPODnJMz6-jd5hTtZxpZPwPoIdCanTZ3ZD6uRBpTmDwtpRGm63UQs1m5FWPwb0T2IF0",
"p": "6NbkXwDWUhi-eR55Cgbf27FkQDDWIamOaDr0rj1q0f1fFEz1W5A_09YvG09Fiv1AO2-D8Rl8gS1Vkz2i0zCSqnyy8A025XOcRviOMK7nIxE4OH_PEsko8dtIrb3TmE2hUXvCkmzw9EsTF1LQBOGC6iusLTXepIC1x9ukCKFZQvdgtEObQ5kzd9Nhq-cdqmSeMVLoxPLd1blviVT9Vm8-y12CtYpeJHOaIDtVPLlBhJiBoPKWg3vxSm4XxIliNOefqegIlsmTIa3MpS6WWlCK3yHhat0Q-rRxDxdyiVdG_wzJvp0Iw_2wms7pe-PgNPYvUWH9JphWP5K38YqEBiJFXQ",
"q": "0A1FmpOWR91_RAWpqreWSavNaZb9nXeKiBo0DQGBz32DbqKqQ8S4aBJmbRhJcctjCLjain-ivut477tAUMmzJwVJDDq2MZFwC9Q-4VYZmFU4HJityQuSzHYe64RjN-E_NQ02TWhG3QGW6roq6c57c99rrUsETwJJiwS8M5p15Miuz53DaOjv-uqqFAFfywN5WkxHbraBcjHtMiQuyQbQqkCFh-oanHkwYNeytsNhTu2mQmwR5DR2roZ2nPiFjC6nsdk-A7E3S3wMzYYFw7jvbWWoYWo9vB40_MY2Y0FYQSqcDzcBIcq_0tnnasf3VW4Fdx6m80RzOb2Fsnln7vKXAQ",
"qi": "GyM_p6JrXySiz1toFgKbWV-JdI3jQ4ypu9rbMWx3rQJBfmt0FoYzgUIZEVFEcOqwemRN81zoDAaa-Bk0KWNGDjJHZDdDmFhW3AN7lI-puxk_mHZGJ11rxyR8O55XLSe3SPmRfKwZI6yU24ZxvQKFYItdldUKGzO6Ia6zTKhAVRU",
"use": "sig",
"x": "f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU",
"x5c": [
"string"
],
"y": "x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0"
}
]
}

Code samples

curl -X PUT /keys/{set} \
-H 'Content-Type: application/json' \ -H 'Accept: application/json'

Generate a new JSON Web Key

POST /keys/{set} HTTP/1.1
Content-Type: application/json
Accept: application/json

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.

Request body

{
"alg": "string",
"kid": "string",
"use": "string"
}

Parameters

ParameterInTypeRequiredDescription
setpathstringtrueThe set
bodybodyjsonWebKeySetGeneratorRequestfalsenone

Responses

Overview
StatusMeaningDescriptionSchema
201CreatedJSONWebKeySetJSONWebKeySet
401UnauthorizedgenericErrorgenericError
403ForbiddengenericErrorgenericError
500Internal Server ErrorgenericErrorgenericError
Examples
201 response
{
"keys": [
{
"alg": "RS256",
"crv": "P-256",
"d": "T_N8I-6He3M8a7X1vWt6TGIx4xB_GP3Mb4SsZSA4v-orvJzzRiQhLlRR81naWYxfQAYt5isDI6_C2L9bdWo4FFPjGQFvNoRX-_sBJyBI_rl-TBgsZYoUlAj3J92WmY2inbA-PwyJfsaIIDceYBC-eX-xiCu6qMqkZi3MwQAFL6bMdPEM0z4JBcwFT3VdiWAIRUuACWQwrXMq672x7fMuaIaHi7XDGgt1ith23CLfaREmJku9PQcchbt_uEY-hqrFY6ntTtS4paWWQj86xLL94S-Tf6v6xkL918PfLSOTq6XCzxvlFwzBJqApnAhbwqLjpPhgUG04EDRrqrSBc5Y1BLevn6Ip5h1AhessBp3wLkQgz_roeckt-ybvzKTjESMuagnpqLvOT7Y9veIug2MwPJZI2VjczRc1vzMs25XrFQ8DpUy-bNdp89TmvAXwctUMiJdgHloJw23Cv03gIUAkDnsTqZmkpbIf-crpgNKFmQP_EDKoe8p_PXZZgfbRri3NoEVGP7Mk6yEu8LjJhClhZaBNjuWw2-KlBfOA3g79mhfBnkInee5KO9mGR50qPk1V-MorUYNTFMZIm0kFE6eYVWFBwJHLKYhHU34DoiK1VP-svZpC2uAMFNA_UJEwM9CQ2b8qe4-5e9aywMvwcuArRkAB5mBIfOaOJao3mfukKAE",
"dp": "G4sPXkc6Ya9y8oJW9_ILj4xuppu0lzi_H7VTkS8xj5SdX3coE0oimYwxIi2emTAue0UOa5dpgFGyBJ4c8tQ2VF402XRugKDTP8akYhFo5tAA77Qe_NmtuYZc3C3m3I24G2GvR5sSDxUyAN2zq8Lfn9EUms6rY3Ob8YeiKkTiBj0",
"dq": "s9lAH9fggBsoFR8Oac2R_E2gw282rT2kGOAhvIllETE1efrA6huUUvMfBcMpn8lqeW6vzznYY5SSQF7pMdC_agI3nG8Ibp1BUb0JUiraRNqUfLhcQb_d9GF4Dh7e74WbRsobRonujTYN1xCaP6TO61jvWrX-L18txXw494Q_cgk",
"e": "AQAB",
"k": "GawgguFyGrWKav7AX4VKUg",
"kid": "1603dfe0af8f4596",
"kty": "RSA",
"n": "vTqrxUyQPl_20aqf5kXHwDZrel-KovIp8s7ewJod2EXHl8tWlRB3_Rem34KwBfqlKQGp1nqah-51H4Jzruqe0cFP58hPEIt6WqrvnmJCXxnNuIB53iX_uUUXXHDHBeaPCSRoNJzNysjoJ30TIUsKBiirhBa7f235PXbKiHducLevV6PcKxJ5cY8zO286qJLBWSPm-OIevwqsIsSIH44Qtm9sioFikhkbLwoqwWORGAY0nl6XvVOlhADdLjBSqSAeT1FPuCDCnXwzCDR8N9IFB_IjdStFkC-rVt2K5BYfPd0c3yFp_vHR15eRd0zJ8XQ7woBC8Vnsac6Et1pKS59pX6256DPWu8UDdEOolKAPgcd_g2NpA76cAaF_jcT80j9KrEzw8Tv0nJBGesuCjPNjGs_KzdkWTUXt23Hn9QJsdc1MZuaW0iqXBepHYfYoqNelzVte117t4BwVp0kUM6we0IqyXClaZgOI8S-WDBw2_Ovdm8e5NmhYAblEVoygcX8Y46oH6bKiaCQfKCFDMcRgChme7AoE1yZZYsPbaG_3IjPrC4LBMHQw8rM9dWjJ8ImjicvZ1pAm0dx-KHCP3y5PVKrxBDf1zSOsBRkOSjB8TPODnJMz6-jd5hTtZxpZPwPoIdCanTZ3ZD6uRBpTmDwtpRGm63UQs1m5FWPwb0T2IF0",
"p": "6NbkXwDWUhi-eR55Cgbf27FkQDDWIamOaDr0rj1q0f1fFEz1W5A_09YvG09Fiv1AO2-D8Rl8gS1Vkz2i0zCSqnyy8A025XOcRviOMK7nIxE4OH_PEsko8dtIrb3TmE2hUXvCkmzw9EsTF1LQBOGC6iusLTXepIC1x9ukCKFZQvdgtEObQ5kzd9Nhq-cdqmSeMVLoxPLd1blviVT9Vm8-y12CtYpeJHOaIDtVPLlBhJiBoPKWg3vxSm4XxIliNOefqegIlsmTIa3MpS6WWlCK3yHhat0Q-rRxDxdyiVdG_wzJvp0Iw_2wms7pe-PgNPYvUWH9JphWP5K38YqEBiJFXQ",
"q": "0A1FmpOWR91_RAWpqreWSavNaZb9nXeKiBo0DQGBz32DbqKqQ8S4aBJmbRhJcctjCLjain-ivut477tAUMmzJwVJDDq2MZFwC9Q-4VYZmFU4HJityQuSzHYe64RjN-E_NQ02TWhG3QGW6roq6c57c99rrUsETwJJiwS8M5p15Miuz53DaOjv-uqqFAFfywN5WkxHbraBcjHtMiQuyQbQqkCFh-oanHkwYNeytsNhTu2mQmwR5DR2roZ2nPiFjC6nsdk-A7E3S3wMzYYFw7jvbWWoYWo9vB40_MY2Y0FYQSqcDzcBIcq_0tnnasf3VW4Fdx6m80RzOb2Fsnln7vKXAQ",
"qi": "GyM_p6JrXySiz1toFgKbWV-JdI3jQ4ypu9rbMWx3rQJBfmt0FoYzgUIZEVFEcOqwemRN81zoDAaa-Bk0KWNGDjJHZDdDmFhW3AN7lI-puxk_mHZGJ11rxyR8O55XLSe3SPmRfKwZI6yU24ZxvQKFYItdldUKGzO6Ia6zTKhAVRU",
"use": "sig",
"x": "f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU",
"x5c": [
"string"
],
"y": "x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0"
}
]
}

Code samples

curl -X POST /keys/{set} \
-H 'Content-Type: application/json' \ -H 'Accept: application/json'

Delete a JSON Web Key Set

DELETE /keys/{set} HTTP/1.1
Accept: application/json

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

ParameterInTypeRequiredDescription
setpathstringtrueThe set

Responses

Overview
StatusMeaningDescriptionSchema
204No ContentEmpty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is
typically 201.None
401UnauthorizedgenericErrorgenericError
403ForbiddengenericErrorgenericError
500Internal Server ErrorgenericErrorgenericError
Examples
401 response
{
"debug": "The database adapter was unable to find the element",
"error": "The requested resource could not be found",
"error_description": "Object with ID 12345 does not exist",
"status_code": 404
}

Code samples

curl -X DELETE /keys/{set} \
-H 'Accept: application/json'

Fetch a JSON Web Key

GET /keys/{set}/{kid} HTTP/1.1
Accept: application/json

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

Parameters

ParameterInTypeRequiredDescription
kidpathstringtrueThe kid of the desired key
setpathstringtrueThe set

Responses

Overview
StatusMeaningDescriptionSchema
200OKJSONWebKeySetJSONWebKeySet
404Not FoundgenericErrorgenericError
500Internal Server ErrorgenericErrorgenericError
Examples
200 response
{
"keys": [
{
"alg": "RS256",
"crv": "P-256",
"d": "T_N8I-6He3M8a7X1vWt6TGIx4xB_GP3Mb4SsZSA4v-orvJzzRiQhLlRR81naWYxfQAYt5isDI6_C2L9bdWo4FFPjGQFvNoRX-_sBJyBI_rl-TBgsZYoUlAj3J92WmY2inbA-PwyJfsaIIDceYBC-eX-xiCu6qMqkZi3MwQAFL6bMdPEM0z4JBcwFT3VdiWAIRUuACWQwrXMq672x7fMuaIaHi7XDGgt1ith23CLfaREmJku9PQcchbt_uEY-hqrFY6ntTtS4paWWQj86xLL94S-Tf6v6xkL918PfLSOTq6XCzxvlFwzBJqApnAhbwqLjpPhgUG04EDRrqrSBc5Y1BLevn6Ip5h1AhessBp3wLkQgz_roeckt-ybvzKTjESMuagnpqLvOT7Y9veIug2MwPJZI2VjczRc1vzMs25XrFQ8DpUy-bNdp89TmvAXwctUMiJdgHloJw23Cv03gIUAkDnsTqZmkpbIf-crpgNKFmQP_EDKoe8p_PXZZgfbRri3NoEVGP7Mk6yEu8LjJhClhZaBNjuWw2-KlBfOA3g79mhfBnkInee5KO9mGR50qPk1V-MorUYNTFMZIm0kFE6eYVWFBwJHLKYhHU34DoiK1VP-svZpC2uAMFNA_UJEwM9CQ2b8qe4-5e9aywMvwcuArRkAB5mBIfOaOJao3mfukKAE",
"dp": "G4sPXkc6Ya9y8oJW9_ILj4xuppu0lzi_H7VTkS8xj5SdX3coE0oimYwxIi2emTAue0UOa5dpgFGyBJ4c8tQ2VF402XRugKDTP8akYhFo5tAA77Qe_NmtuYZc3C3m3I24G2GvR5sSDxUyAN2zq8Lfn9EUms6rY3Ob8YeiKkTiBj0",
"dq": "s9lAH9fggBsoFR8Oac2R_E2gw282rT2kGOAhvIllETE1efrA6huUUvMfBcMpn8lqeW6vzznYY5SSQF7pMdC_agI3nG8Ibp1BUb0JUiraRNqUfLhcQb_d9GF4Dh7e74WbRsobRonujTYN1xCaP6TO61jvWrX-L18txXw494Q_cgk",
"e": "AQAB",
"k": "GawgguFyGrWKav7AX4VKUg",
"kid": "1603dfe0af8f4596",
"kty": "RSA",
"n": "vTqrxUyQPl_20aqf5kXHwDZrel-KovIp8s7ewJod2EXHl8tWlRB3_Rem34KwBfqlKQGp1nqah-51H4Jzruqe0cFP58hPEIt6WqrvnmJCXxnNuIB53iX_uUUXXHDHBeaPCSRoNJzNysjoJ30TIUsKBiirhBa7f235PXbKiHducLevV6PcKxJ5cY8zO286qJLBWSPm-OIevwqsIsSIH44Qtm9sioFikhkbLwoqwWORGAY0nl6XvVOlhADdLjBSqSAeT1FPuCDCnXwzCDR8N9IFB_IjdStFkC-rVt2K5BYfPd0c3yFp_vHR15eRd0zJ8XQ7woBC8Vnsac6Et1pKS59pX6256DPWu8UDdEOolKAPgcd_g2NpA76cAaF_jcT80j9KrEzw8Tv0nJBGesuCjPNjGs_KzdkWTUXt23Hn9QJsdc1MZuaW0iqXBepHYfYoqNelzVte117t4BwVp0kUM6we0IqyXClaZgOI8S-WDBw2_Ovdm8e5NmhYAblEVoygcX8Y46oH6bKiaCQfKCFDMcRgChme7AoE1yZZYsPbaG_3IjPrC4LBMHQw8rM9dWjJ8ImjicvZ1pAm0dx-KHCP3y5PVKrxBDf1zSOsBRkOSjB8TPODnJMz6-jd5hTtZxpZPwPoIdCanTZ3ZD6uRBpTmDwtpRGm63UQs1m5FWPwb0T2IF0",
"p": "6NbkXwDWUhi-eR55Cgbf27FkQDDWIamOaDr0rj1q0f1fFEz1W5A_09YvG09Fiv1AO2-D8Rl8gS1Vkz2i0zCSqnyy8A025XOcRviOMK7nIxE4OH_PEsko8dtIrb3TmE2hUXvCkmzw9EsTF1LQBOGC6iusLTXepIC1x9ukCKFZQvdgtEObQ5kzd9Nhq-cdqmSeMVLoxPLd1blviVT9Vm8-y12CtYpeJHOaIDtVPLlBhJiBoPKWg3vxSm4XxIliNOefqegIlsmTIa3MpS6WWlCK3yHhat0Q-rRxDxdyiVdG_wzJvp0Iw_2wms7pe-PgNPYvUWH9JphWP5K38YqEBiJFXQ",
"q": "0A1FmpOWR91_RAWpqreWSavNaZb9nXeKiBo0DQGBz32DbqKqQ8S4aBJmbRhJcctjCLjain-ivut477tAUMmzJwVJDDq2MZFwC9Q-4VYZmFU4HJityQuSzHYe64RjN-E_NQ02TWhG3QGW6roq6c57c99rrUsETwJJiwS8M5p15Miuz53DaOjv-uqqFAFfywN5WkxHbraBcjHtMiQuyQbQqkCFh-oanHkwYNeytsNhTu2mQmwR5DR2roZ2nPiFjC6nsdk-A7E3S3wMzYYFw7jvbWWoYWo9vB40_MY2Y0FYQSqcDzcBIcq_0tnnasf3VW4Fdx6m80RzOb2Fsnln7vKXAQ",
"qi": "GyM_p6JrXySiz1toFgKbWV-JdI3jQ4ypu9rbMWx3rQJBfmt0FoYzgUIZEVFEcOqwemRN81zoDAaa-Bk0KWNGDjJHZDdDmFhW3AN7lI-puxk_mHZGJ11rxyR8O55XLSe3SPmRfKwZI6yU24ZxvQKFYItdldUKGzO6Ia6zTKhAVRU",
"use": "sig",
"x": "f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU",
"x5c": [
"string"
],
"y": "x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0"
}
]
}

Code samples

curl -X GET /keys/{set}/{kid} \
-H 'Accept: application/json'

Update a JSON Web Key

PUT /keys/{set}/{kid} HTTP/1.1
Content-Type: application/json
Accept: application/json

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.

Request body

{
"alg": "RS256",
"crv": "P-256",
"d": "T_N8I-6He3M8a7X1vWt6TGIx4xB_GP3Mb4SsZSA4v-orvJzzRiQhLlRR81naWYxfQAYt5isDI6_C2L9bdWo4FFPjGQFvNoRX-_sBJyBI_rl-TBgsZYoUlAj3J92WmY2inbA-PwyJfsaIIDceYBC-eX-xiCu6qMqkZi3MwQAFL6bMdPEM0z4JBcwFT3VdiWAIRUuACWQwrXMq672x7fMuaIaHi7XDGgt1ith23CLfaREmJku9PQcchbt_uEY-hqrFY6ntTtS4paWWQj86xLL94S-Tf6v6xkL918PfLSOTq6XCzxvlFwzBJqApnAhbwqLjpPhgUG04EDRrqrSBc5Y1BLevn6Ip5h1AhessBp3wLkQgz_roeckt-ybvzKTjESMuagnpqLvOT7Y9veIug2MwPJZI2VjczRc1vzMs25XrFQ8DpUy-bNdp89TmvAXwctUMiJdgHloJw23Cv03gIUAkDnsTqZmkpbIf-crpgNKFmQP_EDKoe8p_PXZZgfbRri3NoEVGP7Mk6yEu8LjJhClhZaBNjuWw2-KlBfOA3g79mhfBnkInee5KO9mGR50qPk1V-MorUYNTFMZIm0kFE6eYVWFBwJHLKYhHU34DoiK1VP-svZpC2uAMFNA_UJEwM9CQ2b8qe4-5e9aywMvwcuArRkAB5mBIfOaOJao3mfukKAE",
"dp": "G4sPXkc6Ya9y8oJW9_ILj4xuppu0lzi_H7VTkS8xj5SdX3coE0oimYwxIi2emTAue0UOa5dpgFGyBJ4c8tQ2VF402XRugKDTP8akYhFo5tAA77Qe_NmtuYZc3C3m3I24G2GvR5sSDxUyAN2zq8Lfn9EUms6rY3Ob8YeiKkTiBj0",
"dq": "s9lAH9fggBsoFR8Oac2R_E2gw282rT2kGOAhvIllETE1efrA6huUUvMfBcMpn8lqeW6vzznYY5SSQF7pMdC_agI3nG8Ibp1BUb0JUiraRNqUfLhcQb_d9GF4Dh7e74WbRsobRonujTYN1xCaP6TO61jvWrX-L18txXw494Q_cgk",
"e": "AQAB",
"k": "GawgguFyGrWKav7AX4VKUg",
"kid": "1603dfe0af8f4596",
"kty": "RSA",
"n": "vTqrxUyQPl_20aqf5kXHwDZrel-KovIp8s7ewJod2EXHl8tWlRB3_Rem34KwBfqlKQGp1nqah-51H4Jzruqe0cFP58hPEIt6WqrvnmJCXxnNuIB53iX_uUUXXHDHBeaPCSRoNJzNysjoJ30TIUsKBiirhBa7f235PXbKiHducLevV6PcKxJ5cY8zO286qJLBWSPm-OIevwqsIsSIH44Qtm9sioFikhkbLwoqwWORGAY0nl6XvVOlhADdLjBSqSAeT1FPuCDCnXwzCDR8N9IFB_IjdStFkC-rVt2K5BYfPd0c3yFp_vHR15eRd0zJ8XQ7woBC8Vnsac6Et1pKS59pX6256DPWu8UDdEOolKAPgcd_g2NpA76cAaF_jcT80j9KrEzw8Tv0nJBGesuCjPNjGs_KzdkWTUXt23Hn9QJsdc1MZuaW0iqXBepHYfYoqNelzVte117t4BwVp0kUM6we0IqyXClaZgOI8S-WDBw2_Ovdm8e5NmhYAblEVoygcX8Y46oH6bKiaCQfKCFDMcRgChme7AoE1yZZYsPbaG_3IjPrC4LBMHQw8rM9dWjJ8ImjicvZ1pAm0dx-KHCP3y5PVKrxBDf1zSOsBRkOSjB8TPODnJMz6-jd5hTtZxpZPwPoIdCanTZ3ZD6uRBpTmDwtpRGm63UQs1m5FWPwb0T2IF0",
"p": "6NbkXwDWUhi-eR55Cgbf27FkQDDWIamOaDr0rj1q0f1fFEz1W5A_09YvG09Fiv1AO2-D8Rl8gS1Vkz2i0zCSqnyy8A025XOcRviOMK7nIxE4OH_PEsko8dtIrb3TmE2hUXvCkmzw9EsTF1LQBOGC6iusLTXepIC1x9ukCKFZQvdgtEObQ5kzd9Nhq-cdqmSeMVLoxPLd1blviVT9Vm8-y12CtYpeJHOaIDtVPLlBhJiBoPKWg3vxSm4XxIliNOefqegIlsmTIa3MpS6WWlCK3yHhat0Q-rRxDxdyiVdG_wzJvp0Iw_2wms7pe-PgNPYvUWH9JphWP5K38YqEBiJFXQ",
"q": "0A1FmpOWR91_RAWpqreWSavNaZb9nXeKiBo0DQGBz32DbqKqQ8S4aBJmbRhJcctjCLjain-ivut477tAUMmzJwVJDDq2MZFwC9Q-4VYZmFU4HJityQuSzHYe64RjN-E_NQ02TWhG3QGW6roq6c57c99rrUsETwJJiwS8M5p15Miuz53DaOjv-uqqFAFfywN5WkxHbraBcjHtMiQuyQbQqkCFh-oanHkwYNeytsNhTu2mQmwR5DR2roZ2nPiFjC6nsdk-A7E3S3wMzYYFw7jvbWWoYWo9vB40_MY2Y0FYQSqcDzcBIcq_0tnnasf3VW4Fdx6m80RzOb2Fsnln7vKXAQ",
"qi": "GyM_p6JrXySiz1toFgKbWV-JdI3jQ4ypu9rbMWx3rQJBfmt0FoYzgUIZEVFEcOqwemRN81zoDAaa-Bk0KWNGDjJHZDdDmFhW3AN7lI-puxk_mHZGJ11rxyR8O55XLSe3SPmRfKwZI6yU24ZxvQKFYItdldUKGzO6Ia6zTKhAVRU",
"use": "sig",
"x": "f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU",
"x5c": [
"string"
],
"y": "x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0"
}

Parameters

ParameterInTypeRequiredDescription
kidpathstringtrueThe kid of the desired key
setpathstringtrueThe set
bodybodyJSONWebKeyfalsenone

Responses

Overview
StatusMeaningDescriptionSchema
200OKJSONWebKeyJSONWebKey
401UnauthorizedgenericErrorgenericError
403ForbiddengenericErrorgenericError
500Internal Server ErrorgenericErrorgenericError
Examples
200 response
{
"alg": "RS256",
"crv": "P-256",
"d": "T_N8I-6He3M8a7X1vWt6TGIx4xB_GP3Mb4SsZSA4v-orvJzzRiQhLlRR81naWYxfQAYt5isDI6_C2L9bdWo4FFPjGQFvNoRX-_sBJyBI_rl-TBgsZYoUlAj3J92WmY2inbA-PwyJfsaIIDceYBC-eX-xiCu6qMqkZi3MwQAFL6bMdPEM0z4JBcwFT3VdiWAIRUuACWQwrXMq672x7fMuaIaHi7XDGgt1ith23CLfaREmJku9PQcchbt_uEY-hqrFY6ntTtS4paWWQj86xLL94S-Tf6v6xkL918PfLSOTq6XCzxvlFwzBJqApnAhbwqLjpPhgUG04EDRrqrSBc5Y1BLevn6Ip5h1AhessBp3wLkQgz_roeckt-ybvzKTjESMuagnpqLvOT7Y9veIug2MwPJZI2VjczRc1vzMs25XrFQ8DpUy-bNdp89TmvAXwctUMiJdgHloJw23Cv03gIUAkDnsTqZmkpbIf-crpgNKFmQP_EDKoe8p_PXZZgfbRri3NoEVGP7Mk6yEu8LjJhClhZaBNjuWw2-KlBfOA3g79mhfBnkInee5KO9mGR50qPk1V-MorUYNTFMZIm0kFE6eYVWFBwJHLKYhHU34DoiK1VP-svZpC2uAMFNA_UJEwM9CQ2b8qe4-5e9aywMvwcuArRkAB5mBIfOaOJao3mfukKAE",
"dp": "G4sPXkc6Ya9y8oJW9_ILj4xuppu0lzi_H7VTkS8xj5SdX3coE0oimYwxIi2emTAue0UOa5dpgFGyBJ4c8tQ2VF402XRugKDTP8akYhFo5tAA77Qe_NmtuYZc3C3m3I24G2GvR5sSDxUyAN2zq8Lfn9EUms6rY3Ob8YeiKkTiBj0",
"dq": "s9lAH9fggBsoFR8Oac2R_E2gw282rT2kGOAhvIllETE1efrA6huUUvMfBcMpn8lqeW6vzznYY5SSQF7pMdC_agI3nG8Ibp1BUb0JUiraRNqUfLhcQb_d9GF4Dh7e74WbRsobRonujTYN1xCaP6TO61jvWrX-L18txXw494Q_cgk",
"e": "AQAB",
"k": "GawgguFyGrWKav7AX4VKUg",
"kid": "1603dfe0af8f4596",
"kty": "RSA",
"n": "vTqrxUyQPl_20aqf5kXHwDZrel-KovIp8s7ewJod2EXHl8tWlRB3_Rem34KwBfqlKQGp1nqah-51H4Jzruqe0cFP58hPEIt6WqrvnmJCXxnNuIB53iX_uUUXXHDHBeaPCSRoNJzNysjoJ30TIUsKBiirhBa7f235PXbKiHducLevV6PcKxJ5cY8zO286qJLBWSPm-OIevwqsIsSIH44Qtm9sioFikhkbLwoqwWORGAY0nl6XvVOlhADdLjBSqSAeT1FPuCDCnXwzCDR8N9IFB_IjdStFkC-rVt2K5BYfPd0c3yFp_vHR15eRd0zJ8XQ7woBC8Vnsac6Et1pKS59pX6256DPWu8UDdEOolKAPgcd_g2NpA76cAaF_jcT80j9KrEzw8Tv0nJBGesuCjPNjGs_KzdkWTUXt23Hn9QJsdc1MZuaW0iqXBepHYfYoqNelzVte117t4BwVp0kUM6we0IqyXClaZgOI8S-WDBw2_Ovdm8e5NmhYAblEVoygcX8Y46oH6bKiaCQfKCFDMcRgChme7AoE1yZZYsPbaG_3IjPrC4LBMHQw8rM9dWjJ8ImjicvZ1pAm0dx-KHCP3y5PVKrxBDf1zSOsBRkOSjB8TPODnJMz6-jd5hTtZxpZPwPoIdCanTZ3ZD6uRBpTmDwtpRGm63UQs1m5FWPwb0T2IF0",
"p": "6NbkXwDWUhi-eR55Cgbf27FkQDDWIamOaDr0rj1q0f1fFEz1W5A_09YvG09Fiv1AO2-D8Rl8gS1Vkz2i0zCSqnyy8A025XOcRviOMK7nIxE4OH_PEsko8dtIrb3TmE2hUXvCkmzw9EsTF1LQBOGC6iusLTXepIC1x9ukCKFZQvdgtEObQ5kzd9Nhq-cdqmSeMVLoxPLd1blviVT9Vm8-y12CtYpeJHOaIDtVPLlBhJiBoPKWg3vxSm4XxIliNOefqegIlsmTIa3MpS6WWlCK3yHhat0Q-rRxDxdyiVdG_wzJvp0Iw_2wms7pe-PgNPYvUWH9JphWP5K38YqEBiJFXQ",
"q": "0A1FmpOWR91_RAWpqreWSavNaZb9nXeKiBo0DQGBz32DbqKqQ8S4aBJmbRhJcctjCLjain-ivut477tAUMmzJwVJDDq2MZFwC9Q-4VYZmFU4HJityQuSzHYe64RjN-E_NQ02TWhG3QGW6roq6c57c99rrUsETwJJiwS8M5p15Miuz53DaOjv-uqqFAFfywN5WkxHbraBcjHtMiQuyQbQqkCFh-oanHkwYNeytsNhTu2mQmwR5DR2roZ2nPiFjC6nsdk-A7E3S3wMzYYFw7jvbWWoYWo9vB40_MY2Y0FYQSqcDzcBIcq_0tnnasf3VW4Fdx6m80RzOb2Fsnln7vKXAQ",
"qi": "GyM_p6JrXySiz1toFgKbWV-JdI3jQ4ypu9rbMWx3rQJBfmt0FoYzgUIZEVFEcOqwemRN81zoDAaa-Bk0KWNGDjJHZDdDmFhW3AN7lI-puxk_mHZGJ11rxyR8O55XLSe3SPmRfKwZI6yU24ZxvQKFYItdldUKGzO6Ia6zTKhAVRU",
"use": "sig",
"x": "f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU",
"x5c": [
"string"
],
"y": "x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0"
}

Code samples

curl -X PUT /keys/{set}/{kid} \
-H 'Content-Type: application/json' \ -H 'Accept: application/json'

Delete a JSON Web Key

DELETE /keys/{set}/{kid} HTTP/1.1
Accept: application/json

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

ParameterInTypeRequiredDescription
kidpathstringtrueThe kid of the desired key
setpathstringtrueThe set

Responses

Overview
StatusMeaningDescriptionSchema
204No ContentEmpty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is
typically 201.None
401UnauthorizedgenericErrorgenericError
403ForbiddengenericErrorgenericError
500Internal Server ErrorgenericErrorgenericError
Examples
401 response
{
"debug": "The database adapter was unable to find the element",
"error": "The requested resource could not be found",
"error_description": "Object with ID 12345 does not exist",
"status_code": 404
}

Code samples

curl -X DELETE /keys/{set}/{kid} \
-H 'Accept: application/json'

Get snapshot metrics from the Hydra service. If you're using k8s, you can then add annotations to

your deployment like so:

GET /metrics/prometheus HTTP/1.1
metadata:
annotations:
prometheus.io/port: "4445"
prometheus.io/path: "/metrics/prometheus"

Responses

Overview
StatusMeaningDescriptionSchema
200OKEmpty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is
typically 201.None

Code samples

curl -X GET /metrics/prometheus

Get consent request information

GET /oauth2/auth/requests/consent?consent_challenge=string HTTP/1.1
Accept: application/json

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

ParameterInTypeRequiredDescription
consent_challengequerystringtruenone

Responses

Overview
StatusMeaningDescriptionSchema
200OKconsentRequestconsentRequest
404Not FoundgenericErrorgenericError
409ConflictgenericErrorgenericError
500Internal Server ErrorgenericErrorgenericError
Examples
200 response
{
"acr": "string",
"challenge": "string",
"client": {
"allowed_cors_origins": [
"string"
],
"audience": [
"string"
],
"backchannel_logout_session_required": true,
"backchannel_logout_uri": "string",
"client_id": "string",
"client_name": "string",
"client_secret": "string",
"client_secret_expires_at": 0,
"client_uri": "string",
"contacts": [
"string"
],
"created_at": "2020-06-23T09:16:53Z",
"frontchannel_logout_session_required": true,
"frontchannel_logout_uri": "string",
"grant_types": [
"string"
],
"jwks": {},
"jwks_uri": "string",
"logo_uri": "string",
"metadata": {},
"owner": "string",
"policy_uri": "string",
"post_logout_redirect_uris": [
"string"
],
"redirect_uris": [
"string"
],
"request_object_signing_alg": "string",
"request_uris": [
"string"
],
"response_types": [
"string"
],
"scope": "string",
"sector_identifier_uri": "string",
"subject_type": "string",
"token_endpoint_auth_method": "string",
"token_endpoint_auth_signing_alg": "string",
"tos_uri": "string",
"updated_at": "2020-06-23T09:16:53Z",
"userinfo_signed_response_alg": "string"
},
"context": {},
"login_challenge": "string",
"login_session_id": "string",
"oidc_context": {
"acr_values": [
"string"
],
"display": "string",
"id_token_hint_claims": {},
"login_hint": "string",
"ui_locales": [
"string"
]
},
"request_url": "string",
"requested_access_token_audience": [
"string"
],
"requested_scope": [
"string"
],
"skip": true,
"subject": "string"
}

Code samples

curl -X GET /oauth2/auth/requests/consent?consent_challenge=string \
-H 'Accept: application/json'

Accept a consent request

PUT /oauth2/auth/requests/consent/accept?consent_challenge=string HTTP/1.1
Content-Type: application/json
Accept: application/json

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.

Request body

{
"grant_access_token_audience": [
"string"
],
"grant_scope": [
"string"
],
"handled_at": "2020-06-23T09:16:53Z",
"remember": true,
"remember_for": 0,
"session": {
"access_token": {},
"id_token": {}
}
}

Parameters

ParameterInTypeRequiredDescription
consent_challengequerystringtruenone
bodybodyacceptConsentRequestfalsenone

Responses

Overview
StatusMeaningDescriptionSchema
200OKcompletedRequestcompletedRequest
404Not FoundgenericErrorgenericError
500Internal Server ErrorgenericErrorgenericError
Examples
200 response
{
"redirect_to": "string"
}

Code samples

curl -X PUT /oauth2/auth/requests/consent/accept?consent_challenge=string \
-H 'Content-Type: application/json' \ -H 'Accept: application/json'

Reject a consent request

PUT /oauth2/auth/requests/consent/reject?consent_challenge=string HTTP/1.1
Content-Type: application/json
Accept: application/json

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.

Request body

{
"error": "string",
"error_debug": "string",
"error_description": "string",
"error_hint": "string",
"status_code": 0
}

Parameters

ParameterInTypeRequiredDescription
consent_challengequerystringtruenone
bodybodyrejectRequestfalsenone

Responses

Overview
StatusMeaningDescriptionSchema
200OKcompletedRequestcompletedRequest
404Not FoundgenericErrorgenericError
500Internal Server ErrorgenericErrorgenericError
Examples
200 response
{
"redirect_to": "string"
}

Code samples

curl -X PUT /oauth2/auth/requests/consent/reject?consent_challenge=string \
-H 'Content-Type: application/json' \ -H 'Accept: application/json'

Get a login request

GET /oauth2/auth/requests/login?login_challenge=string HTTP/1.1
Accept: application/json

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

ParameterInTypeRequiredDescription
login_challengequerystringtruenone

Responses

Overview
StatusMeaningDescriptionSchema
200OKloginRequestloginRequest
400Bad RequestgenericErrorgenericError
404Not FoundgenericErrorgenericError
409ConflictgenericErrorgenericError
500Internal Server ErrorgenericErrorgenericError
Examples
200 response
{
"challenge": "string",
"client": {
"allowed_cors_origins": [
"string"
],
"audience": [
"string"
],
"backchannel_logout_session_required": true,
"backchannel_logout_uri": "string",
"client_id": "string",
"client_name": "string",
"client_secret": "string",
"client_secret_expires_at": 0,
"client_uri": "string",
"contacts": [
"string"
],
"created_at": "2020-06-23T09:16:53Z",
"frontchannel_logout_session_required": true,
"frontchannel_logout_uri": "string",
"grant_types": [
"string"
],
"jwks": {},
"jwks_uri": "string",
"logo_uri": "string",
"metadata": {},
"owner": "string",
"policy_uri": "string",
"post_logout_redirect_uris": [
"string"
],
"redirect_uris": [
"string"
],
"request_object_signing_alg": "string",
"request_uris": [
"string"
],
"response_types": [
"string"
],
"scope": "string",
"sector_identifier_uri": "string",
"subject_type": "string",
"token_endpoint_auth_method": "string",
"token_endpoint_auth_signing_alg": "string",
"tos_uri": "string",
"updated_at": "2020-06-23T09:16:53Z",
"userinfo_signed_response_alg": "string"
},
"oidc_context": {
"acr_values": [
"string"
],
"display": "string",
"id_token_hint_claims": {},
"login_hint": "string",
"ui_locales": [
"string"
]
},
"request_url": "string",
"requested_access_token_audience": [
"string"
],
"requested_scope": [
"string"
],
"session_id": "string",
"skip": true,
"subject": "string"
}

Code samples

curl -X GET /oauth2/auth/requests/login?login_challenge=string \
-H 'Accept: application/json'

Accept a login request

PUT /oauth2/auth/requests/login/accept?login_challenge=string HTTP/1.1
Content-Type: application/json
Accept: application/json

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.

Request body

{
"acr": "string",
"context": {},
"force_subject_identifier": "string",
"remember": true,
"remember_for": 0,
"subject": "string"
}

Parameters

ParameterInTypeRequiredDescription
login_challengequerystringtruenone
bodybodyacceptLoginRequestfalsenone

Responses

Overview
StatusMeaningDescriptionSchema
200OKcompletedRequestcompletedRequest
401UnauthorizedgenericErrorgenericError
404Not FoundgenericErrorgenericError
500Internal Server ErrorgenericErrorgenericError
Examples
200 response
{
"redirect_to": "string"
}

Code samples

curl -X PUT /oauth2/auth/requests/login/accept?login_challenge=string \
-H 'Content-Type: application/json' \ -H 'Accept: application/json'

Reject a login request

PUT /oauth2/auth/requests/login/reject?login_challenge=string HTTP/1.1
Content-Type: application/json
Accept: application/json

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.

Request body

{
"error": "string",
"error_debug": "string",
"error_description": "string",
"error_hint": "string",
"status_code": 0
}

Parameters

ParameterInTypeRequiredDescription
login_challengequerystringtruenone
bodybodyrejectRequestfalsenone

Responses

Overview
StatusMeaningDescriptionSchema
200OKcompletedRequestcompletedRequest
401UnauthorizedgenericErrorgenericError
404Not FoundgenericErrorgenericError
500Internal Server ErrorgenericErrorgenericError
Examples
200 response
{
"redirect_to": "string"
}

Code samples

curl -X PUT /oauth2/auth/requests/login/reject?login_challenge=string \
-H 'Content-Type: application/json' \ -H 'Accept: application/json'

Get a logout request

GET /oauth2/auth/requests/logout?logout_challenge=string HTTP/1.1
Accept: application/json

Use this endpoint to fetch a logout request.

Parameters

ParameterInTypeRequiredDescription
logout_challengequerystringtruenone

Responses

Overview
StatusMeaningDescriptionSchema
200OKlogoutRequestlogoutRequest
404Not FoundgenericErrorgenericError
500Internal Server ErrorgenericErrorgenericError
Examples
200 response
{
"request_url": "string",
"rp_initiated": true,
"sid": "string",
"subject": "string"
}

Code samples

curl -X GET /oauth2/auth/requests/logout?logout_challenge=string \
-H 'Accept: application/json'

Accept a logout request

PUT /oauth2/auth/requests/logout/accept?logout_challenge=string HTTP/1.1
Accept: application/json

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

ParameterInTypeRequiredDescription
logout_challengequerystringtruenone

Responses

Overview
StatusMeaningDescriptionSchema
200OKcompletedRequestcompletedRequest
404Not FoundgenericErrorgenericError
500Internal Server ErrorgenericErrorgenericError
Examples
200 response
{
"redirect_to": "string"
}

Code samples

curl -X PUT /oauth2/auth/requests/logout/accept?logout_challenge=string \
-H 'Accept: application/json'

Reject a logout request

PUT /oauth2/auth/requests/logout/reject?logout_challenge=string HTTP/1.1
Content-Type: application/json
Accept: application/json

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.

Request body

{
"error": "string",
"error_debug": "string",
"error_description": "string",
"error_hint": "string",
"status_code": 0
}
error: string
error_debug: string
error_description: string
error_hint: string
status_code: 0

Parameters

ParameterInTypeRequiredDescription
logout_challengequerystringtruenone
bodybodyrejectRequestfalsenone

Responses

Overview
StatusMeaningDescriptionSchema
204No ContentEmpty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is
typically 201.None
404Not FoundgenericErrorgenericError
500Internal Server ErrorgenericErrorgenericError
Examples
404 response
{
"debug": "The database adapter was unable to find the element",
"error": "The requested resource could not be found",
"error_description": "Object with ID 12345 does not exist",
"status_code": 404
}

Code samples

curl -X PUT /oauth2/auth/requests/logout/reject?logout_challenge=string \
-H 'Content-Type: application/json' \ -H 'Accept: application/json'

Lists all consent sessions of a subject

GET /oauth2/auth/sessions/consent?subject=string HTTP/1.1
Accept: application/json

This endpoint lists all subject's granted consent sessions, including client and granted scope. If the subject is unknown or has not granted any consent sessions yet, the endpoint returns an empty JSON array with status code 200 OK.

The "Link" header is also included in successful responses, which contains one or more links for pagination, formatted like so: 'https://hydra-url/admin/oauth2/auth/sessions/consent?subject={user}&limit={limit}&offset={offset}; rel="{page}"', where page is one of the following applicable pages: 'first', 'next', 'last', and 'previous'. Multiple links can be included in this header, and will be separated by a comma.

Parameters

ParameterInTypeRequiredDescription
subjectquerystringtruenone

Responses

Overview
StatusMeaningDescriptionSchema
200OKA list of used consent requests.Inline
400Bad RequestgenericErrorgenericError
500Internal Server ErrorgenericErrorgenericError
##### Response Schema

Status Code 200

NameTypeRequiredRestrictionsDescription
anonymous[PreviousConsentSession]falsenone[The response used to return used consent requests same as HandledLoginRequest, just with consent_request exposed as json]
» consent_requestconsentRequestfalsenonenone
»» acrstringfalsenoneACR represents the Authentication AuthorizationContext Class Reference value for this authentication session. You can use it to express that, for example, a user authenticated using two factor authentication.
»» challengestringfalsenoneChallenge is the identifier ("authorization challenge") of the consent authorization request. It is used to identify the session.
»» clientoAuth2Clientfalsenonenone
»»» allowed_cors_origins[string]falsenonenone
»»» audience[string]falsenonenone
»»» backchannel_logout_session_requiredbooleanfalsenoneBoolean value specifying whether the RP requires that a sid (session ID) Claim be included in the Logout Token to identify the RP session with the OP when the backchannel_logout_uri is used. If omitted, the default value is false.
»»» backchannel_logout_uristringfalsenoneRP URL that will cause the RP to log itself out when sent a Logout Token by the OP.
»»» client_idstringfalsenoneID is the id for this client.
»»» client_namestringfalsenoneName is the human-readable string name of the client to be presented to the end-user during authorization.
»»» client_secretstringfalsenoneSecret is the client's secret. The secret will be included in the create request as cleartext, and then never again. The secret is stored using BCrypt so it is impossible to recover it. Tell your users that they need to write the secret down as it will not be made available again.
»»» client_secret_expires_atinteger(int64)falsenoneSecretExpiresAt is an integer holding the time at which the client secret will expire or 0 if it will not expire. The time is represented as the number of seconds from 1970-01-01T00:00:00Z as measured in UTC until the date/time of expiration. This feature is currently not supported and it's value will always be set to 0.
»»» client_uristringfalsenoneClientURI is an URL string of a web page providing information about the client. If present, the server SHOULD display this URL to the end-user in a clickable fashion.
»»» contacts[string]falsenonenone
»»» created_atstring(date-time)falsenoneCreatedAt returns the timestamp of the client's creation.
»»» frontchannel_logout_session_requiredbooleanfalsenoneBoolean value specifying whether the RP requires that iss (issuer) and sid (session ID) query parameters be included to identify the RP session with the OP when the frontchannel_logout_uri is used. If omitted, the default value is false.
»»» frontchannel_logout_uristringfalsenoneRP URL that will cause the RP to log itself out when rendered in an iframe by the OP. An iss (issuer) query parameter and a sid (session ID) query parameter MAY be included by the OP to enable the RP to validate the request and to determine which of the potentially multiple sessions is to be logged out; if either is included, both MUST be.
»»» grant_types[string]falsenonenone
»»» jwksJoseJSONWebKeySetfalsenonenone
»»» jwks_uristringfalsenoneURL for the Client's JSON Web Key Set [JWK] document. If the Client signs requests to the Server, it contains the signing key(s) the Server uses to validate signatures from the Client. The JWK Set MAY also contain the Client's encryption keys(s), which are used by the Server to encrypt responses to the Client. When both signing and encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced JWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both signatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used to provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST match those in the certificate.
»»» logo_uristringfalsenoneLogoURI is an URL string that references a logo for the client.
»»» metadataJSONRawMessagefalsenonenone
»»» ownerstringfalsenoneOwner is a string identifying the owner of the OAuth 2.0 Client.
»»» policy_uristringfalsenonePolicyURI is a URL string that points to a human-readable privacy policy document that describes how the deployment organization collects, uses, retains, and discloses personal data.
»»» post_logout_redirect_uris[string]falsenonenone
»»» redirect_uris[string]falsenonenone
»»» request_object_signing_algstringfalsenoneJWS [JWS] alg algorithm [JWA] that MUST be used for signing Request Objects sent to the OP. All Request Objects from this Client MUST be rejected, if not signed with this algorithm.
»»» request_uris[string]falsenonenone
»»» response_types[string]falsenonenone
»»» scopestringfalsenoneScope is a string containing a space-separated list of scope values (as described in Section 3.3 of OAuth 2.0 [RFC6749]) that the client can use when requesting access tokens.
»»» sector_identifier_uristringfalsenoneURL using the https scheme to be used in calculating Pseudonymous Identifiers by the OP. The URL references a file with a single JSON array of redirect_uri values.
»»» subject_typestringfalsenoneSubjectType requested for responses to this Client. The subject_types_supported Discovery parameter contains a list of the supported subject_type values for this server. Valid types include pairwise and public.
»»» token_endpoint_auth_methodstringfalsenoneRequested Client Authentication method for the Token Endpoint. The options are client_secret_post, client_secret_basic, private_key_jwt, and none.
»»» token_endpoint_auth_signing_algstringfalsenoneRequested Client Authentication signing algorithm for the Token Endpoint.
»»» tos_uristringfalsenoneTermsOfServiceURI is a URL string that points to a human-readable terms of service document for the client that describes a contractual relationship between the end-user and the client that the end-user accepts when authorizing the client.
»»» updated_atstring(date-time)falsenoneUpdatedAt returns the timestamp of the last update.
»»» userinfo_signed_response_algstringfalsenoneJWS alg algorithm [JWA] REQUIRED for signing UserInfo Responses. If this is specified, the response will be JWT [JWT] serialized, and signed using JWS. The default, if omitted, is for the UserInfo Response to return the Claims as a UTF-8 encoded JSON object using the application/json content-type.
»» contextJSONRawMessagefalsenonenone
»» login_challengestringfalsenoneLoginChallenge is the login challenge this consent challenge belongs to. It can be used to associate a login and consent request in the login & consent app.
»» login_session_idstringfalsenoneLoginSessionID is the login session ID. If the user-agent reuses a login session (via cookie / remember flag) this ID will remain the same. If the user-agent did not have an existing authentication session (e.g. remember is false) this will be a new random value. This value is used as the "sid" parameter in the ID Token and in OIDC Front-/Back- channel logout. It's value can generally be used to associate consecutive login requests by a certain user.
»» oidc_contextopenIDConnectContextfalsenonenone
»»» acr_values[string]falsenoneACRValues is the Authentication AuthorizationContext Class Reference requested in the OAuth 2.0 Authorization request. It is a parameter defined by OpenID Connect and expresses which level of authentication (e.g. 2FA) is required. OpenID Connect defines it as follows: > Requested Authentication AuthorizationContext Class Reference values. Space-separated string that specifies the acr values that the Authorization Server is being requested to use for processing this Authentication Request, with the values appearing in order of preference. The Authentication AuthorizationContext Class satisfied by the authentication performed is returned as the acr Claim Value, as specified in Section 2. The acr Claim is requested as a Voluntary Claim by this parameter.
»»» displaystringfalsenoneDisplay is a string value that specifies how the Authorization Server displays the authentication and consent user interface pages to the End-User. The defined values are: page: The Authorization Server SHOULD display the authentication and consent UI consistent with a full User Agent page view. If the display parameter is not specified, this is the default display mode. popup: The Authorization Server SHOULD display the authentication and consent UI consistent with a popup User Agent window. The popup User Agent window should be of an appropriate size for a login-focused dialog and should not obscure the entire window that it is popping up over. touch: The Authorization Server SHOULD display the authentication and consent UI consistent with a device that leverages a touch interface. wap: The Authorization Server SHOULD display the authentication and consent UI consistent with a "feature phone" type display. The Authorization Server MAY also attempt to detect the capabilities of the User Agent and present an appropriate display.
»»» id_token_hint_claimsobjectfalsenoneIDTokenHintClaims are the claims of the ID Token previously issued by the Authorization Server being passed as a hint about the End-User's current or past authenticated session with the Client.
»»» login_hintstringfalsenoneLoginHint hints about the login identifier the End-User might use to log in (if necessary). This hint can be used by an RP if it first asks the End-User for their e-mail address (or other identifier) and then wants to pass that value as a hint to the discovered authorization service. This value MAY also be a phone number in the format specified for the phone_number Claim. The use of this parameter is optional.
»»» ui_locales[string]falsenoneUILocales is the End-User'id preferred languages and scripts for the user interface, represented as a space-separated list of BCP47 [RFC5646] language tag values, ordered by preference. For instance, the value "fr-CA fr en" represents a preference for French as spoken in Canada, then French (without a region designation), followed by English (without a region designation). An error SHOULD NOT result if some or all of the requested locales are not supported by the OpenID Provider.
»» request_urlstringfalsenoneRequestURL is the original OAuth 2.0 Authorization URL requested by the OAuth 2.0 client. It is the URL which initiates the OAuth 2.0 Authorization Code or OAuth 2.0 Implicit flow. This URL is typically not needed, but might come in handy if you want to deal with additional request parameters.
»» requested_access_token_audience[string]falsenonenone
»» requested_scope[string]falsenonenone
»» skipbooleanfalsenoneSkip, if true, implies that the client has requested the same scopes from the same user previously. If true, you must not ask the user to grant the requested scopes. You must however either allow or deny the consent request using the usual API call.
»» subjectstringfalsenoneSubject is the user ID of the end-user that authenticated. Now, that end user needs to grant or deny the scope requested by the OAuth 2.0 client.
» grant_access_token_audience[string]falsenonenone
» grant_scope[string]falsenonenone
» handled_atNullTime(date-time)falsenonenone
» rememberbooleanfalsenoneRemember, if set to true, tells ORY Hydra to remember this consent authorization and reuse it if the same client asks the same user for the same, or a subset of, scope.
» remember_forinteger(int64)falsenoneRememberFor sets how long the consent authorization should be remembered for in seconds. If set to 0, the authorization will be remembered indefinitely.
» sessionconsentRequestSessionfalsenonenone
»» access_tokenobjectfalsenoneAccessToken sets session data for the access and refresh token, as well as any future tokens issued by the refresh grant. Keep in mind that this data will be available to anyone performing OAuth 2.0 Challenge Introspection. If only your services can perform OAuth 2.0 Challenge Introspection, this is usually fine. But if third parties can access that endpoint as well, sensitive data from the session might be exposed to them. Use with care!
»» id_tokenobjectfalsenoneIDToken sets session data for the OpenID Connect ID token. Keep in mind that the session'id payloads are readable by anyone that has access to the ID Challenge. Use with care!
Examples
200 response
[
{
"consent_request": {
"acr": "string",
"challenge": "string",
"client": {
"allowed_cors_origins": [
"string"
],
"audience": [
"string"
],
"backchannel_logout_session_required": true,
"backchannel_logout_uri": "string",
"client_id": "string",
"client_name": "string",
"client_secret": "string",
"client_secret_expires_at": 0,
"client_uri": "string",
"contacts": [
"string"
],
"created_at": "2020-06-23T09:16:53Z",
"frontchannel_logout_session_required": true,
"frontchannel_logout_uri": "string",
"grant_types": [
"string"
],
"jwks": {},
"jwks_uri": "string",
"logo_uri": "string",
"metadata": {},
"owner": "string",
"policy_uri": "string",
"post_logout_redirect_uris": [
"string"
],
"redirect_uris": [
"string"
],
"request_object_signing_alg": "string",
"request_uris": [
"string"
],
"response_types": [
"string"
],
"scope": "string",
"sector_identifier_uri": "string",
"subject_type": "string",
"token_endpoint_auth_method": "string",
"token_endpoint_auth_signing_alg": "string",
"tos_uri": "string",
"updated_at": "2020-06-23T09:16:53Z",
"userinfo_signed_response_alg": "string"
},
"context": {},
"login_challenge": "string",
"login_session_id": "string",
"oidc_context": {
"acr_values": [
"string"
],
"display": "string",
"id_token_hint_claims": {},
"login_hint": "string",
"ui_locales": [
"string"
]
},
"request_url": "string",
"requested_access_token_audience": [
"string"
],
"requested_scope": [
"string"
],
"skip": true,
"subject": "string"
},
"grant_access_token_audience": [
"string"
],
"grant_scope": [
"string"
],
"handled_at": "2020-06-23T09:16:53Z",
"remember": true,
"remember_for": 0,
"session": {
"access_token": {},
"id_token": {}
}
}
]

Code samples

curl -X GET /oauth2/auth/sessions/consent?subject=string \
-H 'Accept: application/json'

Revokes consent sessions of a subject for a specific OAuth 2.0 Client

DELETE /oauth2/auth/sessions/consent?subject=string HTTP/1.1
Accept: application/json

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

ParameterInTypeRequiredDescription
subjectquerystringtrueThe subject (Subject) who's consent sessions should be deleted.
clientquerystringfalseIf set, deletes only those consent sessions by the Subject that have been granted to the specified OAuth 2.0 Client ID

Responses

Overview
StatusMeaningDescriptionSchema
204No ContentEmpty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is
typically 201.None
400Bad RequestgenericErrorgenericError
404Not FoundgenericErrorgenericError
500Internal Server ErrorgenericErrorgenericError
Examples
400 response
{
"debug": "The database adapter was unable to find the element",
"error": "The requested resource could not be found",
"error_description": "Object with ID 12345 does not exist",
"status_code": 404
}

Code samples

curl -X DELETE /oauth2/auth/sessions/consent?subject=string \
-H 'Accept: application/json'

Invalidates all login sessions of a certain user

Invalidates a subject's authentication session

DELETE /oauth2/auth/sessions/login?subject=string HTTP/1.1
Accept: application/json

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

ParameterInTypeRequiredDescription
subjectquerystringtruenone

Responses

Overview
StatusMeaningDescriptionSchema
204No ContentEmpty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is
typically 201.None
400Bad RequestgenericErrorgenericError
404Not FoundgenericErrorgenericError
500Internal Server ErrorgenericErrorgenericError
Examples
400 response
{
"debug": "The database adapter was unable to find the element",
"error": "The requested resource could not be found",
"error_description": "Object with ID 12345 does not exist",
"status_code": 404
}

Code samples

curl -X DELETE /oauth2/auth/sessions/login?subject=string \
-H 'Accept: application/json'

Flush Expired OAuth2 Access Tokens

POST /oauth2/flush HTTP/1.1
Content-Type: application/json
Accept: application/json

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.

Request body

{
"notAfter": "2020-06-23T09:16:53Z"
}

Parameters

ParameterInTypeRequiredDescription
bodybodyflushInactiveOAuth2TokensRequestfalsenone

Responses

Overview
StatusMeaningDescriptionSchema
204No ContentEmpty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is
typically 201.None
401UnauthorizedgenericErrorgenericError
500Internal Server ErrorgenericErrorgenericError
Examples
401 response
{
"debug": "The database adapter was unable to find the element",
"error": "The requested resource could not be found",
"error_description": "Object with ID 12345 does not exist",
"status_code": 404
}

Code samples

curl -X POST /oauth2/flush \
-H 'Content-Type: application/json' \ -H 'Accept: application/json'

Introspect OAuth2 tokens

POST /oauth2/introspect HTTP/1.1
Content-Type: application/x-www-form-urlencoded
Accept: application/json

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.

Request body

token: string
scope: string

Parameters

ParameterInTypeRequiredDescription
bodybodyobjectfalsenone
» tokenbodystringtrueThe string value of the token. For access tokens, this
» scopebodystringfalseAn optional, space separated list of required scopes. If the access token was not granted one of the
Detailed descriptions

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

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

Responses

Overview
StatusMeaningDescriptionSchema
200OKoAuth2TokenIntrospectionoAuth2TokenIntrospection
401UnauthorizedgenericErrorgenericError
500Internal Server ErrorgenericErrorgenericError
Examples
200 response
{
"active": true,
"aud": [
"string"
],
"client_id": "string",
"exp": 0,
"ext": {},
"iat": 0,
"iss": "string",
"nbf": 0,
"obfuscated_subject": "string",
"scope": "string",
"sub": "string",
"token_type": "string",
"username": "string"
}

Code samples

curl -X POST /oauth2/introspect \
-H 'Content-Type: application/x-www-form-urlencoded' \ -H 'Accept: application/json'

Get service version

GET /version HTTP/1.1
Accept: application/json

This endpoint returns the service version typically notated using semantic versioning.

If the service supports TLS Edge Termination, this endpoint does not require the X-Forwarded-Proto header to be set.

Responses

Overview
StatusMeaningDescriptionSchema
200OKversionversion
Examples
200 response
{
"version": "string"
}

Code samples

curl -X GET /version \
-H 'Accept: application/json'

Schemas

ContainerWaitOKBodyError#### ContainerWaitOKBodyError
{
"Message": "string"
}

ContainerWaitOKBodyError container waiting error, if any

Properties

NameTypeRequiredRestrictionsDescription
MessagestringfalsenoneDetails of an error
JSONRawMessage#### JSONRawMessage
{}

JSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger.

Properties

None

JSONWebKey#### JSONWebKey
{
"alg": "RS256",
"crv": "P-256",
"d": "T_N8I-6He3M8a7X1vWt6TGIx4xB_GP3Mb4SsZSA4v-orvJzzRiQhLlRR81naWYxfQAYt5isDI6_C2L9bdWo4FFPjGQFvNoRX-_sBJyBI_rl-TBgsZYoUlAj3J92WmY2inbA-PwyJfsaIIDceYBC-eX-xiCu6qMqkZi3MwQAFL6bMdPEM0z4JBcwFT3VdiWAIRUuACWQwrXMq672x7fMuaIaHi7XDGgt1ith23CLfaREmJku9PQcchbt_uEY-hqrFY6ntTtS4paWWQj86xLL94S-Tf6v6xkL918PfLSOTq6XCzxvlFwzBJqApnAhbwqLjpPhgUG04EDRrqrSBc5Y1BLevn6Ip5h1AhessBp3wLkQgz_roeckt-ybvzKTjESMuagnpqLvOT7Y9veIug2MwPJZI2VjczRc1vzMs25XrFQ8DpUy-bNdp89TmvAXwctUMiJdgHloJw23Cv03gIUAkDnsTqZmkpbIf-crpgNKFmQP_EDKoe8p_PXZZgfbRri3NoEVGP7Mk6yEu8LjJhClhZaBNjuWw2-KlBfOA3g79mhfBnkInee5KO9mGR50qPk1V-MorUYNTFMZIm0kFE6eYVWFBwJHLKYhHU34DoiK1VP-svZpC2uAMFNA_UJEwM9CQ2b8qe4-5e9aywMvwcuArRkAB5mBIfOaOJao3mfukKAE",
"dp": "G4sPXkc6Ya9y8oJW9_ILj4xuppu0lzi_H7VTkS8xj5SdX3coE0oimYwxIi2emTAue0UOa5dpgFGyBJ4c8tQ2VF402XRugKDTP8akYhFo5tAA77Qe_NmtuYZc3C3m3I24G2GvR5sSDxUyAN2zq8Lfn9EUms6rY3Ob8YeiKkTiBj0",
"dq": "s9lAH9fggBsoFR8Oac2R_E2gw282rT2kGOAhvIllETE1efrA6huUUvMfBcMpn8lqeW6vzznYY5SSQF7pMdC_agI3nG8Ibp1BUb0JUiraRNqUfLhcQb_d9GF4Dh7e74WbRsobRonujTYN1xCaP6TO61jvWrX-L18txXw494Q_cgk",
"e": "AQAB",
"k": "GawgguFyGrWKav7AX4VKUg",
"kid": "1603dfe0af8f4596",
"kty": "RSA",
"n": "vTqrxUyQPl_20aqf5kXHwDZrel-KovIp8s7ewJod2EXHl8tWlRB3_Rem34KwBfqlKQGp1nqah-51H4Jzruqe0cFP58hPEIt6WqrvnmJCXxnNuIB53iX_uUUXXHDHBeaPCSRoNJzNysjoJ30TIUsKBiirhBa7f235PXbKiHducLevV6PcKxJ5cY8zO286qJLBWSPm-OIevwqsIsSIH44Qtm9sioFikhkbLwoqwWORGAY0nl6XvVOlhADdLjBSqSAeT1FPuCDCnXwzCDR8N9IFB_IjdStFkC-rVt2K5BYfPd0c3yFp_vHR15eRd0zJ8XQ7woBC8Vnsac6Et1pKS59pX6256DPWu8UDdEOolKAPgcd_g2NpA76cAaF_jcT80j9KrEzw8Tv0nJBGesuCjPNjGs_KzdkWTUXt23Hn9QJsdc1MZuaW0iqXBepHYfYoqNelzVte117t4BwVp0kUM6we0IqyXClaZgOI8S-WDBw2_Ovdm8e5NmhYAblEVoygcX8Y46oH6bKiaCQfKCFDMcRgChme7AoE1yZZYsPbaG_3IjPrC4LBMHQw8rM9dWjJ8ImjicvZ1pAm0dx-KHCP3y5PVKrxBDf1zSOsBRkOSjB8TPODnJMz6-jd5hTtZxpZPwPoIdCanTZ3ZD6uRBpTmDwtpRGm63UQs1m5FWPwb0T2IF0",
"p": "6NbkXwDWUhi-eR55Cgbf27FkQDDWIamOaDr0rj1q0f1fFEz1W5A_09YvG09Fiv1AO2-D8Rl8gS1Vkz2i0zCSqnyy8A025XOcRviOMK7nIxE4OH_PEsko8dtIrb3TmE2hUXvCkmzw9EsTF1LQBOGC6iusLTXepIC1x9ukCKFZQvdgtEObQ5kzd9Nhq-cdqmSeMVLoxPLd1blviVT9Vm8-y12CtYpeJHOaIDtVPLlBhJiBoPKWg3vxSm4XxIliNOefqegIlsmTIa3MpS6WWlCK3yHhat0Q-rRxDxdyiVdG_wzJvp0Iw_2wms7pe-PgNPYvUWH9JphWP5K38YqEBiJFXQ",
"q": "0A1FmpOWR91_RAWpqreWSavNaZb9nXeKiBo0DQGBz32DbqKqQ8S4aBJmbRhJcctjCLjain-ivut477tAUMmzJwVJDDq2MZFwC9Q-4VYZmFU4HJityQuSzHYe64RjN-E_NQ02TWhG3QGW6roq6c57c99rrUsETwJJiwS8M5p15Miuz53DaOjv-uqqFAFfywN5WkxHbraBcjHtMiQuyQbQqkCFh-oanHkwYNeytsNhTu2mQmwR5DR2roZ2nPiFjC6nsdk-A7E3S3wMzYYFw7jvbWWoYWo9vB40_MY2Y0FYQSqcDzcBIcq_0tnnasf3VW4Fdx6m80RzOb2Fsnln7vKXAQ",
"qi": "GyM_p6JrXySiz1toFgKbWV-JdI3jQ4ypu9rbMWx3rQJBfmt0FoYzgUIZEVFEcOqwemRN81zoDAaa-Bk0KWNGDjJHZDdDmFhW3AN7lI-puxk_mHZGJ11rxyR8O55XLSe3SPmRfKwZI6yU24ZxvQKFYItdldUKGzO6Ia6zTKhAVRU",
"use": "sig",
"x": "f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU",
"x5c": [
"string"
],
"y": "x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0"
}

It is important that this model object is named JSONWebKey for "swagger generate spec" to generate only on definition of a JSONWebKey.

Properties

NameTypeRequiredRestrictionsDescription
algstringtruenoneThe "alg" (algorithm) parameter identifies the algorithm intended for use with the key. The values used should either be registered in the IANA "JSON Web Signature and Encryption Algorithms" registry established by [JWA] or be a value that contains a Collision- Resistant Name.
crvstringfalsenonenone
dstringfalsenonenone
dpstringfalsenonenone
dqstringfalsenonenone
estringfalsenonenone
kstringfalsenonenone
kidstringtruenoneThe "kid" (key ID) parameter is used to match a specific key. This is used, for instance, to choose among a set of keys within a JWK Set during key rollover. The structure of the "kid" value is unspecified. When "kid" values are used within a JWK Set, different keys within the JWK Set SHOULD use distinct "kid" values. (One example in which different keys might use the same "kid" value is if they have different "kty" (key type) values but are considered to be equivalent alternatives by the application using them.) The "kid" value is a case-sensitive string.
ktystringtruenoneThe "kty" (key type) parameter identifies the cryptographic algorithm family used with the key, such as "RSA" or "EC". "kty" values should either be registered in the IANA "JSON Web Key Types" registry established by [JWA] or be a value that contains a Collision- Resistant Name. The "kty" value is a case-sensitive string.
nstringfalsenonenone
pstringfalsenonenone
qstringfalsenonenone
qistringfalsenonenone
usestringtruenoneUse ("public key use") identifies the intended use of the public key. The "use" parameter is employed to indicate whether a public key is used for encrypting data or verifying the signature on data. Values are commonly "sig" (signature) or "enc" (encryption).
xstringfalsenonenone
x5c[string]falsenoneThe "x5c" (X.509 certificate chain) parameter contains a chain of one or more PKIX certificates [RFC5280]. The certificate chain is represented as a JSON array of certificate value strings. Each string in the array is a base64-encoded (Section 4 of [RFC4648] -- not base64url-encoded) DER [ITU.X690.1994] PKIX certificate value. The PKIX certificate containing the key value MUST be the first certificate.
ystringfalsenonenone
JSONWebKeySet#### JSONWebKeySet
{
"keys": [
{
"alg": "RS256",
"crv": "P-256",
"d": "T_N8I-6He3M8a7X1vWt6TGIx4xB_GP3Mb4SsZSA4v-orvJzzRiQhLlRR81naWYxfQAYt5isDI6_C2L9bdWo4FFPjGQFvNoRX-_sBJyBI_rl-TBgsZYoUlAj3J92WmY2inbA-PwyJfsaIIDceYBC-eX-xiCu6qMqkZi3MwQAFL6bMdPEM0z4JBcwFT3VdiWAIRUuACWQwrXMq672x7fMuaIaHi7XDGgt1ith23CLfaREmJku9PQcchbt_uEY-hqrFY6ntTtS4paWWQj86xLL94S-Tf6v6xkL918PfLSOTq6XCzxvlFwzBJqApnAhbwqLjpPhgUG04EDRrqrSBc5Y1BLevn6Ip5h1AhessBp3wLkQgz_roeckt-ybvzKTjESMuagnpqLvOT7Y9veIug2MwPJZI2VjczRc1vzMs25XrFQ8DpUy-bNdp89TmvAXwctUMiJdgHloJw23Cv03gIUAkDnsTqZmkpbIf-crpgNKFmQP_EDKoe8p_PXZZgfbRri3NoEVGP7Mk6yEu8LjJhClhZaBNjuWw2-KlBfOA3g79mhfBnkInee5KO9mGR50qPk1V-MorUYNTFMZIm0kFE6eYVWFBwJHLKYhHU34DoiK1VP-svZpC2uAMFNA_UJEwM9CQ2b8qe4-5e9aywMvwcuArRkAB5mBIfOaOJao3mfukKAE",
"dp": "G4sPXkc6Ya9y8oJW9_ILj4xuppu0lzi_H7VTkS8xj5SdX3coE0oimYwxIi2emTAue0UOa5dpgFGyBJ4c8tQ2VF402XRugKDTP8akYhFo5tAA77Qe_NmtuYZc3C3m3I24G2GvR5sSDxUyAN2zq8Lfn9EUms6rY3Ob8YeiKkTiBj0",
"dq": "s9lAH9fggBsoFR8Oac2R_E2gw282rT2kGOAhvIllETE1efrA6huUUvMfBcMpn8lqeW6vzznYY5SSQF7pMdC_agI3nG8Ibp1BUb0JUiraRNqUfLhcQb_d9GF4Dh7e74WbRsobRonujTYN1xCaP6TO61jvWrX-L18txXw494Q_cgk",
"e": "AQAB",
"k": "GawgguFyGrWKav7AX4VKUg",
"kid": "1603dfe0af8f4596",
"kty": "RSA",
"n": "vTqrxUyQPl_20aqf5kXHwDZrel-KovIp8s7ewJod2EXHl8tWlRB3_Rem34KwBfqlKQGp1nqah-51H4Jzruqe0cFP58hPEIt6WqrvnmJCXxnNuIB53iX_uUUXXHDHBeaPCSRoNJzNysjoJ30TIUsKBiirhBa7f235PXbKiHducLevV6PcKxJ5cY8zO286qJLBWSPm-OIevwqsIsSIH44Qtm9sioFikhkbLwoqwWORGAY0nl6XvVOlhADdLjBSqSAeT1FPuCDCnXwzCDR8N9IFB_IjdStFkC-rVt2K5BYfPd0c3yFp_vHR15eRd0zJ8XQ7woBC8Vnsac6Et1pKS59pX6256DPWu8UDdEOolKAPgcd_g2NpA76cAaF_jcT80j9KrEzw8Tv0nJBGesuCjPNjGs_KzdkWTUXt23Hn9QJsdc1MZuaW0iqXBepHYfYoqNelzVte117t4BwVp0kUM6we0IqyXClaZgOI8S-WDBw2_Ovdm8e5NmhYAblEVoygcX8Y46oH6bKiaCQfKCFDMcRgChme7AoE1yZZYsPbaG_3IjPrC4LBMHQw8rM9dWjJ8ImjicvZ1pAm0dx-KHCP3y5PVKrxBDf1zSOsBRkOSjB8TPODnJMz6-jd5hTtZxpZPwPoIdCanTZ3ZD6uRBpTmDwtpRGm63UQs1m5FWPwb0T2IF0",
"p": "6NbkXwDWUhi-eR55Cgbf27FkQDDWIamOaDr0rj1q0f1fFEz1W5A_09YvG09Fiv1AO2-D8Rl8gS1Vkz2i0zCSqnyy8A025XOcRviOMK7nIxE4OH_PEsko8dtIrb3TmE2hUXvCkmzw9EsTF1LQBOGC6iusLTXepIC1x9ukCKFZQvdgtEObQ5kzd9Nhq-cdqmSeMVLoxPLd1blviVT9Vm8-y12CtYpeJHOaIDtVPLlBhJiBoPKWg3vxSm4XxIliNOefqegIlsmTIa3MpS6WWlCK3yHhat0Q-rRxDxdyiVdG_wzJvp0Iw_2wms7pe-PgNPYvUWH9JphWP5K38YqEBiJFXQ",
"q": "0A1FmpOWR91_RAWpqreWSavNaZb9nXeKiBo0DQGBz32DbqKqQ8S4aBJmbRhJcctjCLjain-ivut477tAUMmzJwVJDDq2MZFwC9Q-4VYZmFU4HJityQuSzHYe64RjN-E_NQ02TWhG3QGW6roq6c57c99rrUsETwJJiwS8M5p15Miuz53DaOjv-uqqFAFfywN5WkxHbraBcjHtMiQuyQbQqkCFh-oanHkwYNeytsNhTu2mQmwR5DR2roZ2nPiFjC6nsdk-A7E3S3wMzYYFw7jvbWWoYWo9vB40_MY2Y0FYQSqcDzcBIcq_0tnnasf3VW4Fdx6m80RzOb2Fsnln7vKXAQ",
"qi": "GyM_p6JrXySiz1toFgKbWV-JdI3jQ4ypu9rbMWx3rQJBfmt0FoYzgUIZEVFEcOqwemRN81zoDAaa-Bk0KWNGDjJHZDdDmFhW3AN7lI-puxk_mHZGJ11rxyR8O55XLSe3SPmRfKwZI6yU24ZxvQKFYItdldUKGzO6Ia6zTKhAVRU",
"use": "sig",
"x": "f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU",
"x5c": [
"string"
],
"y": "x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0"
}
]
}

It is important that this model object is named JSONWebKeySet for "swagger generate spec" to generate only on definition of a JSONWebKeySet. Since one with the same name is previously defined as client.Client.JSONWebKeys and this one is last, this one will be effectively written in the swagger spec.

Properties

NameTypeRequiredRestrictionsDescription
keys[JSONWebKey]falsenoneThe value of the "keys" parameter is an array of JWK values. By default, the order of the JWK values within the array does not imply an order of preference among them, although applications of JWK Sets can choose to assign a meaning to the order for their purposes, if desired.
JoseJSONWebKeySet#### JoseJSONWebKeySet
{}

Properties

None

NullTime#### NullTime
"2020-06-23T09:16:53Z"

NullTime implements sql.NullTime functionality.

Properties

NameTypeRequiredRestrictionsDescription
NullTime implements sql.NullTime functionality.string(date-time)falsenonenone
PluginConfig#### PluginConfig
{
"Args": {
"Description": "string",
"Name": "string",
"Settable": [
"string"
],
"Value": [
"string"
]
},
"Description": "string",
"DockerVersion": "string",
"Documentation": "string",
"Entrypoint": [
"string"
],
"Env": [
{
"Description": "string",
"Name": "string",
"Settable": [
"string"
],
"Value": "string"
}
],
"Interface": {
"Socket": "string",
"Types": [
{
"Capability": "string",
"Prefix": "string",
"Version": "string"
}
]
},
"IpcHost": true,
"Linux": {
"AllowAllDevices": true,
"Capabilities": [
"string"
],
"Devices": [
{
"Description": "string",
"Name": "string",
"Path": "string",
"Settable": [
"string"
]
}
]
},
"Mounts": [
{
"Description": "string",
"Destination": "string",
"Name": "string",
"Options": [
"string"
],
"Settable": [
"string"
],
"Source": "string",
"Type": "string"
}
],
"Network": {
"Type": "string"
},
"PidHost": true,
"PropagatedMount": "string",
"User": {
"GID": 0,
"UID": 0
},
"WorkDir": "string",
"rootfs": {
"diff_ids": [
"string"
],
"type": "string"
}
}

PluginConfig The config of a plugin.

Properties

NameTypeRequiredRestrictionsDescription
ArgsPluginConfigArgstruenonePluginConfigArgs plugin config args
Descriptionstringtruenonedescription
DockerVersionstringfalsenoneDocker Version used to create the plugin
Documentationstringtruenonedocumentation
Entrypoint[string]truenoneentrypoint
Env[PluginEnv]truenoneenv
InterfacePluginConfigInterfacetruenonePluginConfigInterface The interface between Docker and the plugin
IpcHostbooleantruenoneipc host
LinuxPluginConfigLinuxtruenonePluginConfigLinux plugin config linux
Mounts[PluginMount]truenonemounts
NetworkPluginConfigNetworktruenonePluginConfigNetwork plugin config network
PidHostbooleantruenonepid host
PropagatedMountstringtruenonepropagated mount
UserPluginConfigUserfalsenonePluginConfigUser plugin config user
WorkDirstringtruenonework dir
rootfsPluginConfigRootfsfalsenonePluginConfigRootfs plugin config rootfs
PluginConfigArgs#### PluginConfigArgs
{
"Description": "string",
"Name": "string",
"Settable": [
"string"
],
"Value": [
"string"
]
}

PluginConfigArgs plugin config args

Properties

NameTypeRequiredRestrictionsDescription
Descriptionstringtruenonedescription
Namestringtruenonename
Settable[string]truenonesettable
Value[string]truenonevalue
PluginConfigInterface#### PluginConfigInterface
{
"Socket": "string",
"Types": [
{
"Capability": "string",
"Prefix": "string",
"Version": "string"
}
]
}

PluginConfigInterface The interface between Docker and the plugin

Properties

NameTypeRequiredRestrictionsDescription
Socketstringtruenonesocket
Types[PluginInterfaceType]truenonetypes
PluginConfigLinux#### PluginConfigLinux
{
"AllowAllDevices": true,
"Capabilities": [
"string"
],
"Devices": [
{
"Description": "string",
"Name": "string",
"Path": "string",
"Settable": [
"string"
]
}
]
}

PluginConfigLinux plugin config linux

Properties

NameTypeRequiredRestrictionsDescription
AllowAllDevicesbooleantruenoneallow all devices
Capabilities[string]truenonecapabilities
Devices[PluginDevice]truenonedevices
PluginConfigNetwork#### PluginConfigNetwork
{
"Type": "string"
}

PluginConfigNetwork plugin config network

Properties

NameTypeRequiredRestrictionsDescription
Typestringtruenonetype
PluginConfigRootfs#### PluginConfigRootfs
{
"diff_ids": [
"string"
],
"type": "string"
}

PluginConfigRootfs plugin config rootfs

Properties

NameTypeRequiredRestrictionsDescription
diff_ids[string]falsenonediff ids
typestringfalsenonetype
PluginConfigUser#### PluginConfigUser
{
"GID": 0,
"UID": 0
}

PluginConfigUser plugin config user

Properties

NameTypeRequiredRestrictionsDescription
GIDinteger(uint32)falsenoneg ID
UIDinteger(uint32)falsenoneUID
PluginDevice#### PluginDevice
{
"Description": "string",
"Name": "string",
"Path": "string",
"Settable": [
"string"
]
}

PluginDevice plugin device

Properties

NameTypeRequiredRestrictionsDescription
Descriptionstringtruenonedescription
Namestringtruenonename
Pathstringtruenonepath
Settable[string]truenonesettable
PluginEnv#### PluginEnv
{
"Description": "string",
"Name": "string",
"Settable": [
"string"
],
"Value": "string"
}

PluginEnv plugin env

Properties

NameTypeRequiredRestrictionsDescription
Descriptionstringtruenonedescription
Namestringtruenonename
Settable[string]truenonesettable
Valuestringtruenonevalue
PluginInterfaceType#### PluginInterfaceType
{
"Capability": "string",
"Prefix": "string",
"Version": "string"
}

PluginInterfaceType plugin interface type

Properties

NameTypeRequiredRestrictionsDescription
Capabilitystringtruenonecapability
Prefixstringtruenoneprefix
Versionstringtruenoneversion
PluginMount#### PluginMount
{
"Description": "string",
"Destination": "string",
"Name": "string",
"Options": [
"string"
],
"Settable": [
"string"
],
"Source": "string",
"Type": "string"
}

PluginMount plugin mount

Properties

NameTypeRequiredRestrictionsDescription
Descriptionstringtruenonedescription
Destinationstringtruenonedestination
Namestringtruenonename
Options[string]truenoneoptions
Settable[string]truenonesettable
Sourcestringtruenonesource
Typestringtruenonetype
PluginSettings#### PluginSettings
{
"Args": [
"string"
],
"Devices": [
{
"Description": "string",
"Name": "string",
"Path": "string",
"Settable": [
"string"
]
}
],
"Env": [
"string"
],
"Mounts": [
{
"Description": "string",
"Destination": "string",
"Name": "string",
"Options": [
"string"
],
"Settable": [
"string"
],
"Source": "string",
"Type": "string"
}
]
}

PluginSettings Settings that can be modified by users.

Properties

NameTypeRequiredRestrictionsDescription
Args[string]truenoneargs
Devices[PluginDevice]truenonedevices
Env[string]truenoneenv
Mounts[PluginMount]truenonemounts
PreviousConsentSession#### PreviousConsentSession
{
"consent_request": {
"acr": "string",
"challenge": "string",
"client": {
"allowed_cors_origins": [
"string"
],
"audience": [
"string"
],
"backchannel_logout_session_required": true,
"backchannel_logout_uri": "string",
"client_id": "string",
"client_name": "string",
"client_secret": "string",
"client_secret_expires_at": 0,
"client_uri": "string",
"contacts": [
"string"
],
"created_at": "2020-06-23T09:16:53Z",
"frontchannel_logout_session_required": true,
"frontchannel_logout_uri": "string",
"grant_types": [
"string"
],
"jwks": {},
"jwks_uri": "string",
"logo_uri": "string",
"metadata": {},
"owner": "string",
"policy_uri": "string",
"post_logout_redirect_uris": [
"string"
],
"redirect_uris": [
"string"
],
"request_object_signing_alg": "string",
"request_uris": [
"string"
],
"response_types": [
"string"
],
"scope": "string",
"sector_identifier_uri": "string",
"subject_type": "string",
"token_endpoint_auth_method": "string",
"token_endpoint_auth_signing_alg": "string",
"tos_uri": "string",
"updated_at": "2020-06-23T09:16:53Z",
"userinfo_signed_response_alg": "string"
},
"context": {},
"login_challenge": "string",
"login_session_id": "string",
"oidc_context": {
"acr_values": [
"string"
],
"display": "string",
"id_token_hint_claims": {},
"login_hint": "string",
"ui_locales": [
"string"
]
},
"request_url": "string",
"requested_access_token_audience": [
"string"
],
"requested_scope": [
"string"
],
"skip": true,
"subject": "string"
},
"grant_access_token_audience": [
"string"
],
"grant_scope": [
"string"
],
"handled_at": "2020-06-23T09:16:53Z",
"remember": true,
"remember_for": 0,
"session": {
"access_token": {},
"id_token": {}
}
}

The response used to return used consent requests same as HandledLoginRequest, just with consent_request exposed as json

Properties

NameTypeRequiredRestrictionsDescription
consent_requestconsentRequestfalsenonenone
grant_access_token_audienceStringSlicePipeDelimiterfalsenonenone
grant_scopeStringSlicePipeDelimiterfalsenonenone
handled_atNullTimefalsenonenone
rememberbooleanfalsenoneRemember, if set to true, tells ORY Hydra to remember this consent authorization and reuse it if the same client asks the same user for the same, or a subset of, scope.
remember_forinteger(int64)falsenoneRememberFor sets how long the consent authorization should be remembered for in seconds. If set to 0, the authorization will be remembered indefinitely.
sessionconsentRequestSessionfalsenonenone
StringSlicePipeDelimiter#### StringSlicePipeDelimiter
[
"string"
]

StringSlicePipeDelimiter de/encodes the string slice to/from a SQL string.

Properties

NameTypeRequiredRestrictionsDescription
StringSlicePipeDelimiter de/encodes the string slice to/from a SQL string.[string]falsenonenone
VolumeUsageData#### VolumeUsageData
{
"RefCount": 0,
"Size": 0
}

VolumeUsageData Usage details about the volume. This information is used by the GET /system/df endpoint, and omitted in other endpoints.

Properties

NameTypeRequiredRestrictionsDescription
RefCountinteger(int64)truenoneThe number of containers referencing this volume. This field is set to -1 if the reference-count is not available.
Sizeinteger(int64)truenoneAmount of disk space used by the volume (in bytes). This information is only available for volumes created with the "local" volume driver. For volumes created with other volume drivers, this field is set to -1 ("not available")
acceptConsentRequest#### acceptConsentRequest
{
"grant_access_token_audience": [
"string"
],
"grant_scope": [
"string"
],
"handled_at": "2020-06-23T09:16:53Z",
"remember": true,
"remember_for": 0,
"session": {
"access_token": {},
"id_token": {}
}
}

The request payload used to accept a consent request.

Properties

NameTypeRequiredRestrictionsDescription
grant_access_token_audienceStringSlicePipeDelimiterfalsenonenone
grant_scopeStringSlicePipeDelimiterfalsenonenone
handled_atNullTimefalsenonenone
rememberbooleanfalsenoneRemember, if set to true, tells ORY Hydra to remember this consent authorization and reuse it if the same client asks the same user for the same, or a subset of, scope.
remember_forinteger(int64)falsenoneRememberFor sets how long the consent authorization should be remembered for in seconds. If set to 0, the authorization will be remembered indefinitely.
sessionconsentRequestSessionfalsenonenone
acceptLoginRequest#### acceptLoginRequest
{
"acr": "string",
"context": {},
"force_subject_identifier": "string",
"remember": true,
"remember_for": 0,
"subject": "string"
}

HandledLoginRequest is the request payload used to accept a login request.

Properties

NameTypeRequiredRestrictionsDescription
acrstringfalsenoneACR sets the Authentication AuthorizationContext Class Reference value for this authentication session. You can use it to express that, for example, a user authenticated using two factor authentication.
contextJSONRawMessagefalsenonenone
force_subject_identifierstringfalsenoneForceSubjectIdentifier forces the "pairwise" user ID of the end-user that authenticated. The "pairwise" user ID refers to the (Pairwise Identifier Algorithm)[http://openid.net/specs/openid-connect-core-1_0.html#PairwiseAlg] of the OpenID Connect specification. It allows you to set an obfuscated subject ("user") identifier that is unique to the client. Please note that this changes the user ID on endpoint /userinfo and sub claim of the ID Token. It does not change the sub claim in the OAuth 2.0 Introspection. Per default, ORY Hydra handles this value with its own algorithm. In case you want to set this yourself you can use this field. Please note that setting this field has no effect if pairwise is not configured in ORY Hydra or the OAuth 2.0 Client does not expect a pairwise identifier (set via subject_type key in the client's configuration). Please also be aware that ORY Hydra is unable to properly compute this value during authentication. This implies that you have to compute this value on every authentication process (probably depending on the client ID or some other unique value). If you fail to compute the proper value, then authentication processes which have id_token_hint set might fail.
rememberbooleanfalsenoneRemember, if set to true, tells ORY Hydra to remember this user by telling the user agent (browser) to store a cookie with authentication data. If the same user performs another OAuth 2.0 Authorization Request, he/she will not be asked to log in again.
remember_forinteger(int64)falsenoneRememberFor sets how long the authentication should be remembered for in seconds. If set to 0, the authorization will be remembered for the duration of the browser session (using a session cookie).
subjectstringtruenoneSubject is the user ID of the end-user that authenticated.
completedRequest#### completedRequest
{
"redirect_to": "string"
}

The response payload sent when accepting or rejecting a login or consent request.

Properties

NameTypeRequiredRestrictionsDescription
redirect_tostringfalsenoneRedirectURL is the URL which you should redirect the user to once the authentication process is completed.
consentRequest#### consentRequest
{
"acr": "string",
"challenge": "string",
"client": {
"allowed_cors_origins": [
"string"
],
"audience": [
"string"
],
"backchannel_logout_session_required": true,
"backchannel_logout_uri": "string",
"client_id": "string",
"client_name": "string",
"client_secret": "string",
"client_secret_expires_at": 0,
"client_uri": "string",
"contacts": [
"string"
],
"created_at": "2020-06-23T09:16:53Z",
"frontchannel_logout_session_required": true,
"frontchannel_logout_uri": "string",
"grant_types": [
"string"
],
"jwks": {},
"jwks_uri": "string",
"logo_uri": "string",
"metadata": {},
"owner": "string",
"policy_uri": "string",
"post_logout_redirect_uris": [
"string"
],
"redirect_uris": [
"string"
],
"request_object_signing_alg": "string",
"request_uris": [
"string"
],
"response_types": [
"string"
],
"scope": "string",
"sector_identifier_uri": "string",
"subject_type": "string",
"token_endpoint_auth_method": "string",
"token_endpoint_auth_signing_alg": "string",
"tos_uri": "string",
"updated_at": "2020-06-23T09:16:53Z",
"userinfo_signed_response_alg": "string"
},
"context": {},
"login_challenge": "string",
"login_session_id": "string",
"oidc_context": {
"acr_values": [
"string"
],
"display": "string",
"id_token_hint_claims": {},
"login_hint": "string",
"ui_locales": [
"string"
]
},
"request_url": "string",
"requested_access_token_audience": [
"string"
],
"requested_scope": [
"string"
],
"skip": true,
"subject": "string"
}

Contains information on an ongoing consent request.

Properties

NameTypeRequiredRestrictionsDescription
acrstringfalsenoneACR represents the Authentication AuthorizationContext Class Reference value for this authentication session. You can use it to express that, for example, a user authenticated using two factor authentication.
challengestringfalsenoneChallenge is the identifier ("authorization challenge") of the consent authorization request. It is used to identify the session.
clientoAuth2Clientfalsenonenone
contextJSONRawMessagefalsenonenone
login_challengestringfalsenoneLoginChallenge is the login challenge this consent challenge belongs to. It can be used to associate a login and consent request in the login & consent app.
login_session_idstringfalsenoneLoginSessionID is the login session ID. If the user-agent reuses a login session (via cookie / remember flag) this ID will remain the same. If the user-agent did not have an existing authentication session (e.g. remember is false) this will be a new random value. This value is used as the "sid" parameter in the ID Token and in OIDC Front-/Back- channel logout. It's value can generally be used to associate consecutive login requests by a certain user.
oidc_contextopenIDConnectContextfalsenonenone
request_urlstringfalsenoneRequestURL is the original OAuth 2.0 Authorization URL requested by the OAuth 2.0 client. It is the URL which initiates the OAuth 2.0 Authorization Code or OAuth 2.0 Implicit flow. This URL is typically not needed, but might come in handy if you want to deal with additional request parameters.
requested_access_token_audienceStringSlicePipeDelimiterfalsenonenone
requested_scopeStringSlicePipeDelimiterfalsenonenone
skipbooleanfalsenoneSkip, if true, implies that the client has requested the same scopes from the same user previously. If true, you must not ask the user to grant the requested scopes. You must however either allow or deny the consent request using the usual API call.
subjectstringfalsenoneSubject is the user ID of the end-user that authenticated. Now, that end user needs to grant or deny the scope requested by the OAuth 2.0 client.
consentRequestSession#### consentRequestSession
{
"access_token": {},
"id_token": {}
}

Used to pass session data to a consent request.

Properties

NameTypeRequiredRestrictionsDescription
access_tokenobjectfalsenoneAccessToken sets session data for the access and refresh token, as well as any future tokens issued by the refresh grant. Keep in mind that this data will be available to anyone performing OAuth 2.0 Challenge Introspection. If only your services can perform OAuth 2.0 Challenge Introspection, this is usually fine. But if third parties can access that endpoint as well, sensitive data from the session might be exposed to them. Use with care!
id_tokenobjectfalsenoneIDToken sets session data for the OpenID Connect ID token. Keep in mind that the session'id payloads are readable by anyone that has access to the ID Challenge. Use with care!
flushInactiveOAuth2TokensRequest#### flushInactiveOAuth2TokensRequest
{
"notAfter": "2020-06-23T09:16:53Z"
}

Properties

NameTypeRequiredRestrictionsDescription
notAfterstring(date-time)falsenoneNotAfter sets after which point tokens should not be flushed. This is useful when you want to keep a history of recently issued tokens for auditing.
genericError#### genericError
{
"debug": "The database adapter was unable to find the element",
"error": "The requested resource could not be found",
"error_description": "Object with ID 12345 does not exist",
"status_code": 404
}

Error response

Properties

NameTypeRequiredRestrictionsDescription
debugstringfalsenoneDebug contains debug information. This is usually not available and has to be enabled.
errorstringtruenoneName is the error name.
error_descriptionstringfalsenoneDescription contains further information on the nature of the error.
status_codeinteger(int64)falsenoneCode represents the error status code (404, 403, 401, ...).
healthNotReadyStatus#### healthNotReadyStatus
{
"errors": {
"property1": "string",
"property2": "string"
}
}

Properties

NameTypeRequiredRestrictionsDescription
errorsobjectfalsenoneErrors contains a list of errors that caused the not ready status.
» additionalPropertiesstringfalsenonenone
healthStatus#### healthStatus
{
"status": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
statusstringfalsenoneStatus always contains "ok".
jsonWebKeySetGeneratorRequest#### jsonWebKeySetGeneratorRequest
{
"alg": "string",
"kid": "string",
"use": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
algstringtruenoneThe algorithm to be used for creating the key. Supports "RS256", "ES512", "HS512", and "HS256"
kidstringtruenoneThe kid of the key to be created
usestringtruenoneThe "use" (public key use) parameter identifies the intended use of the public key. The "use" parameter is employed to indicate whether a public key is used for encrypting data or verifying the signature on data. Valid values are "enc" and "sig".
loginRequest#### loginRequest
{
"challenge": "string",
"client": {
"allowed_cors_origins": [
"string"
],
"audience": [
"string"
],
"backchannel_logout_session_required": true,
"backchannel_logout_uri": "string",
"client_id": "string",
"client_name": "string",
"client_secret": "string",
"client_secret_expires_at": 0,
"client_uri": "string",
"contacts": [
"string"
],
"created_at": "2020-06-23T09:16:53Z",
"frontchannel_logout_session_required": true,
"frontchannel_logout_uri": "string",
"grant_types": [
"string"
],
"jwks": {},
"jwks_uri": "string",
"logo_uri": "string",
"metadata": {},
"owner": "string",
"policy_uri": "string",
"post_logout_redirect_uris": [
"string"
],
"redirect_uris": [
"string"
],
"request_object_signing_alg": "string",
"request_uris": [
"string"
],
"response_types": [
"string"
],
"scope": "string",
"sector_identifier_uri": "string",
"subject_type": "string",
"token_endpoint_auth_method": "string",
"token_endpoint_auth_signing_alg": "string",
"tos_uri": "string",
"updated_at": "2020-06-23T09:16:53Z",
"userinfo_signed_response_alg": "string"
},
"oidc_context": {
"acr_values": [
"string"
],
"display": "string",
"id_token_hint_claims": {},
"login_hint": "string",
"ui_locales": [
"string"
]
},
"request_url": "string",
"requested_access_token_audience": [
"string"
],
"requested_scope": [
"string"
],
"session_id": "string",
"skip": true,
"subject": "string"
}

Contains information on an ongoing login request.

Properties

NameTypeRequiredRestrictionsDescription
challengestringfalsenoneChallenge is the identifier ("login challenge") of the login request. It is used to identify the session.
clientoAuth2Clientfalsenonenone
oidc_contextopenIDConnectContextfalsenonenone
request_urlstringfalsenoneRequestURL is the original OAuth 2.0 Authorization URL requested by the OAuth 2.0 client. It is the URL which initiates the OAuth 2.0 Authorization Code or OAuth 2.0 Implicit flow. This URL is typically not needed, but might come in handy if you want to deal with additional request parameters.
requested_access_token_audienceStringSlicePipeDelimiterfalsenonenone
requested_scopeStringSlicePipeDelimiterfalsenonenone
session_idstringfalsenoneSessionID is the login session ID. If the user-agent reuses a login session (via cookie / remember flag) this ID will remain the same. If the user-agent did not have an existing authentication session (e.g. remember is false) this will be a new random value. This value is used as the "sid" parameter in the ID Token and in OIDC Front-/Back- channel logout. It's value can generally be used to associate consecutive login requests by a certain user.
skipbooleanfalsenoneSkip, if true, implies that the client has requested the same scopes from the same user previously. If true, you can skip asking the user to grant the requested scopes, and simply forward the user to the redirect URL. This feature allows you to update / set session information.
subjectstringfalsenoneSubject is the user ID of the end-user that authenticated. Now, that end user needs to grant or deny the scope requested by the OAuth 2.0 client. If this value is set and skip is true, you MUST include this subject type when accepting the login request, or the request will fail.
logoutRequest#### logoutRequest
{
"request_url": "string",
"rp_initiated": true,
"sid": "string",
"subject": "string"
}

Contains information about an ongoing logout request.

Properties

NameTypeRequiredRestrictionsDescription
request_urlstringfalsenoneRequestURL is the original Logout URL requested.
rp_initiatedbooleanfalsenoneRPInitiated is set to true if the request was initiated by a Relying Party (RP), also known as an OAuth 2.0 Client.
sidstringfalsenoneSessionID is the login session ID that was requested to log out.
subjectstringfalsenoneSubject is the user for whom the logout was request.
oAuth2Client#### oAuth2Client
{
"allowed_cors_origins": [
"string"
],
"audience": [
"string"
],
"backchannel_logout_session_required": true,
"backchannel_logout_uri": "string",
"client_id": "string",
"client_name": "string",
"client_secret": "string",
"client_secret_expires_at": 0,
"client_uri": "string",
"contacts": [
"string"
],
"created_at": "2020-06-23T09:16:53Z",
"frontchannel_logout_session_required": true,
"frontchannel_logout_uri": "string",
"grant_types": [
"string"
],
"jwks": {},
"jwks_uri": "string",
"logo_uri": "string",
"metadata": {},
"owner": "string",
"policy_uri": "string",
"post_logout_redirect_uris": [
"string"
],
"redirect_uris": [
"string"
],
"request_object_signing_alg": "string",
"request_uris": [
"string"
],
"response_types": [
"string"
],
"scope": "string",
"sector_identifier_uri": "string",
"subject_type": "string",
"token_endpoint_auth_method": "string",
"token_endpoint_auth_signing_alg": "string",
"tos_uri": "string",
"updated_at": "2020-06-23T09:16:53Z",
"userinfo_signed_response_alg": "string"
}

Client represents an OAuth 2.0 Client.

Properties

NameTypeRequiredRestrictionsDescription
allowed_cors_originsStringSlicePipeDelimiterfalsenonenone
audienceStringSlicePipeDelimiterfalsenonenone
backchannel_logout_session_requiredbooleanfalsenoneBoolean value specifying whether the RP requires that a sid (session ID) Claim be included in the Logout Token to identify the RP session with the OP when the backchannel_logout_uri is used. If omitted, the default value is false.
backchannel_logout_uristringfalsenoneRP URL that will cause the RP to log itself out when sent a Logout Token by the OP.
client_idstringfalsenoneID is the id for this client.
client_namestringfalsenoneName is the human-readable string name of the client to be presented to the end-user during authorization.
client_secretstringfalsenoneSecret is the client's secret. The secret will be included in the create request as cleartext, and then never again. The secret is stored using BCrypt so it is impossible to recover it. Tell your users that they need to write the secret down as it will not be made available again.
client_secret_expires_atinteger(int64)falsenoneSecretExpiresAt is an integer holding the time at which the client secret will expire or 0 if it will not expire. The time is represented as the number of seconds from 1970-01-01T00:00:00Z as measured in UTC until the date/time of expiration. This feature is currently not supported and it's value will always be set to 0.
client_uristringfalsenoneClientURI is an URL string of a web page providing information about the client. If present, the server SHOULD display this URL to the end-user in a clickable fashion.
contactsStringSlicePipeDelimiterfalsenonenone
created_atstring(date-time)falsenoneCreatedAt returns the timestamp of the client's creation.
frontchannel_logout_session_requiredbooleanfalsenoneBoolean value specifying whether the RP requires that iss (issuer) and sid (session ID) query parameters be included to identify the RP session with the OP when the frontchannel_logout_uri is used. If omitted, the default value is false.
frontchannel_logout_uristringfalsenoneRP URL that will cause the RP to log itself out when rendered in an iframe by the OP. An iss (issuer) query parameter and a sid (session ID) query parameter MAY be included by the OP to enable the RP to validate the request and to determine which of the potentially multiple sessions is to be logged out; if either is included, both MUST be.
grant_typesStringSlicePipeDelimiterfalsenonenone
jwksJoseJSONWebKeySetfalsenonenone
jwks_uristringfalsenoneURL for the Client's JSON Web Key Set [JWK] document. If the Client signs requests to the Server, it contains the signing key(s) the Server uses to validate signatures from the Client. The JWK Set MAY also contain the Client's encryption keys(s), which are used by the Server to encrypt responses to the Client. When both signing and encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced JWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both signatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used to provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST match those in the certificate.
logo_uristringfalsenoneLogoURI is an URL string that references a logo for the client.
metadataJSONRawMessagefalsenonenone
ownerstringfalsenoneOwner is a string identifying the owner of the OAuth 2.0 Client.
policy_uristringfalsenonePolicyURI is a URL string that points to a human-readable privacy policy document that describes how the deployment organization collects, uses, retains, and discloses personal data.
post_logout_redirect_urisStringSlicePipeDelimiterfalsenonenone
redirect_urisStringSlicePipeDelimiterfalsenonenone
request_object_signing_algstringfalsenoneJWS [JWS] alg algorithm [JWA] that MUST be used for signing Request Objects sent to the OP. All Request Objects from this Client MUST be rejected, if not signed with this algorithm.
request_urisStringSlicePipeDelimiterfalsenonenone
response_typesStringSlicePipeDelimiterfalsenonenone
scopestringfalsenoneScope is a string containing a space-separated list of scope values (as described in Section 3.3 of OAuth 2.0 [RFC6749]) that the client can use when requesting access tokens.
sector_identifier_uristringfalsenoneURL using the https scheme to be used in calculating Pseudonymous Identifiers by the OP. The URL references a file with a single JSON array of redirect_uri values.
subject_typestringfalsenoneSubjectType requested for responses to this Client. The subject_types_supported Discovery parameter contains a list of the supported subject_type values for this server. Valid types include pairwise and public.
token_endpoint_auth_methodstringfalsenoneRequested Client Authentication method for the Token Endpoint. The options are client_secret_post, client_secret_basic, private_key_jwt, and none.
token_endpoint_auth_signing_algstringfalsenoneRequested Client Authentication signing algorithm for the Token Endpoint.
tos_uristringfalsenoneTermsOfServiceURI is a URL string that points to a human-readable terms of service document for the client that describes a contractual relationship between the end-user and the client that the end-user accepts when authorizing the client.
updated_atstring(date-time)falsenoneUpdatedAt returns the timestamp of the last update.
userinfo_signed_response_algstringfalsenoneJWS alg algorithm [JWA] REQUIRED for signing UserInfo Responses. If this is specified, the response will be JWT [JWT] serialized, and signed using JWS. The default, if omitted, is for the UserInfo Response to return the Claims as a UTF-8 encoded JSON object using the application/json content-type.
oAuth2TokenIntrospection#### oAuth2TokenIntrospection
{
"active": true,
"aud": [
"string"
],
"client_id": "string",
"exp": 0,
"ext": {},
"iat": 0,
"iss": "string",
"nbf": 0,
"obfuscated_subject": "string",
"scope": "string",
"sub": "string",
"token_type": "string",
"username": "string"
}

Introspection contains an access token's session data as specified by IETF RFC 7662, see:

Properties

NameTypeRequiredRestrictionsDescription
activebooleantruenoneActive is a boolean indicator of whether or not the presented token is currently active. The specifics of a token's "active" state will vary depending on the implementation of the authorization server and the information it keeps about its tokens, but a "true" value return for the "active" property will generally indicate that a given token has been issued by this authorization server, has not been revoked by the resource owner, and is within its given time window of validity (e.g., after its issuance time and before its expiration time).
aud[string]falsenoneAudience contains a list of the token's intended audiences.
client_idstringfalsenoneID is aclient identifier for the OAuth 2.0 client that requested this token.
expinteger(int64)falsenoneExpires at is an integer timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token will expire.
extobjectfalsenoneExtra is arbitrary data set by the session.
iatinteger(int64)falsenoneIssued at is an integer timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token was originally issued.
issstringfalsenoneIssuerURL is a string representing the issuer of this token
nbfinteger(int64)falsenoneNotBefore is an integer timestamp, measured in the number of seconds since January 1 1970 UTC, indicating when this token is not to be used before.
obfuscated_subjectstringfalsenoneObfuscatedSubject is set when the subject identifier algorithm was set to "pairwise" during authorization. It is the sub value of the ID Token that was issued.
scopestringfalsenoneScope is a JSON string containing a space-separated list of scopes associated with this token.
substringfalsenoneSubject of the token, as defined in JWT [RFC7519]. Usually a machine-readable identifier of the resource owner who authorized this token.
token_typestringfalsenoneTokenType is the introspected token's type, for example access_token or refresh_token.
usernamestringfalsenoneUsername is a human-readable identifier for the resource owner who authorized this token.
oauth2TokenResponse#### oauth2TokenResponse
{
"access_token": "string",
"expires_in": 0,
"id_token": "string",
"refresh_token": "string",
"scope": "string",
"token_type": "string"
}

The Access Token Response

Properties

NameTypeRequiredRestrictionsDescription
access_tokenstringfalsenonenone
expires_ininteger(int64)falsenonenone
id_tokenstringfalsenonenone
refresh_tokenstringfalsenonenone
scopestringfalsenonenone
token_typestringfalsenonenone
openIDConnectContext#### openIDConnectContext
{
"acr_values": [
"string"
],
"display": "string",
"id_token_hint_claims": {},
"login_hint": "string",
"ui_locales": [
"string"
]
}

Contains optional information about the OpenID Connect request.

Properties

NameTypeRequiredRestrictionsDescription
acr_values[string]falsenoneACRValues is the Authentication AuthorizationContext Class Reference requested in the OAuth 2.0 Authorization request. It is a parameter defined by OpenID Connect and expresses which level of authentication (e.g. 2FA) is required. OpenID Connect defines it as follows: > Requested Authentication AuthorizationContext Class Reference values. Space-separated string that specifies the acr values that the Authorization Server is being requested to use for processing this Authentication Request, with the values appearing in order of preference. The Authentication AuthorizationContext Class satisfied by the authentication performed is returned as the acr Claim Value, as specified in Section 2. The acr Claim is requested as a Voluntary Claim by this parameter.
displaystringfalsenoneDisplay is a string value that specifies how the Authorization Server displays the authentication and consent user interface pages to the End-User. The defined values are: page: The Authorization Server SHOULD display the authentication and consent UI consistent with a full User Agent page view. If the display parameter is not specified, this is the default display mode. popup: The Authorization Server SHOULD display the authentication and consent UI consistent with a popup User Agent window. The popup User Agent window should be of an appropriate size for a login-focused dialog and should not obscure the entire window that it is popping up over. touch: The Authorization Server SHOULD display the authentication and consent UI consistent with a device that leverages a touch interface. wap: The Authorization Server SHOULD display the authentication and consent UI consistent with a "feature phone" type display. The Authorization Server MAY also attempt to detect the capabilities of the User Agent and present an appropriate display.
id_token_hint_claimsobjectfalsenoneIDTokenHintClaims are the claims of the ID Token previously issued by the Authorization Server being passed as a hint about the End-User's current or past authenticated session with the Client.
login_hintstringfalsenoneLoginHint hints about the login identifier the End-User might use to log in (if necessary). This hint can be used by an RP if it first asks the End-User for their e-mail address (or other identifier) and then wants to pass that value as a hint to the discovered authorization service. This value MAY also be a phone number in the format specified for the phone_number Claim. The use of this parameter is optional.
ui_locales[string]falsenoneUILocales is the End-User'id preferred languages and scripts for the user interface, represented as a space-separated list of BCP47 [RFC5646] language tag values, ordered by preference. For instance, the value "fr-CA fr en" represents a preference for French as spoken in Canada, then French (without a region designation), followed by English (without a region designation). An error SHOULD NOT result if some or all of the requested locales are not supported by the OpenID Provider.
rejectRequest#### rejectRequest
{
"error": "string",
"error_debug": "string",
"error_description": "string",
"error_hint": "string",
"status_code": 0
}

The request payload used to accept a login or consent request.

Properties

NameTypeRequiredRestrictionsDescription
errorstringfalsenonenone
error_debugstringfalsenonenone
error_descriptionstringfalsenonenone
error_hintstringfalsenonenone
status_codeinteger(int64)falsenonenone
userinfoResponse#### userinfoResponse
{
"birthdate": "string",
"email": "string",
"email_verified": true,
"family_name": "string",
"gender": "string",
"given_name": "string",
"locale": "string",
"middle_name": "string",
"name": "string",
"nickname": "string",
"phone_number": "string",
"phone_number_verified": true,
"picture": "string",
"preferred_username": "string",
"profile": "string",
"sub": "string",
"updated_at": 0,
"website": "string",
"zoneinfo": "string"
}

The userinfo response

Properties

NameTypeRequiredRestrictionsDescription
birthdatestringfalsenoneEnd-User's birthday, represented as an ISO 8601:2004 [ISO8601‑2004] YYYY-MM-DD format. The year MAY be 0000, indicating that it is omitted. To represent only the year, YYYY format is allowed. Note that depending on the underlying platform's date related function, providing just year can result in varying month and day, so the implementers need to take this factor into account to correctly process the dates.
emailstringfalsenoneEnd-User's preferred e-mail address. Its value MUST conform to the RFC 5322 [RFC5322] addr-spec syntax. The RP MUST NOT rely upon this value being unique, as discussed in Section 5.7.
email_verifiedbooleanfalsenoneTrue if the End-User's e-mail address has been verified; otherwise false. When this Claim Value is true, this means that the OP took affirmative steps to ensure that this e-mail address was controlled by the End-User at the time the verification was performed. The means by which an e-mail address is verified is context-specific, and dependent upon the trust framework or contractual agreements within which the parties are operating.
family_namestringfalsenoneSurname(s) or last name(s) of the End-User. Note that in some cultures, people can have multiple family names or no family name; all can be present, with the names being separated by space characters.
genderstringfalsenoneEnd-User's gender. Values defined by this specification are female and male. Other values MAY be used when neither of the defined values are applicable.
given_namestringfalsenoneGiven name(s) or first name(s) of the End-User. Note that in some cultures, people can have multiple given names; all can be present, with the names being separated by space characters.
localestringfalsenoneEnd-User's locale, represented as a BCP47 [RFC5646] language tag. This is typically an ISO 639-1 Alpha-2 [ISO639‑1] language code in lowercase and an ISO 3166-1 Alpha-2 [ISO3166‑1] country code in uppercase, separated by a dash. For example, en-US or fr-CA. As a compatibility note, some implementations have used an underscore as the separator rather than a dash, for example, en_US; Relying Parties MAY choose to accept this locale syntax as well.
middle_namestringfalsenoneMiddle name(s) of the End-User. Note that in some cultures, people can have multiple middle names; all can be present, with the names being separated by space characters. Also note that in some cultures, middle names are not used.
namestringfalsenoneEnd-User's full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User's locale and preferences.
nicknamestringfalsenoneCasual name of the End-User that may or may not be the same as the given_name. For instance, a nickname value of Mike might be returned alongside a given_name value of Michael.
phone_numberstringfalsenoneEnd-User's preferred telephone number. E.164 [E.164] is RECOMMENDED as the format of this Claim, for example, +1 (425) 555-1212 or +56 (2) 687 2400. If the phone number contains an extension, it is RECOMMENDED that the extension be represented using the RFC 3966 [RFC3966] extension syntax, for example, +1 (604) 555-1234;ext=5678.
phone_number_verifiedbooleanfalsenoneTrue if the End-User's phone number has been verified; otherwise false. When this Claim Value is true, this means that the OP took affirmative steps to ensure that this phone number was controlled by the End-User at the time the verification was performed. The means by which a phone number is verified is context-specific, and dependent upon the trust framework or contractual agreements within which the parties are operating. When true, the phone_number Claim MUST be in E.164 format and any extensions MUST be represented in RFC 3966 format.
picturestringfalsenoneURL of the End-User's profile picture. This URL MUST refer to an image file (for example, a PNG, JPEG, or GIF image file), rather than to a Web page containing an image. Note that this URL SHOULD specifically reference a profile photo of the End-User suitable for displaying when describing the End-User, rather than an arbitrary photo taken by the End-User.
preferred_usernamestringfalsenoneNon-unique shorthand name by which the End-User wishes to be referred to at the RP, such as janedoe or j.doe. This value MAY be any valid JSON string including special characters such as @, /, or whitespace.
profilestringfalsenoneURL of the End-User's profile page. The contents of this Web page SHOULD be about the End-User.
substringfalsenoneSubject - Identifier for the End-User at the IssuerURL.
updated_atinteger(int64)falsenoneTime the End-User's information was last updated. Its value is a JSON number representing the number of seconds from 1970-01-01T0:0:0Z as measured in UTC until the date/time.
websitestringfalsenoneURL of the End-User's Web page or blog. This Web page SHOULD contain information published by the End-User or an organization that the End-User is affiliated with.
zoneinfostringfalsenoneString from zoneinfo [zoneinfo] time zone database representing the End-User's time zone. For example, Europe/Paris or America/Los_Angeles.
version#### version
{
"version": "string"
}

Properties

NameTypeRequiredRestrictionsDescription
versionstringfalsenoneVersion is the service's version.
wellKnown#### wellKnown
{
"authorization_endpoint": "https://playground.ory.sh/ory-hydra/public/oauth2/auth",
"backchannel_logout_session_supported": true,
"backchannel_logout_supported": true,
"claims_parameter_supported": true,
"claims_supported": [
"string"
],
"end_session_endpoint": "string",
"frontchannel_logout_session_supported": true,
"frontchannel_logout_supported": true,
"grant_types_supported": [
"string"
],
"id_token_signing_alg_values_supported": [
"string"
],
"issuer": "https://playground.ory.sh/ory-hydra/public/",
"jwks_uri": "https://playground.ory.sh/ory-hydra/public/.well-known/jwks.json",
"registration_endpoint": "https://playground.ory.sh/ory-hydra/admin/client",
"request_parameter_supported": true,
"request_uri_parameter_supported": true,
"require_request_uri_registration": true,
"response_modes_supported": [
"string"
],
"response_types_supported": [
"string"
],
"revocation_endpoint": "string",
"scopes_supported": [
"string"
],
"subject_types_supported": [
"string"
],
"token_endpoint": "https://playground.ory.sh/ory-hydra/public/oauth2/token",
"token_endpoint_auth_methods_supported": [
"string"
],
"userinfo_endpoint": "string",
"userinfo_signing_alg_values_supported": [
"string"
]
}

WellKnown represents important OpenID Connect discovery metadata

Properties

NameTypeRequiredRestrictionsDescription
authorization_endpointstringtruenoneURL of the OP's OAuth 2.0 Authorization Endpoint.
backchannel_logout_session_supportedbooleanfalsenoneBoolean value specifying whether the OP can pass a sid (session ID) Claim in the Logout Token to identify the RP session with the OP. If supported, the sid Claim is also included in ID Tokens issued by the OP
backchannel_logout_supportedbooleanfalsenoneBoolean value specifying whether the OP supports back-channel logout, with true indicating support.
claims_parameter_supportedbooleanfalsenoneBoolean value specifying whether the OP supports use of the claims parameter, with true indicating support.
claims_supported[string]falsenoneJSON array containing a list of the Claim Names of the Claims that the OpenID Provider MAY be able to supply values for. Note that for privacy or other reasons, this might not be an exhaustive list.
end_session_endpointstringfalsenoneURL at the OP to which an RP can perform a redirect to request that the End-User be logged out at the OP.
frontchannel_logout_session_supportedbooleanfalsenoneBoolean value specifying whether the OP can pass iss (issuer) and sid (session ID) query parameters to identify the RP session with the OP when the frontchannel_logout_uri is used. If supported, the sid Claim is also included in ID Tokens issued by the OP.
frontchannel_logout_supportedbooleanfalsenoneBoolean value specifying whether the OP supports HTTP-based logout, with true indicating support.
grant_types_supported[string]falsenoneJSON array containing a list of the OAuth 2.0 Grant Type values that this OP supports.
id_token_signing_alg_values_supported[string]truenoneJSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for the ID Token to encode the Claims in a JWT.
issuerstringtruenoneURL using the https scheme with no query or fragment component that the OP asserts as its IssuerURL Identifier. If IssuerURL discovery is supported , this value MUST be identical to the issuer value returned by WebFinger. This also MUST be identical to the iss Claim value in ID Tokens issued from this IssuerURL.
jwks_uristringtruenoneURL of the OP's JSON Web Key Set [JWK] document. This contains the signing key(s) the RP uses to validate signatures from the OP. The JWK Set MAY also contain the Server's encryption key(s), which are used by RPs to encrypt requests to the Server. When both signing and encryption keys are made available, a use (Key Use) parameter value is REQUIRED for all keys in the referenced JWK Set to indicate each key's intended usage. Although some algorithms allow the same key to be used for both signatures and encryption, doing so is NOT RECOMMENDED, as it is less secure. The JWK x5c parameter MAY be used to provide X.509 representations of keys provided. When used, the bare key values MUST still be present and MUST match those in the certificate.
registration_endpointstringfalsenoneURL of the OP's Dynamic Client Registration Endpoint.
request_parameter_supportedbooleanfalsenoneBoolean value specifying whether the OP supports use of the request parameter, with true indicating support.
request_uri_parameter_supportedbooleanfalsenoneBoolean value specifying whether the OP supports use of the request_uri parameter, with true indicating support.
require_request_uri_registrationbooleanfalsenoneBoolean value specifying whether the OP requires any request_uri values used to be pre-registered using the request_uris registration parameter.
response_modes_supported[string]falsenoneJSON array containing a list of the OAuth 2.0 response_mode values that this OP supports.
response_types_supported[string]truenoneJSON array containing a list of the OAuth 2.0 response_type values that this OP supports. Dynamic OpenID Providers MUST support the code, id_token, and the token id_token Response Type values.
revocation_endpointstringfalsenoneURL of the authorization server's OAuth 2.0 revocation endpoint.
scopes_supported[string]falsenoneSON array containing a list of the OAuth 2.0 [RFC6749] scope values that this server supports. The server MUST support the openid scope value. Servers MAY choose not to advertise some supported scope values even when this parameter is used
subject_types_supported[string]truenoneJSON array containing a list of the Subject Identifier types that this OP supports. Valid types include pairwise and public.
token_endpointstringtruenoneURL of the OP's OAuth 2.0 Token Endpoint
token_endpoint_auth_methods_supported[string]falsenoneJSON array containing a list of Client Authentication methods supported by this Token Endpoint. The options are client_secret_post, client_secret_basic, client_secret_jwt, and private_key_jwt, as described in Section 9 of OpenID Connect Core 1.0
userinfo_endpointstringfalsenoneURL of the OP's UserInfo Endpoint.
userinfo_signing_alg_values_supported[string]falsenoneJSON array containing a list of the JWS [JWS] signing algorithms (alg values) [JWA] supported by the UserInfo Endpoint to encode the Claims in a JWT [JWT].
Last updated on by aeneasr