Herald
OpenapiOauth

Probe a pending third-party authorize transaction for the session user.

Returns whether consent is still required (no remembered grant) plus the client app's display fields for the consent UI. Does not consume the one-time state.

GET
/api/oauth/{realmId}/consent

Returns whether consent is still required (no remembered grant) plus the client app's display fields for the consent UI. Does not consume the one-time state.

Path Parameters

realmId*string

Realm ID

Query Parameters

oauth_client_id*string

OAuth Client ID the authorize flow is for

redirect_uri*string

Redirect URI of the pending authorize flow (must match the stored state)

state*string

State token of the pending authorize flow

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/oauth/string/consent?oauth_client_id=string&redirect_uri=string&state=string"
{  "client_app_icon_url": "string",  "client_app_name": "string",  "consent_required": true}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}
{  "code": "string",  "details": null,  "message": "string",  "requestId": "string",  "status": 0}