openapi: 3.0.3 info: contact: email: hi@ory.sh description: 'Documentation for all of Ory Hydra''s APIs. ' license: name: Apache 2.0 title: Ory Hydra api oidc API version: '' tags: - description: OpenID Connect name: oidc paths: /.well-known/openid-configuration: get: description: 'A mechanism for an OpenID Connect Relying Party to discover the End-User''s OpenID Provider and obtain information needed to interact with it, including its OAuth 2.0 endpoint locations. 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/' operationId: discoverOidcConfiguration responses: '200': content: application/json: schema: $ref: '#/components/schemas/oidcConfiguration' description: oidcConfiguration default: content: application/json: schema: $ref: '#/components/schemas/errorOAuth2' description: errorOAuth2 summary: OpenID Connect Discovery tags: - oidc x-ory-ratelimit-bucket: hydra-public-high /credentials: post: description: 'This endpoint creates a verifiable credential that attests that the user authenticated with the provided access token owns a certain public/private key pair. More information can be found at https://openid.net/specs/openid-connect-userinfo-vc-1_0.html.' operationId: createVerifiableCredential requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateVerifiableCredentialRequestBody' x-originalParamName: Body responses: '200': content: application/json: schema: $ref: '#/components/schemas/verifiableCredentialResponse' description: verifiableCredentialResponse '400': content: application/json: schema: $ref: '#/components/schemas/verifiableCredentialPrimingResponse' description: verifiableCredentialPrimingResponse default: content: application/json: schema: $ref: '#/components/schemas/errorOAuth2' description: errorOAuth2 summary: Issues a Verifiable Credential tags: - oidc x-ory-ratelimit-bucket: hydra-admin-medium /oauth2/register: post: description: 'This endpoint behaves like the administrative counterpart (`createOAuth2Client`) but is capable of facing the public internet directly and can be used in self-service. It implements the OpenID Connect Dynamic Client Registration Protocol. This feature needs to be enabled in the configuration. This endpoint is disabled by default. It can be enabled by an administrator. Please note that using this endpoint you are not able to choose the `client_secret` nor the `client_id` as those values will be server generated when specifying `token_endpoint_auth_method` as `client_secret_basic` or `client_secret_post`. The `client_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 somewhere safe.' operationId: createOidcDynamicClient requestBody: content: application/json: schema: $ref: '#/components/schemas/oAuth2Client' description: Dynamic Client Registration Request Body required: true x-originalParamName: Body responses: '201': content: application/json: schema: $ref: '#/components/schemas/oAuth2Client' description: oAuth2Client '400': $ref: '#/components/responses/errorOAuth2BadRequest' default: $ref: '#/components/responses/errorOAuth2Default' summary: Register OAuth2 Client using OpenID Dynamic Client Registration tags: - oidc x-ory-ratelimit-bucket: hydra-public-low /oauth2/register/{id}: delete: description: 'This endpoint behaves like the administrative counterpart (`deleteOAuth2Client`) but is capable of facing the public internet directly and can be used in self-service. It implements the OpenID Connect Dynamic Client Registration Protocol. This feature needs to be enabled in the configuration. This endpoint is disabled by default. It can be enabled by an administrator. To use this endpoint, you will need to present the client''s authentication credentials. If the OAuth2 Client uses the Token Endpoint Authentication Method `client_secret_post`, you need to present the client secret in the URL query. If it uses `client_secret_basic`, present the Client ID and the Client Secret in the Authorization header. 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.' operationId: deleteOidcDynamicClient parameters: - description: The id of the OAuth 2.0 Client. in: path name: id required: true schema: type: string responses: '204': $ref: '#/components/responses/emptyResponse' default: content: application/json: schema: $ref: '#/components/schemas/genericError' description: genericError security: - bearer: [] summary: Delete OAuth 2.0 Client using the OpenID Dynamic Client Registration Management Protocol tags: - oidc x-ory-ratelimit-bucket: hydra-public-low get: description: 'This endpoint behaves like the administrative counterpart (`getOAuth2Client`) but is capable of facing the public internet directly and can be used in self-service. It implements the OpenID Connect Dynamic Client Registration Protocol. To use this endpoint, you will need to present the client''s authentication credentials. If the OAuth2 Client uses the Token Endpoint Authentication Method `client_secret_post`, you need to present the client secret in the URL query. If it uses `client_secret_basic`, present the Client ID and the Client Secret in the Authorization header.' operationId: getOidcDynamicClient parameters: - description: The id of the OAuth 2.0 Client. in: path name: id required: true schema: type: string responses: '200': content: application/json: schema: $ref: '#/components/schemas/oAuth2Client' description: oAuth2Client default: $ref: '#/components/responses/errorOAuth2Default' security: - bearer: [] summary: Get OAuth2 Client using OpenID Dynamic Client Registration tags: - oidc x-ory-ratelimit-bucket: hydra-admin-high put: description: 'This endpoint behaves like the administrative counterpart (`setOAuth2Client`) but is capable of facing the public internet directly to be used by third parties. It implements the OpenID Connect Dynamic Client Registration Protocol. This feature is disabled per default. It can be enabled by a system administrator. If you pass `client_secret` the secret is used, otherwise the existing secret is used. If set, the secret is echoed in the response. It is not possible to retrieve it later on. To use this endpoint, you will need to present the client''s authentication credentials. If the OAuth2 Client uses the Token Endpoint Authentication Method `client_secret_post`, you need to present the client secret in the URL query. If it uses `client_secret_basic`, present the Client ID and the Client Secret in the Authorization header. 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.' operationId: setOidcDynamicClient parameters: - description: OAuth 2.0 Client ID in: path name: id required: true schema: type: string requestBody: content: application/json: schema: $ref: '#/components/schemas/oAuth2Client' description: OAuth 2.0 Client Request Body required: true x-originalParamName: Body responses: '200': content: application/json: schema: $ref: '#/components/schemas/oAuth2Client' description: oAuth2Client '404': $ref: '#/components/responses/errorOAuth2NotFound' default: $ref: '#/components/responses/errorOAuth2Default' security: - bearer: [] summary: Set OAuth2 Client using OpenID Dynamic Client Registration tags: - oidc x-ory-ratelimit-bucket: hydra-public-low /oauth2/sessions/logout: get: description: 'This endpoint initiates and completes user logout at the Ory OAuth2 & OpenID provider 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 Back-channel logout is performed asynchronously and does not affect logout flow.' operationId: revokeOidcSession responses: '302': $ref: '#/components/responses/emptyResponse' summary: OpenID Connect Front- and Back-channel Enabled Logout tags: - oidc x-ory-ratelimit-bucket: hydra-public-medium /userinfo: get: description: 'This endpoint returns the payload of the ID Token, including `session.id_token` values, of the provided OAuth 2.0 Access Token''s consent request. In the case of authentication error, a WWW-Authenticate header might be set in the response with more information about the error. See [the spec](https://datatracker.ietf.org/doc/html/rfc6750#section-3) for more details about header format.' operationId: getOidcUserInfo responses: '200': content: application/json: schema: $ref: '#/components/schemas/oidcUserInfo' description: oidcUserInfo default: content: application/json: schema: $ref: '#/components/schemas/errorOAuth2' description: errorOAuth2 security: - oauth2: [] summary: OpenID Connect Userinfo tags: - oidc x-ory-ratelimit-bucket: hydra-public-medium components: schemas: oidcUserInfo: description: OpenID Connect Userinfo properties: birthdate: description: End-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. type: string email: description: End-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. type: string email_verified: description: True 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. type: boolean family_name: description: Surname(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. type: string gender: description: End-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. type: string given_name: description: Given 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. type: string locale: description: End-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. type: string middle_name: description: Middle 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. type: string name: description: End-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. type: string nickname: description: Casual 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. type: string phone_number: description: End-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. type: string phone_number_verified: description: True 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. type: boolean picture: description: URL 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. type: string preferred_username: description: Non-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. type: string profile: description: URL of the End-User's profile page. The contents of this Web page SHOULD be about the End-User. type: string sub: description: Subject - Identifier for the End-User at the IssuerURL. type: string updated_at: description: Time 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. format: int64 type: integer website: description: URL 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. type: string zoneinfo: description: String from zoneinfo [zoneinfo] time zone database representing the End-User's time zone. For example, Europe/Paris or America/Los_Angeles. type: string type: object oAuth2Client: description: '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.' properties: access_token_strategy: description: 'OAuth 2.0 Access Token Strategy AccessTokenStrategy is the strategy used to generate access tokens. Valid options are `jwt` and `opaque`. `jwt` is a bad idea, see https://www.ory.com/docs/oauth2-oidc/jwt-access-token Setting the strategy here overrides the global setting in `strategies.access_token`.' type: string allowed_cors_origins: description: 'OAuth 2.0 Client Allowed CORS Origins One or more URLs (scheme://host[:port]) which are allowed to make CORS requests to the /oauth/token endpoint. If this array is empty, the server''s CORS origin configuration (`CORS_ALLOWED_ORIGINS`) will be used instead. If this array is set, the allowed origins are appended to the server''s CORS origin configuration. Be aware that environment variable `CORS_ENABLED` MUST be set to `true` for this to work.' items: type: string type: array audience: description: 'OAuth 2.0 Client Audience An allow-list defining the audiences this client is allowed to request tokens for. An audience limits the applicability of an OAuth 2.0 Access Token to, for example, certain API endpoints. The value is a list of URLs. URLs MUST NOT contain whitespaces.' example: https://mydomain.com/api/users, https://mydomain.com/api/posts items: type: string type: array authorization_code_grant_access_token_lifespan: $ref: '#/components/schemas/NullDuration' authorization_code_grant_id_token_lifespan: $ref: '#/components/schemas/NullDuration' authorization_code_grant_refresh_token_lifespan: $ref: '#/components/schemas/NullDuration' backchannel_logout_session_required: description: 'OpenID Connect Back-Channel Logout Session Required Boolean 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.' type: boolean backchannel_logout_uri: description: 'OpenID Connect Back-Channel Logout URI RP URL that will cause the RP to log itself out when sent a Logout Token by the OP.' type: string client_credentials_grant_access_token_lifespan: $ref: '#/components/schemas/NullDuration' client_id: description: 'OAuth 2.0 Client ID The ID is immutable. If no ID is provided, a UUID4 will be generated.' type: string client_name: description: 'OAuth 2.0 Client Name The human-readable name of the client to be presented to the end-user during authorization.' type: string client_secret: description: 'OAuth 2.0 Client Secret The secret will be included in the create request as cleartext, and then never again. The secret is kept in hashed format and is not recoverable once lost.' type: string client_secret_expires_at: description: 'OAuth 2.0 Client Secret Expires At The field is currently not supported and its value is always 0.' format: int64 type: integer client_uri: description: 'OAuth 2.0 Client URI ClientURI is a 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.' type: string contacts: description: 'OAuth 2.0 Client Contact An array of strings representing ways to contact people responsible for this client, typically email addresses.' example: help@example.org items: type: string type: array created_at: description: 'OAuth 2.0 Client Creation Date CreatedAt returns the timestamp of the client''s creation.' format: date-time type: string device_authorization_grant_access_token_lifespan: $ref: '#/components/schemas/NullDuration' device_authorization_grant_id_token_lifespan: $ref: '#/components/schemas/NullDuration' device_authorization_grant_refresh_token_lifespan: $ref: '#/components/schemas/NullDuration' frontchannel_logout_session_required: description: 'OpenID Connect Front-Channel Logout Session Required Boolean 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.' type: boolean frontchannel_logout_uri: description: 'OpenID Connect Front-Channel Logout URI RP 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.' type: string grant_types: description: 'OAuth 2.0 Client Grant Types An array of OAuth 2.0 grant types the client is allowed to use. Can be one of: Client Credentials Grant: `client_credentials` Authorization Code Grant: `authorization_code` OpenID Connect Implicit Grant (deprecated!): `implicit` Refresh Token Grant: `refresh_token` OAuth 2.0 Token Exchange: `urn:ietf:params:oauth:grant-type:jwt-bearer` OAuth 2.0 Device Code Grant: `urn:ietf:params:oauth:grant-type:device_code`' items: type: string type: array implicit_grant_access_token_lifespan: $ref: '#/components/schemas/NullDuration' implicit_grant_id_token_lifespan: $ref: '#/components/schemas/NullDuration' jwks: $ref: '#/components/schemas/jsonWebKeySet' jwks_uri: description: 'OAuth 2.0 Client JSON Web Key Set URL URL 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.' type: string jwt_bearer_grant_access_token_lifespan: $ref: '#/components/schemas/NullDuration' logo_uri: description: 'OAuth 2.0 Client Logo URI A URL string referencing the client''s logo.' type: string metadata: $ref: '#/components/schemas/JSONRawMessage' owner: description: 'OAuth 2.0 Client Owner Owner is a string identifying the owner of the OAuth 2.0 Client.' type: string policy_uri: description: 'OAuth 2.0 Client Policy URI PolicyURI 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.' type: string post_logout_redirect_uris: description: 'Allowed Post-Redirect Logout URIs Array of URLs supplied by the RP to which it MAY request that the End-User''s User Agent be redirected using the post_logout_redirect_uri parameter after a logout has been performed.' items: type: string type: array redirect_uris: description: 'OAuth 2.0 Client Redirect URIs RedirectURIs is an array of allowed redirect urls for the client.' example: http://mydomain/oauth/callback items: type: string type: array refresh_token_grant_access_token_lifespan: $ref: '#/components/schemas/NullDuration' refresh_token_grant_id_token_lifespan: $ref: '#/components/schemas/NullDuration' refresh_token_grant_refresh_token_lifespan: $ref: '#/components/schemas/NullDuration' registration_access_token: description: 'OpenID Connect Dynamic Client Registration Access Token RegistrationAccessToken can be used to update, get, or delete the OAuth2 Client. It is sent when creating a client using Dynamic Client Registration.' type: string registration_client_uri: description: 'OpenID Connect Dynamic Client Registration URL RegistrationClientURI is the URL used to update, get, or delete the OAuth2 Client.' type: string request_object_signing_alg: description: 'OpenID Connect Request Object Signing Algorithm JWS [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.' type: string request_uris: description: 'OpenID Connect Request URIs Array of request_uri values that are pre-registered by the RP for use at the OP. Servers MAY cache the contents of the files referenced by these URIs and not retrieve them at the time they are used in a request. OPs can require that request_uri values used be pre-registered with the require_request_uri_registration discovery parameter.' items: type: string type: array response_types: description: 'OAuth 2.0 Client Response Types An array of the OAuth 2.0 response type strings that the client can use at the authorization endpoint. Can be one of: Needed for OpenID Connect Implicit Grant: Returns ID Token to redirect URI: `id_token` Returns Access token redirect URI: `token` Needed for Authorization Code Grant: `code`' items: type: string type: array scope: description: 'OAuth 2.0 Client Scope Scope 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.' example: scope1 scope-2 scope.3 scope:4 type: string sector_identifier_uri: description: 'OpenID Connect Sector Identifier URI URL 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.' type: string skip_consent: description: 'SkipConsent skips the consent screen for this client. This field can only be set from the admin API.' type: boolean skip_logout_consent: description: 'SkipLogoutConsent skips the logout consent screen for this client. This field can only be set from the admin API.' type: boolean subject_type: description: 'OpenID Connect Subject Type The `subject_types_supported` Discovery parameter contains a list of the supported subject_type values for this server. Valid types include `pairwise` and `public`.' type: string token_endpoint_auth_method: default: client_secret_basic description: 'OAuth 2.0 Token Endpoint Authentication Method Requested Client Authentication method for the Token Endpoint. The options are: `client_secret_basic`: (default) Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` encoded in the HTTP Authorization header. `client_secret_post`: Send `client_id` and `client_secret` as `application/x-www-form-urlencoded` in the HTTP body. `private_key_jwt`: Use JSON Web Tokens to authenticate the client. `none`: Used for public clients (native apps, mobile apps) which can not have secrets.' type: string token_endpoint_auth_signing_alg: description: 'OAuth 2.0 Token Endpoint Signing Algorithm Requested Client Authentication signing algorithm for the Token Endpoint.' type: string tos_uri: description: 'OAuth 2.0 Client Terms of Service URI A URL string pointing 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.' type: string updated_at: description: 'OAuth 2.0 Client Last Update Date UpdatedAt returns the timestamp of the last update.' format: date-time type: string userinfo_signed_response_alg: description: 'OpenID Connect Request Userinfo Signed Response Algorithm JWS 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.' type: string title: OAuth 2.0 Client type: object jsonWebKeySet: description: JSON Web Key Set properties: keys: description: 'List of JSON Web Keys The value of the "keys" parameter is an array of JSON Web Key (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.' items: $ref: '#/components/schemas/jsonWebKey' type: array type: object genericError: properties: code: description: The status code example: 404 format: int64 type: integer debug: description: 'Debug information This field is often not exposed to protect against leaking sensitive information.' example: SQL field "foo" is not a bool. type: string details: description: Further error details id: description: 'The error ID Useful when trying to identify various errors in application logic.' type: string message: description: 'Error message The error''s message.' example: The resource could not be found type: string reason: description: A human-readable reason for the error example: User with ID 1234 does not exist. type: string request: description: 'The request ID The request ID is often exposed internally in order to trace errors across service architectures. This is often a UUID.' example: d7ef54b1-ec15-46e6-bccb-524b82c035e6 type: string status: description: The status description example: Not Found type: string required: - message type: object jsonWebKey: properties: alg: description: 'The "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.' example: RS256 type: string crv: example: P-256 type: string d: example: 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 type: string dp: example: G4sPXkc6Ya9y8oJW9_ILj4xuppu0lzi_H7VTkS8xj5SdX3coE0oimYwxIi2emTAue0UOa5dpgFGyBJ4c8tQ2VF402XRugKDTP8akYhFo5tAA77Qe_NmtuYZc3C3m3I24G2GvR5sSDxUyAN2zq8Lfn9EUms6rY3Ob8YeiKkTiBj0 type: string dq: example: s9lAH9fggBsoFR8Oac2R_E2gw282rT2kGOAhvIllETE1efrA6huUUvMfBcMpn8lqeW6vzznYY5SSQF7pMdC_agI3nG8Ibp1BUb0JUiraRNqUfLhcQb_d9GF4Dh7e74WbRsobRonujTYN1xCaP6TO61jvWrX-L18txXw494Q_cgk type: string e: example: AQAB type: string k: example: GawgguFyGrWKav7AX4VKUg type: string kid: description: 'The "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.' example: 1603dfe0af8f4596 type: string kty: description: 'The "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.' example: RSA type: string n: example: vTqrxUyQPl_20aqf5kXHwDZrel-KovIp8s7ewJod2EXHl8tWlRB3_Rem34KwBfqlKQGp1nqah-51H4Jzruqe0cFP58hPEIt6WqrvnmJCXxnNuIB53iX_uUUXXHDHBeaPCSRoNJzNysjoJ30TIUsKBiirhBa7f235PXbKiHducLevV6PcKxJ5cY8zO286qJLBWSPm-OIevwqsIsSIH44Qtm9sioFikhkbLwoqwWORGAY0nl6XvVOlhADdLjBSqSAeT1FPuCDCnXwzCDR8N9IFB_IjdStFkC-rVt2K5BYfPd0c3yFp_vHR15eRd0zJ8XQ7woBC8Vnsac6Et1pKS59pX6256DPWu8UDdEOolKAPgcd_g2NpA76cAaF_jcT80j9KrEzw8Tv0nJBGesuCjPNjGs_KzdkWTUXt23Hn9QJsdc1MZuaW0iqXBepHYfYoqNelzVte117t4BwVp0kUM6we0IqyXClaZgOI8S-WDBw2_Ovdm8e5NmhYAblEVoygcX8Y46oH6bKiaCQfKCFDMcRgChme7AoE1yZZYsPbaG_3IjPrC4LBMHQw8rM9dWjJ8ImjicvZ1pAm0dx-KHCP3y5PVKrxBDf1zSOsBRkOSjB8TPODnJMz6-jd5hTtZxpZPwPoIdCanTZ3ZD6uRBpTmDwtpRGm63UQs1m5FWPwb0T2IF0 type: string p: example: 6NbkXwDWUhi-eR55Cgbf27FkQDDWIamOaDr0rj1q0f1fFEz1W5A_09YvG09Fiv1AO2-D8Rl8gS1Vkz2i0zCSqnyy8A025XOcRviOMK7nIxE4OH_PEsko8dtIrb3TmE2hUXvCkmzw9EsTF1LQBOGC6iusLTXepIC1x9ukCKFZQvdgtEObQ5kzd9Nhq-cdqmSeMVLoxPLd1blviVT9Vm8-y12CtYpeJHOaIDtVPLlBhJiBoPKWg3vxSm4XxIliNOefqegIlsmTIa3MpS6WWlCK3yHhat0Q-rRxDxdyiVdG_wzJvp0Iw_2wms7pe-PgNPYvUWH9JphWP5K38YqEBiJFXQ type: string q: example: 0A1FmpOWR91_RAWpqreWSavNaZb9nXeKiBo0DQGBz32DbqKqQ8S4aBJmbRhJcctjCLjain-ivut477tAUMmzJwVJDDq2MZFwC9Q-4VYZmFU4HJityQuSzHYe64RjN-E_NQ02TWhG3QGW6roq6c57c99rrUsETwJJiwS8M5p15Miuz53DaOjv-uqqFAFfywN5WkxHbraBcjHtMiQuyQbQqkCFh-oanHkwYNeytsNhTu2mQmwR5DR2roZ2nPiFjC6nsdk-A7E3S3wMzYYFw7jvbWWoYWo9vB40_MY2Y0FYQSqcDzcBIcq_0tnnasf3VW4Fdx6m80RzOb2Fsnln7vKXAQ type: string qi: example: GyM_p6JrXySiz1toFgKbWV-JdI3jQ4ypu9rbMWx3rQJBfmt0FoYzgUIZEVFEcOqwemRN81zoDAaa-Bk0KWNGDjJHZDdDmFhW3AN7lI-puxk_mHZGJ11rxyR8O55XLSe3SPmRfKwZI6yU24ZxvQKFYItdldUKGzO6Ia6zTKhAVRU type: string use: description: 'Use ("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).' example: sig type: string x: example: f83OJ3D2xF1Bg8vub9tLe1gHMzV76e8Tus9uPHvRVEU type: string x5c: description: 'The "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.' items: type: string type: array y: example: x_FEzRu9m36HLN_tue659LNpXW6pCyStikYjKIWI5a0 type: string required: - use - kty - kid - alg type: object NullDuration: description: Specify a time duration in milliseconds, seconds, minutes, hours. pattern: ^([0-9]+(ns|us|ms|s|m|h))*$ title: Time duration type: string credentialSupportedDraft00: description: Includes information about the supported verifiable credentials. properties: cryptographic_binding_methods_supported: description: 'OpenID Connect Verifiable Credentials Cryptographic Binding Methods Supported Contains a list of cryptographic binding methods supported for signing the proof.' items: type: string type: array cryptographic_suites_supported: description: 'OpenID Connect Verifiable Credentials Cryptographic Suites Supported Contains a list of cryptographic suites methods supported for signing the proof.' items: type: string type: array format: description: 'OpenID Connect Verifiable Credentials Format Contains the format that is supported by this authorization server.' type: string types: description: 'OpenID Connect Verifiable Credentials Types Contains the types of verifiable credentials supported.' items: type: string type: array title: Verifiable Credentials Metadata (Draft 00) type: object CreateVerifiableCredentialRequestBody: properties: format: type: string proof: $ref: '#/components/schemas/VerifiableCredentialProof' types: items: type: string type: array title: CreateVerifiableCredentialRequestBody contains the request body to request a verifiable credential. type: object verifiableCredentialResponse: properties: credential_draft_00: type: string format: type: string title: VerifiableCredentialResponse contains the verifiable credential. type: object errorOAuth2: description: Error properties: error: description: Error type: string error_debug: description: 'Error Debug Information Only available in dev mode.' type: string error_description: description: Error Description type: string error_hint: description: 'Error Hint Helps the user identify the error cause.' example: The redirect URL is not allowed. type: string status_code: description: HTTP Status Code example: 401 format: int64 type: integer type: object VerifiableCredentialProof: properties: jwt: type: string proof_type: type: string title: VerifiableCredentialProof contains the proof of a verifiable credential. type: object oidcConfiguration: description: 'Includes links to several endpoints (for example `/oauth2/token`) and exposes information on supported signature algorithms among others.' properties: authorization_endpoint: description: OAuth 2.0 Authorization Endpoint URL example: https://playground.ory.sh/ory-hydra/public/oauth2/auth type: string backchannel_logout_session_supported: description: 'OpenID Connect Back-Channel Logout Session Required Boolean 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' type: boolean backchannel_logout_supported: description: 'OpenID Connect Back-Channel Logout Supported Boolean value specifying whether the OP supports back-channel logout, with true indicating support.' type: boolean claims_parameter_supported: description: 'OpenID Connect Claims Parameter Parameter Supported Boolean value specifying whether the OP supports use of the claims parameter, with true indicating support.' type: boolean claims_supported: description: 'OpenID Connect Supported Claims JSON 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.' items: type: string type: array code_challenge_methods_supported: description: 'OAuth 2.0 PKCE Supported Code Challenge Methods JSON array containing a list of Proof Key for Code Exchange (PKCE) [RFC7636] code challenge methods supported by this authorization server.' items: type: string type: array credentials_endpoint_draft_00: description: 'OpenID Connect Verifiable Credentials Endpoint Contains the URL of the Verifiable Credentials Endpoint.' type: string credentials_supported_draft_00: description: 'OpenID Connect Verifiable Credentials Supported JSON array containing a list of the Verifiable Credentials supported by this authorization server.' items: $ref: '#/components/schemas/credentialSupportedDraft00' type: array device_authorization_endpoint: description: OAuth 2.0 Device Authorization Endpoint URL example: https://playground.ory.sh/ory-hydra/public/oauth2/device/oauth type: string end_session_endpoint: description: 'OpenID Connect End-Session Endpoint URL at the OP to which an RP can perform a redirect to request that the End-User be logged out at the OP.' type: string frontchannel_logout_session_supported: description: 'OpenID Connect Front-Channel Logout Session Required Boolean 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.' type: boolean frontchannel_logout_supported: description: 'OpenID Connect Front-Channel Logout Supported Boolean value specifying whether the OP supports HTTP-based logout, with true indicating support.' type: boolean grant_types_supported: description: 'OAuth 2.0 Supported Grant Types JSON array containing a list of the OAuth 2.0 Grant Type values that this OP supports.' items: type: string type: array id_token_signed_response_alg: description: 'OpenID Connect Default ID Token Signing Algorithms Algorithm used to sign OpenID Connect ID Tokens.' items: type: string type: array id_token_signing_alg_values_supported: description: 'OpenID Connect Supported ID Token Signing Algorithms JSON 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.' items: type: string type: array issuer: description: 'OpenID Connect Issuer URL An URL 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.' example: https://playground.ory.sh/ory-hydra/public/ type: string jwks_uri: description: 'OpenID Connect Well-Known JSON Web Keys URL URL 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.' example: https://{slug}.projects.oryapis.com/.well-known/jwks.json type: string registration_endpoint: description: OpenID Connect Dynamic Client Registration Endpoint URL example: https://playground.ory.sh/ory-hydra/admin/client type: string request_object_signing_alg_values_supported: description: 'OpenID Connect Supported Request Object Signing Algorithms JSON array containing a list of the JWS signing algorithms (alg values) supported by the OP for Request Objects, which are described in Section 6.1 of OpenID Connect Core 1.0 [OpenID.Core]. These algorithms are used both when the Request Object is passed by value (using the request parameter) and when it is passed by reference (using the request_uri parameter).' items: type: string type: array request_parameter_supported: description: 'OpenID Connect Request Parameter Supported Boolean value specifying whether the OP supports use of the request parameter, with true indicating support.' type: boolean request_uri_parameter_supported: description: 'OpenID Connect Request URI Parameter Supported Boolean value specifying whether the OP supports use of the request_uri parameter, with true indicating support.' type: boolean require_request_uri_registration: description: 'OpenID Connect Requires Request URI Registration Boolean value specifying whether the OP requires any request_uri values used to be pre-registered using the request_uris registration parameter.' type: boolean response_modes_supported: description: 'OAuth 2.0 Supported Response Modes JSON array containing a list of the OAuth 2.0 response_mode values that this OP supports.' items: type: string type: array response_types_supported: description: 'OAuth 2.0 Supported Response Types JSON 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.' items: type: string type: array revocation_endpoint: description: 'OAuth 2.0 Token Revocation URL URL of the authorization server''s OAuth 2.0 revocation endpoint.' type: string scopes_supported: description: 'OAuth 2.0 Supported Scope Values JSON 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' items: type: string type: array subject_types_supported: description: 'OpenID Connect Supported Subject Types JSON array containing a list of the Subject Identifier types that this OP supports. Valid types include pairwise and public.' items: type: string type: array token_endpoint: description: OAuth 2.0 Token Endpoint URL example: https://playground.ory.sh/ory-hydra/public/oauth2/token type: string token_endpoint_auth_methods_supported: description: 'OAuth 2.0 Supported Client Authentication Methods JSON 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' items: type: string type: array userinfo_endpoint: description: 'OpenID Connect Userinfo URL URL of the OP''s UserInfo Endpoint.' type: string userinfo_signed_response_alg: description: 'OpenID Connect User Userinfo Signing Algorithm Algorithm used to sign OpenID Connect Userinfo Responses.' items: type: string type: array userinfo_signing_alg_values_supported: description: 'OpenID Connect Supported Userinfo Signing Algorithm JSON 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].' items: type: string type: array required: - issuer - authorization_endpoint - device_authorization_endpoint - token_endpoint - jwks_uri - subject_types_supported - response_types_supported - id_token_signing_alg_values_supported - id_token_signed_response_alg - userinfo_signed_response_alg title: OpenID Connect Discovery Metadata type: object JSONRawMessage: title: JSONRawMessage represents a json.RawMessage that works well with JSON, SQL, and Swagger. verifiableCredentialPrimingResponse: properties: c_nonce: type: string c_nonce_expires_in: format: int64 type: integer error: type: string error_debug: type: string error_description: type: string error_hint: type: string format: type: string status_code: format: int64 type: integer title: VerifiableCredentialPrimingResponse contains the nonce to include in the proof-of-possession JWT. type: object responses: errorOAuth2BadRequest: content: application/json: schema: $ref: '#/components/schemas/errorOAuth2' description: Bad Request Error Response errorOAuth2Default: content: application/json: schema: $ref: '#/components/schemas/errorOAuth2' description: Default Error Response errorOAuth2NotFound: content: application/json: schema: $ref: '#/components/schemas/errorOAuth2' description: Not Found Error Response emptyResponse: description: 'Empty responses are sent when, for example, resources are deleted. The HTTP status code for empty responses is typically 204.' securitySchemes: basic: scheme: basic type: http bearer: scheme: bearer type: http oauth2: flows: authorizationCode: authorizationUrl: https://hydra.demo.ory.sh/oauth2/auth scopes: offline: A scope required when requesting refresh tokens (alias for `offline_access`) offline_access: A scope required when requesting refresh tokens openid: Request an OpenID Connect ID Token tokenUrl: https://hydra.demo.ory.sh/oauth2/token type: oauth2 x-forwarded-proto: string x-request-id: string