コンテンツにスキップ
Authrim

Run the import of the older settings stores

POST
/api/admin/platform/settings/legacy-import
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/platform/settings/legacy-import \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "dryRun": false }'

Platform admins only. With dryRun: false, runs one bounded step of the import: the values of the older settings stores are written as Settings API values (platform-wide stores as platform values, a tenant’s certification profile as that tenant’s values, a page of tenants at a time), keeping every value already set through the Settings API. It completes when every value was saved; a refused value leaves it needs_attention, which a later run starts over (after the value is corrected) or acceptRejections: true completes as it is. A completed import is not run again. The default is a preview. The scheduler runs a step each minute while it is in progress. The older stores are left in place.

Authorizations

Section titled “Authorizations ”

Request Body

Section titled “Request Body ”
Media type application/json
object
dryRun
boolean
default: true
acceptRejections

Complete an import that needs attention, accepting its refused values.

boolean
key
additional properties
Example 
{
  "dryRun": false
}

Responses

Section titled “ Responses ”

200

Section titled “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
status
required
string
Allowed values: in_progress needs_attention completed
stage
required
string
Allowed values: platform tenants
cursor
required
Any of:
string
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
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
documents
required
Array<object>
object
scope
required
string
Allowed values: platform tenant
scopeId
required
Any of:
string
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

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

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

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

409

Section titled “409 ”

There are no refused values to accept (the import does not need attention), or the import’s state changed meanwhile (another step, restart or acceptance); reload it.

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

Section titled “503 ”

A store or Settings API document could not be read, or a save conflicted; the import keeps the position of the last page it finished. Retry later.

Media type application/json
object
error
string
message
string
error_description
string
key
additional properties
Example generated
{
  "error": "example",
  "message": "example",
  "error_description": "example"
}