Skip to content
Authrim

Update PII partition settings

PUT
/api/admin/settings/pii-partitions
Code sample: Shell / cURL 
curl --request PUT \
  --url https://auth.example.com/api/admin/settings/pii-partitions \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "defaultPartition": "default", "ipRoutingEnabled": false, "tenantPartitions": { "tenant_123": "eu" }, "partitionRules": [ { "name": "eu-residence", "priority": 10, "partition": "eu", "conditions": { "country": [ "DE", "FR" ] } } ] }'

Updates tenant-scoped PII partition settings after validating referenced partitions and unique rule names.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
defaultPartition
string
ipRoutingEnabled
boolean
tenantPartitions
object
key
additional properties
string
partitionRules
Array<object>
object
name
string
partition
string
priority
integer
conditions

Partition routing rule conditions.

object
key
additional properties
key
additional properties
key
additional properties
Example 
{
  "defaultPartition": "default",
  "ipRoutingEnabled": false,
  "tenantPartitions": {
    "tenant_123": "eu"
  },
  "partitionRules": [
    {
      "name": "eu-residence",
      "priority": 10,
      "partition": "eu",
      "conditions": {
        "country": [
          "DE",
          "FR"
        ]
      }
    }
  ]
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

PII partition configuration updated.

Media type application/json
object
success
boolean
defaultPartition
string
ipRoutingEnabled
boolean
availablePartitions
Array<string>
tenantPartitions
object
key
additional properties
string
partitionRulesCount
integer
updatedAt
integer
key
additional properties
Example 
{
  "success": true,
  "defaultPartition": "default",
  "ipRoutingEnabled": false,
  "availablePartitions": [
    "default",
    "eu",
    "us"
  ],
  "tenantPartitions": {
    "tenant_123": "eu"
  },
  "partitionRulesCount": 1,
  "updatedAt": 1770000000000
}

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