Skip to content
Authrim

Submit the Login UI's consent decision (JSON consent API).

POST
/auth/consent
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/auth/consent \
  --header 'Content-Type: application/json' \
  --data '{ "consent_item_versions": { "additionalProperty": { "version_id": "example", "content_hash": "example" } } }'

Accepts a JSON body only and returns the authorization continuation as redirect_url. Managed browser challenges require the authenticated session bound at authorization time. Acting-as requests require the feature to be enabled and a current delegated relationship. Approvals with statement items must send consent_item_versions, keyed by statement ID, containing version_id and content_hash for every displayed item, including optional items. Changed or missing snapshots return 409 document_changed. Use refresh_consent or the replacement consent_challenge_id in error_details to display updated documents; expired requests require a fresh authorization. Omitted optional decisions continue to mean withdrawal/refusal.

Request Body required

Section titled “Request Body required ”
Media type application/json
object
consent_item_versions

Required for every displayed statement item when approving.

object
key
additional properties
object
version_id
required
string
content_hash
required
string | null
key
additional properties
Example generated
{
  "consent_item_versions": {
    "additionalProperty": {
      "version_id": "example",
      "content_hash": "example"
    }
  }
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful JSON response.

Media type application/json
object
key
additional properties
Example generated
{
  "additionalProperty": "example"
}

400

Section titled “400 ”

Error response.

Media type application/json
object
error
string
error_description
string
message
string
webauthn_signal

Optional browser-side WebAuthn Signal API hint. When unknown_credential is true, clients that just received a WebAuthn credential assertion may call PublicKeyCredential.signalUnknownCredential() for that credential ID.

object
unknown_credential
boolean
key
additional properties
Example generated
{
  "error": "example",
  "error_description": "example",
  "message": "example",
  "webauthn_signal": {
    "unknown_credential": true
  }
}

401

Section titled “401 ”

Error response.

Media type application/json
object
error
string
error_description
string
message
string
webauthn_signal

Optional browser-side WebAuthn Signal API hint. When unknown_credential is true, clients that just received a WebAuthn credential assertion may call PublicKeyCredential.signalUnknownCredential() for that credential ID.

object
unknown_credential
boolean
key
additional properties
Example generated
{
  "error": "example",
  "error_description": "example",
  "message": "example",
  "webauthn_signal": {
    "unknown_credential": true
  }
}

403

Section titled “403 ”

Error response.

Media type application/json
object
error
string
error_description
string
message
string
webauthn_signal

Optional browser-side WebAuthn Signal API hint. When unknown_credential is true, clients that just received a WebAuthn credential assertion may call PublicKeyCredential.signalUnknownCredential() for that credential ID.

object
unknown_credential
boolean
key
additional properties
Example generated
{
  "error": "example",
  "error_description": "example",
  "message": "example",
  "webauthn_signal": {
    "unknown_credential": true
  }
}

409

Section titled “409 ”

Document_changed; obtain a fresh consent screen before submitting again.

Media type application/json
object
error
string
error_description
string
message
string
webauthn_signal

Optional browser-side WebAuthn Signal API hint. When unknown_credential is true, clients that just received a WebAuthn credential assertion may call PublicKeyCredential.signalUnknownCredential() for that credential ID.

object
unknown_credential
boolean
key
additional properties
Example generated
{
  "error": "example",
  "error_description": "example",
  "message": "example",
  "webauthn_signal": {
    "unknown_credential": true
  }
}

503

Section titled “503 ”

Statement consent atomic writes are unavailable on the configured backend.

Media type application/json
object
error
string
error_description
string
message
string
webauthn_signal

Optional browser-side WebAuthn Signal API hint. When unknown_credential is true, clients that just received a WebAuthn credential assertion may call PublicKeyCredential.signalUnknownCredential() for that credential ID.

object
unknown_credential
boolean
key
additional properties
Example generated
{
  "error": "example",
  "error_description": "example",
  "message": "example",
  "webauthn_signal": {
    "unknown_credential": true
  }
}