Get PII partition statistics

GET

/api/admin/settings/pii-partitions/stats

Code sample: Shell / cURL

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

Returns active user counts grouped by PII partition for the current tenant.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Query Parameters

tenant_id

string

Tenant to aggregate. The tenant-scoped endpoint uses the current tenant context.

Responses

200

PII partition user statistics.

Media type application/json

object

total

integer

byPartition

User count by PII partition.

object

key

additional properties

integer

availablePartitions

Array<string>

tenantId

string

note

string

key

additional properties

Example

{
  "total": 42,
  "byPartition": {
    "default": 12,
    "eu": 30,
    "us": 0
  },
  "availablePartitions": [
    "default",
    "eu",
    "us"
  ],
  "tenantId": "tenant_123"
}

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

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

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