Update assurance level settings

PUT

/api/admin/settings/assurance-levels

Code sample: Shell / cURL

curl --request PUT \
  --url https://auth.example.com/api/admin/settings/assurance-levels \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "enabled": true, "defaultAAL": "AAL1", "defaultFAL": "FAL1", "defaultIAL": "IAL1", "scopeAALRequirements": { "admin": "AAL2" }, "includeInIdToken": true }'

Merges NIST assurance-level settings into SETTINGS after validating AAL/FAL/IAL values and per-scope AAL requirements.

Authorizations

• adminBearer
• adminSessionCookie

Request Body ^required

Assurance level configuration patch.

Media type application/json

object

enabled

boolean

defaultAAL

string

Allowed values: AAL1 AAL2 AAL3

defaultFAL

string

Allowed values: FAL1 FAL2 FAL3

defaultIAL

string

Allowed values: IAL1 IAL2 IAL3

scopeAALRequirements

object

key

additional properties

string

Allowed values: AAL1 AAL2 AAL3

includeInIdToken

boolean

includeInAccessToken

boolean

fal2RequiresDPoP

boolean

fal3RequiresPAR

boolean

key

additional properties

Example

{
  "enabled": true,
  "defaultAAL": "AAL1",
  "defaultFAL": "FAL1",
  "defaultIAL": "IAL1",
  "scopeAALRequirements": {
    "admin": "AAL2"
  },
  "includeInIdToken": true
}

Responses

200

Successful JSON response.

Media type application/json

object

settings

object

key

additional properties

object

value

Resolved value for the setting.

source

Configuration source for this value.

string

default

Default value used when no override exists.

description

string

validValues

Array

key

additional properties

note

string

key

additional properties

Example

{
  "settings": {
    "enabled": {
      "value": true,
      "source": "kv",
      "default": false,
      "description": "Enable NIST SP 800-63-4 assurance level tracking"
    },
    "defaultAAL": {
      "value": "AAL1",
      "source": "default",
      "default": "AAL1",
      "validValues": [
        "AAL1",
        "AAL2",
        "AAL3"
      ]
    }
  },
  "note": "NIST SP 800-63-4 defines AAL (Authentication), FAL (Federation), and IAL (Identity) assurance levels."
}

400

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

401

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

500

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}