Compare settings history versions

GET

/api/admin/settings/diff

Code sample: Shell / cURL

curl --request GET \
  --url 'https://auth.example.com/api/admin/settings/diff?from_version=1' \
  --header 'Authorization: Bearer <token>'

Compares settings_history rows from from_version to another version or current tenant settings, optionally scoped to one settings category.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Query Parameters

category

string

Optional settings category. Omit to compare all categories.

from_version

required

integer

>= 1

Source settings history version.

to_version

integer

>= 1

Target settings history version. Omit to compare with current settings.

Responses

200

Settings history diff.

Media type application/json

object

tenant_id

string

from_version

integer

to_version

One of:

integer

integer

string

string

Allowed values: current

categories_compared

integer

total_changes

integer

diffs

Array<object>

object

category

string

from_version

integer

to_version

One of:

integer

integer

string

string

Allowed values: current

changes

Array<object>

object

path

string

type

string

Allowed values: added removed changed

old_value

new_value

key

additional properties

key

additional properties

key

additional properties

Example

{
  "tenant_id": "tenant_123",
  "from_version": 3,
  "to_version": "current",
  "categories_compared": 1,
  "total_changes": 1,
  "diffs": [
    {
      "category": "security",
      "from_version": 3,
      "to_version": "current",
      "changes": [
        {
          "path": "security.require_pkce",
          "type": "changed",
          "old_value": false,
          "new_value": true
        }
      ]
    }
  ]
}

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"
}