コンテンツにスキップ
Authrim

Update Native SSO settings

PUT
/api/admin/settings/native-sso
Code sample: Shell / cURL 
curl --request PUT \
  --url https://auth.example.com/api/admin/settings/native-sso \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "enabled": true, "deviceSecretTTLDays": 30, "maxDeviceSecretsPerUser": 5, "maxUseCountPerSecret": 10, "maxSecretsBehavior": "reject_new", "allowCrossClientNativeSSO": false, "rateLimit": { "maxAttemptsPerMinute": 10, "blockDurationMinutes": 15 } }'

Updates AUTHRIM_CONFIG config:native-sso overrides after validating TTL, count, behavior, and rate-limit bounds.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
enabled
boolean
deviceSecretTTLDays
integer
maxDeviceSecretsPerUser
integer
maxUseCountPerSecret
integer
maxSecretsBehavior
string
allowCrossClientNativeSSO
boolean
rateLimit

Native SSO rate limit settings.

object
key
additional properties
key
additional properties
Example 
{
  "enabled": true,
  "deviceSecretTTLDays": 30,
  "maxDeviceSecretsPerUser": 5,
  "maxUseCountPerSecret": 10,
  "maxSecretsBehavior": "reject_new",
  "allowCrossClientNativeSSO": false,
  "rateLimit": {
    "maxAttemptsPerMinute": 10,
    "blockDurationMinutes": 15
  }
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Native SSO settings mutation result.

Media type application/json
object
success
boolean
settings

Resolved Native SSO settings.

object
key
additional properties
sources

Setting sources; present after clearing overrides.

object
key
additional properties
note
string
key
additional properties
Example 
{
  "success": true,
  "settings": {
    "enabled": true,
    "deviceSecretTTLDays": 30,
    "maxDeviceSecretsPerUser": 5,
    "maxUseCountPerSecret": 10,
    "maxSecretsBehavior": "reject_new",
    "allowCrossClientNativeSSO": false,
    "rateLimit": {
      "maxAttemptsPerMinute": 10,
      "blockDurationMinutes": 15
    }
  },
  "sources": {
    "enabled": "kv"
  },
  "note": "Native SSO settings updated successfully."
}

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