Skip to content
Authrim

Get PII partition settings

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

Returns tenant-scoped PII partition routing configuration and available partition keys.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

PII partition configuration.

Media type application/json
object
defaultPartition
string
ipRoutingEnabled
boolean
availablePartitions
Array<string>
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
updatedAt
integer
updatedBy
string
note
string
key
additional properties
Example 
{
  "defaultPartition": "default",
  "ipRoutingEnabled": false,
  "availablePartitions": [
    "default",
    "eu",
    "us"
  ],
  "tenantPartitions": {
    "tenant_123": "eu"
  },
  "partitionRules": [
    {
      "name": "eu-residence",
      "priority": 10,
      "partition": "eu",
      "conditions": {
        "country": [
          "DE",
          "FR"
        ]
      }
    }
  ],
  "updatedAt": 1770000000000,
  "updatedBy": "admin-api",
  "note": "IP routing is low trust and should only be used as fallback. Prefer tenant policies or user-declared residence."
}

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