Get a pending CIBA request.

GET

/api/ciba/requests/{auth_req_id}

Code sample: Shell / cURL

curl --request GET \
  --url https://auth.example.com/api/ciba/requests/example \
  --cookie authrim_session=<authrim_session>

Authorizations

• userSessionCookie

Parameters

Path Parameters

auth_req_id

required

string

Responses

200

Successful JSON response.

Media type application/json

object

auth_req_id

required

string

client

required

object

client_id

string

client_name

string

logo_uri

string | null

is_trusted

boolean

scope

required

string

binding_message

string | null

user_code

string | null

created_at

required

integer

expires_at

required

integer

time_remaining

required

integer

status

required

string

Example

{
  "auth_req_id": "auth_req_123",
  "client": {
    "client_id": "client_123",
    "client_name": "Example App",
    "logo_uri": "https://example.com/logo.png",
    "is_trusted": false
  },
  "scope": "openid profile email",
  "binding_message": "Approve sign-in",
  "user_code": "123456",
  "created_at": 1770000000000,
  "expires_at": 1770000300000,
  "time_remaining": 240,
  "status": "pending"
}

401

An authenticated end-user session is required.

Media type application/json

object

error

required

string

error_description

required

string

key

additional properties

Example

{
  "error": "login_required",
  "error_description": "Authentication is required"
}

403

The authenticated user does not own the CIBA request.

Media type application/json

object

error

required

string

error_description

required

string

key

additional properties

Example

{
  "error": "access_denied",
  "error_description": "Insufficient permissions"
}