Skip to content
Authrim

Read Account Page feature capabilities.

GET
/api/account/capabilities
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/account/capabilities \
  --cookie authrim_session=<authrim_session>

Returns Account Page capabilities together with the published page composition, resolved reusable screens, and theme integration status for the authenticated user.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Account Page feature capabilities response.

Media type application/json
object
capabilities
required
Array<object>
object
id
required
string
status
required
string
Allowed values: available planned
requires_reauth
required
boolean
planned_phase
string
sections
required
Array<object>
object
id
required
string
status
required
string
Allowed values: available planned
capabilities
required
Array<string>
theme
required
object
version
required
integer
scope
required
string
source
required
string
account_page_overrides_supported
required
boolean
planned_tokens
required
Array<string>
account_page
required
object
page_id
string | null
name
string
definition
required
object
schema_version
required
string
Allowed values: authrim.account_page.v1
title
string
description
string
localizations
object
key
additional properties
object
title
string
description
string
screens
required
Array<object>
<= 32 items
object
id
required
string
screen_key
required
string
width
required
string
Allowed values: full half
enabled
required
boolean
condition
required
string
Allowed values: always hidden passkey_enabled totp_enabled external_idp_enabled consent_records_available multiple_sessions
screens
required
Array<object>
object
id
required
string
screen_key
required
string
display_name
required
string
description
string | null
fields
required
Array<object>
object
key
additional properties
localizations
required
object
key
additional properties
version
required
integer
published_at
required
string
Example 
{
  "capabilities": [
    {
      "status": "available"
    }
  ],
  "sections": [
    {
      "status": "available"
    }
  ],
  "account_page": {
    "definition": {
      "schema_version": "authrim.account_page.v1",
      "screens": [
        {
          "width": "full",
          "condition": "always"
        }
      ]
    }
  }
}

401

Section titled “401 ”

Error response.

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

Stable Authrim error category that can be provided to support.

string
/^AR[0-9]{6}$/
error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

500

Section titled “500 ”

Error response.

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

Stable Authrim error category that can be provided to support.

string
/^AR[0-9]{6}$/
error_id

Opaque occurrence identifier that can be provided to support for correlation.

string format: uuid
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example",
  "error_code": "example",
  "error_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}