Skip to content
Authrim

Compare settings versions

GET
/api/admin/settings/{category}/compare
Code sample: Shell / cURL 
curl --request GET \
  --url 'https://auth.example.com/api/admin/settings/example/compare?from=1&to=1' \
  --header 'Authorization: Bearer <token>'

Compares two persisted settings-history snapshots for a category. Both from and to query parameters are required positive version numbers.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
category
required
string

Query Parameters

Section titled “Query Parameters ”
from
required
integer
>= 1

Source settings history version.

to
required
integer
>= 1

Target settings history version.

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Settings version comparison response.

Media type application/json
object
category
required
string
from
required
object
version
required
integer
createdAt
required
integer format: int64
key
additional properties
to
required
object
version
required
integer
createdAt
required
integer format: int64
key
additional properties
diff
required
object
key
additional properties
key
additional properties
Example 
{
  "category": "oauth",
  "from": {
    "version": 10,
    "createdAt": 1770000000000
  },
  "to": {
    "version": 12,
    "createdAt": 1770003600000
  },
  "diff": {
    "require_pkce": {
      "from": false,
      "to": true
    }
  }
}

400

Section titled “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

Section titled “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

Section titled “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"
}

404

Section titled “404 ”

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

Section titled “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"
}