ORory
oAuth2

List OAuth 2.0 Consent Sessions of a Subject

Changed on

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.

get/admin/oauth2/auth/sessions/consent

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /admin/oauth2/auth/sessions/consent
  • Auth
    none declared

Query parameters

page_sizeinteger

Items per Page

This is the number of items per page to return. For details on pagination please head over to the pagination documentation.

page_tokenstring

Next Page Token

The next page token. For details on pagination please head over to the pagination documentation.

subjectstring required

The subject to list the consent sessions for.

login_session_idstring

The login session id to list the consent sessions for.

Response

oAuth2ConsentSessions

consent_request_idstring

ConsentRequestID is the identifier of the consent request that initiated this consent session.

contextJSONRawMessage
grant_access_token_audiencestring[]

Audience Granted

GrantedAudience sets the audience the user authorized the client to use. Should be a subset of requested_access_token_audience.

grant_scopestring[]

Scope Granted

GrantScope sets the scope the user authorized the client to use. Should be a subset of requested_scope.

handled_atstring date-time
rememberboolean

Remember Consent

Remember, 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

Remember Consent For

RememberFor sets how long the consent authorization should be remembered for in seconds. If set to 0, the authorization will be remembered indefinitely.

Example response

[
  {
    "consent_request": {
      "client": {
        "scope": "scope1 scope-2 scope.3 scope:4"
      }
    }
  }
]

Changes