Preview the import of the older settings stores

GET

/api/admin/platform/settings/legacy-import

Code sample: Shell / cURL

curl --request GET \
  --url https://auth.example.com/api/admin/platform/settings/legacy-import \
  --header 'Authorization: Bearer <token>'

Platform admins only. Reports the state of the one-time import of the older settings stores (AUTHRIM_CONFIG oauth:config, error and rate-limit values; SETTINGS system_settings, tenant certification profiles, logout, JIT and policy flag documents) into the Settings API, and what a run would write now (a preview: nothing is written; it covers the platform and the first tenants, truncated when there are more).

Authorizations

• adminBearer
• adminSessionCookie

Responses

200

What the import of the older settings stores did, or would do.

Media type application/json

object

status

required

string

Allowed values: dry_run already_completed in_progress needs_attention completed

truncated

A preview that stopped before the last tenant.

boolean

state

required

Any of:

object

object

status

required

string

Allowed values: in_progress needs_attention completed

stage

required

string

Allowed values: platform tenants

cursor

required

Any of:

string

string

null

null

applied

required

integer

kept

required

integer

rejectedCount

required

integer

rejected

required

The first refused values, for review.

Array<object>

object

scope

required

string

Allowed values: platform tenant

scopeId

required

Any of:

string

string

null

null

category

required

string

key

required

string

reason

required

string

acceptedRejections

boolean

actor

required

string

startedAt

required

string format: date-time

updatedAt

required

string format: date-time

completedAt

string format: date-time

contract

The version of the stores and mappings the run imported (absent: 1). A completed run of an earlier version runs again for what was added since.

integer

null

null

documents

required

Array<object>

object

scope

required

string

Allowed values: platform tenant

scopeId

required

Any of:

string

string

null

null

category

required

string

sources

required

Array<string>

applied

required

Array<string>

kept

required

Keys already set through the Settings API at this scope, kept as they are.

Array<string>

rejected

required

Keys not written, with the reason.

object

key

additional properties

string

Example

{
  "status": "dry_run",
  "state": null,
  "documents": [
    {
      "scope": "platform",
      "scopeId": null,
      "category": "oauth",
      "sources": [
        "AUTHRIM_CONFIG oauth:config:*"
      ],
      "applied": [
        "oauth.auth_code_ttl"
      ],
      "kept": [
        "oauth.access_token_expiry"
      ],
      "rejected": {}
    }
  ]
}

Headers

X-Authrim-Log-Consistency

string

Allowed values: snapshot eventual local_hot_only

Snapshot for the remote scheduled view; eventual when Pipeline visibility can lag ingestion; local_hot_only for local scheduled staging without a remote Catalog.

X-Authrim-Log-Pending-Deliveries

integer

Tenant deliveries not yet confirmed visible. Omitted for self-service subjects. Zero does not guarantee immediate Pipeline visibility.

X-Authrim-Log-Complete

boolean

True only for a complete bounded snapshot query. Pipeline responses remain false; incomplete reads return 503.

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

503

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