Skip to content
Authrim

Update external token refresh configuration.

PUT
/api/admin/external-token-refresh/config
Code sample: Shell / cURL 
curl --request PUT \
  --url https://auth.example.com/api/admin/external-token-refresh/config \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "enabled": false, "refreshThresholdSeconds": 3600, "batchSize": 100, "scheduledTenantBatchSize": 100, "piiShardPageSize": 4 }'

Forwards token refresh configuration updates to the External IdP Bridge. If the bridge binding is missing, returns service unavailable.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json

Configuration body forwarded to the External IdP Bridge token refresh endpoint.

object
enabled

Enables proactive scheduled scanning. Exact manual runs remain available.

boolean
refreshThresholdSeconds
integer
>= 1
batchSize
integer
>= 1 <= 1000
scheduledTenantBatchSize
integer
>= 1 <= 100
piiShardPageSize

Maximum PII shards scanned for one tenant in a refresh step.

integer
>= 1 <= 32
key
additional properties
Example 
{
  "enabled": false,
  "refreshThresholdSeconds": 3600,
  "batchSize": 100,
  "scheduledTenantBatchSize": 100,
  "piiShardPageSize": 4
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

External token refresh configuration response.

Media type application/json
object
config
required
object
enabled
required
boolean
refreshThresholdSeconds
required
integer
>= 1
batchSize
required
integer
>= 1 <= 1000
scheduledTenantBatchSize
required
integer
>= 1 <= 100
piiShardPageSize
required
integer
>= 1 <= 32
key
additional properties
runtime_status
string
key
additional properties
Example generated
{
  "config": {
    "enabled": true,
    "refreshThresholdSeconds": 1,
    "batchSize": 1,
    "scheduledTenantBatchSize": 1,
    "piiShardPageSize": 1
  },
  "runtime_status": "example"
}

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

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

503

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