Update IP extraction security settings

PUT

/api/admin/settings/ip-security

Code sample: Shell / cURL

curl --request PUT \
  --url https://auth.example.com/api/admin/settings/ip-security \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "cloudProvider": "cloudflare" }'

Stores the cloud provider override in AUTHRIM_CONFIG KV and clears the provider cache immediately.

Authorizations

• adminBearer
• adminSessionCookie

Request Body ^required

Media type application/json

object

cloudProvider

string

Allowed values: cloudflare aws azure gcp none

key

additional properties

Example

{
  "cloudProvider": "cloudflare"
}

Responses

200

IP extraction security settings mutation result.

Media type application/json

object

success

boolean

settings

Resolved IP security settings.

object

key

additional properties

sources

Resolved setting sources.

object

key

additional properties

providerInfo

Selected provider metadata.

object

key

additional properties

note

string

warning

string

key

additional properties

Example

{
  "success": true,
  "settings": {
    "cloudProvider": "cloudflare"
  },
  "sources": {
    "cloudProvider": "kv"
  },
  "providerInfo": {
    "name": "Cloudflare",
    "ipExtraction": "cf-connecting-ip"
  },
  "note": "Cloud provider set to \"cloudflare\". IP extraction method: cf-connecting-ip"
}

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

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

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

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