features.fapi

This content is for v8.x. Switch to the latest version for up-to-date documentation.

Financial-grade API Security Profile (FAPI)

Enables extra Authorization Server behaviours defined in FAPI that cannot be achieved by other configuration options.

default value:

{
  enabled: false,
  profile: undefined
}

(Click to expand) features.fapi options details

profile

The specific profile of FAPI to enable. Supported values are:

‘2.0’ (Experimental) Enables behaviours from FAPI 2.0 Security Profile - Implementer’s Draft 02
‘1.0 Final’ Enables behaviours from Financial-grade API Security Profile 1.0 - Part 2: Advanced
‘1.0 ID2’ Enables behaviours from Financial-grade API - Part 2: Read and Write API Security Profile - Implementer’s Draft 02
Function returning one of the other supported values, or undefined if FAPI behaviours are to be ignored. The function is invoked with two arguments (ctx, client) and serves the purpose of allowing the used profile to be context-specific.

Versions marked as experimental will follow the specification’s development milestones via MINOR library versions.

default value:

undefined