Skip to content
Authrim

Get external token refresh configuration.

GET
/api/admin/external-token-refresh/config
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/admin/external-token-refresh/config \
  --header 'Authorization: Bearer <token>'

Reads token refresh configuration from the External IdP Bridge. When the bridge is not configured, returns the default configuration and runtime_status: bridge_not_configured.

Authorizations

Section titled “Authorizations ”

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