---
title: "Get OAuth 2.0 Consent Request"
method: GET
path: "/admin/oauth2/auth/requests/consent"
tags: ["oAuth2"]
---

# Get OAuth 2.0 Consent Request

`GET /admin/oauth2/auth/requests/consent`

When an authorization code, hybrid, or implicit OAuth 2.0 Flow is initiated, Ory asks the login provider
to authenticate the subject and then tell Ory 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 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 if the subject accepted
or rejected the request.

The default consent provider is available via the Ory Managed Account Experience. To customize the consent provider, please
head over to the OAuth 2.0 documentation.

## Query parameters

- `consent_challenge` string, required

## Response `200`

oAuth2ConsentRequest

- OAuth2ConsentRequest
  - `acr` string — ACR 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.
  - `amr` string[]
  - `challenge` string, required — Challenge is used to retrieve/accept/deny the consent request.
  - `client` OAuth2Client — 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.
    - `access_token_strategy` string — 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.sh/docs/oauth2-oidc/jwt-access-token Setting the strategy here overrides the global setting in `strategies.access_token`.
    - `allowed_cors_origins` string[]
    - `audience` string[]
    - `authorization_code_grant_access_token_lifespan` string — Specify a time duration in milliseconds, seconds, minutes, hours.
    - `authorization_code_grant_id_token_lifespan` string — Specify a time duration in milliseconds, seconds, minutes, hours.
    - `authorization_code_grant_refresh_token_lifespan` string — Specify a time duration in milliseconds, seconds, minutes, hours.
    - `backchannel_logout_session_required` boolean — 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.
    - `backchannel_logout_uri` string — 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.
    - `client_credentials_grant_access_token_lifespan` string — Specify a time duration in milliseconds, seconds, minutes, hours.
    - `client_id` string — OAuth 2.0 Client ID The ID is immutable. If no ID is provided, a UUID4 will be generated.
    - `client_name` string — OAuth 2.0 Client Name The human-readable name of the client to be presented to the end-user during authorization.
    - `client_secret` string — 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.
    - `client_secret_expires_at` integer — OAuth 2.0 Client Secret Expires At The field is currently not supported and its value is always 0.
    - `client_uri` string — 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.
    - `contacts` string[]
    - `created_at` string, date-time — OAuth 2.0 Client Creation Date CreatedAt returns the timestamp of the client's creation.
    - `device_authorization_grant_access_token_lifespan` string — Specify a time duration in milliseconds, seconds, minutes, hours.
    - `device_authorization_grant_id_token_lifespan` string — Specify a time duration in milliseconds, seconds, minutes, hours.
    - `device_authorization_grant_refresh_token_lifespan` string — Specify a time duration in milliseconds, seconds, minutes, hours.
    - `frontchannel_logout_session_required` boolean — 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.
    - `frontchannel_logout_uri` string — 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.
    - `grant_types` string[]
    - `implicit_grant_access_token_lifespan` string — Specify a time duration in milliseconds, seconds, minutes, hours.
    - `implicit_grant_id_token_lifespan` string — Specify a time duration in milliseconds, seconds, minutes, hours.
    - `jwks` JsonWebKeySet — JSON Web Key Set
      - `keys` JsonWebKey[] — 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.
        - `alg` string, required — 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.
        - `crv` string
        - `d` string
        - `dp` string
        - `dq` string
        - `e` string
        - `k` string
        - `kid` string, required — 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.
        - `kty` string, required — 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.
        - `n` string
        - `p` string
        - `q` string
        - `qi` string
        - `use` string, required — 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).
        - `x` string
        - `x5c` string[] — 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.
        - `y` string
    - `jwks_uri` string — 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.
    - `jwt_bearer_grant_access_token_lifespan` string — Specify a time duration in milliseconds, seconds, minutes, hours.
    - `logo_uri` string — OAuth 2.0 Client Logo URI A URL string referencing the client's logo.
    - `metadata` unknown
    - `owner` string — OAuth 2.0 Client Owner Owner is a string identifying the owner of the OAuth 2.0 Client.
    - `policy_uri` string — 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.
    - `post_logout_redirect_uris` string[]
    - `redirect_uris` string[]
    - `refresh_token_grant_access_token_lifespan` string — Specify a time duration in milliseconds, seconds, minutes, hours.
    - `refresh_token_grant_id_token_lifespan` string — Specify a time duration in milliseconds, seconds, minutes, hours.
    - `refresh_token_grant_refresh_token_lifespan` string — Specify a time duration in milliseconds, seconds, minutes, hours.
    - `registration_access_token` string — 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.
    - `registration_client_uri` string — OpenID Connect Dynamic Client Registration URL RegistrationClientURI is the URL used to update, get, or delete the OAuth2 Client.
    - `request_object_signing_alg` string — 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.
    - `request_uris` string[]
    - `response_types` string[]
    - `scope` string — 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.
    - `sector_identifier_uri` string — 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.
    - `skip_consent` boolean — SkipConsent skips the consent screen for this client. This field can only be set from the admin API.
    - `skip_logout_consent` boolean — SkipLogoutConsent skips the logout consent screen for this client. This field can only be set from the admin API.
    - `subject_type` string — 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`.
    - `token_endpoint_auth_method` string — 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.
    - `token_endpoint_auth_signing_alg` string — OAuth 2.0 Token Endpoint Signing Algorithm Requested Client Authentication signing algorithm for the Token Endpoint.
    - `tos_uri` string — 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.
    - `updated_at` string, date-time — OAuth 2.0 Client Last Update Date UpdatedAt returns the timestamp of the last update.
    - `userinfo_signed_response_alg` string — 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.
  - `consent_request_id` string — ConsentRequestID is the ID of the consent request.
  - `context` unknown
  - `login_challenge` string — LoginChallenge 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_id` string — LoginSessionID 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_context` OAuth2ConsentRequestOpenIDConnectContext
    - `acr_values` string[] — ACRValues 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.
    - `display` string — Display 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_claims` object — IDTokenHintClaims 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_hint` string — LoginHint 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[] — UILocales 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_url` string — RequestURL 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[]
  - `requested_scope` string[]
  - `skip` boolean — Skip, 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.
  - `subject` string — Subject 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.

## Other responses

- `410` — oAuth2RedirectTo
- `default` — errorOAuth2

---

[API](https://skmtc.net/ory/apis/ory-hydra-api.md) · [All operations](https://skmtc.net/ory/apis/ory-hydra-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ory/ory-hydra-api/versions/ab053e716585/schema)