Skip to main content

ConsentFlow

A flow container for the OAuth2 consent flow

Note: This is a polyfill for the OAuth2 consent flow, which is not yet implemented in the Ory SDK. It tries to mirror the structure of the other flow containers as closely as possible.

Properties​

active​

active: "oauth2_consent"

The active part of the flow, which is always "oauth2_consent" for this flow.


consent_request: OAuth2ConsentRequest

created_at​

created_at: Date

When the flow was created.


expires_at​

expires_at: Date

When the flow expires.


id​

id: "UNSET"

Always "UNSET" as the consent flow does not have a specific ID.


issued_at​

issued_at: Date

When the flow was issued.


return_to?​

optional return_to: string;

session​

session: Session

state​

state: "show_form" | "rejected" | "accepted"

The state of the consent flow.

  • "show_form": The form is being shown to the user.
  • "rejected": The user has rejected the consent request.
  • "accepted": The user has accepted the consent request.

ui​

ui: UiContainer