コンテンツにスキップ
Authrim

Test PII partition routing

POST
/api/admin/settings/pii-partitions/test
Code sample: Shell / cURL 
curl --request POST \
  --url https://auth.example.com/api/admin/settings/pii-partitions/test \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "tenantId": "tenant_123", "attributes": { "country": "DE" }, "cfData": { "country": "DE" } }'

Tests partition routing for supplied user attributes and Cloudflare geo data without creating data.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”
Media type application/json
object
tenantId
string
attributes

Hypothetical user attributes.

object
key
additional properties
cfData

Cloudflare geo properties.

object
key
additional properties
key
additional properties
Example 
{
  "tenantId": "tenant_123",
  "attributes": {
    "country": "DE"
  },
  "cfData": {
    "country": "DE"
  }
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

PII partition routing test result.

Media type application/json
object
tenantId
string
attributes

Input attributes used for routing.

object
key
additional properties
cfData

Input Cloudflare geo data.

object
key
additional properties
resolution

Resolved partition and method.

object
key
additional properties
availablePartitions
Array<string>
settings

Subset of active PII partition settings.

object
key
additional properties
key
additional properties
Example 
{
  "tenantId": "tenant_123",
  "attributes": {
    "country": "DE"
  },
  "cfData": {
    "country": "DE"
  },
  "resolution": {
    "partition": "eu",
    "method": "rule",
    "ruleName": "eu-residence"
  },
  "availablePartitions": [
    "default",
    "eu",
    "us"
  ],
  "settings": {
    "defaultPartition": "default",
    "ipRoutingEnabled": false,
    "tenantPartitions": {
      "tenant_123": "eu"
    },
    "partitionRulesCount": 1
  }
}

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