コンテンツにスキップ
Authrim

Get tenant audit PII configuration

GET
/api/admin/tenants/{tenantId}/audit/pii-config
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/admin/tenants/example/audit/pii-config \
  --header 'Authorization: Bearer <token>'

Returns the tenant audit PII configuration, defaults, field descriptions, and retention constraints.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
tenantId
required
string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful JSON response.

Media type application/json
object
tenant_id
required
string
config
required
object
piiFields
object
email
boolean
name
boolean
phone
boolean
ipAddress
boolean
userAgent
boolean
deviceFingerprint
boolean
address
boolean
birthdate
boolean
governmentId
boolean
key
additional properties
eventLogDetailLevel
string
Allowed values: minimal standard detailed
eventLogRetentionDays
integer
piiLogRetentionDays
integer
operationalLogRetentionDays
integer
key
additional properties
source
required
string
Allowed values: kv default
defaults
required
object
piiFields
object
email
boolean
name
boolean
phone
boolean
ipAddress
boolean
userAgent
boolean
deviceFingerprint
boolean
address
boolean
birthdate
boolean
governmentId
boolean
key
additional properties
eventLogDetailLevel
string
Allowed values: minimal standard detailed
eventLogRetentionDays
integer
piiLogRetentionDays
integer
operationalLogRetentionDays
integer
key
additional properties
kv_key
required
string
field_descriptions
object
key
additional properties
retention_constraints
object
key
additional properties
gdpr_note
string
key
additional properties
Example 
{
  "tenant_id": "tenant_123",
  "config": {
    "piiFields": {
      "email": true,
      "name": true,
      "phone": true,
      "ipAddress": true,
      "userAgent": true,
      "deviceFingerprint": true,
      "address": true,
      "birthdate": true,
      "governmentId": true
    },
    "eventLogDetailLevel": "standard",
    "eventLogRetentionDays": 90,
    "piiLogRetentionDays": 365
  },
  "source": "kv",
  "defaults": {
    "piiFields": {
      "email": true,
      "name": true,
      "phone": true,
      "ipAddress": true,
      "userAgent": true,
      "deviceFingerprint": true,
      "address": true,
      "birthdate": true,
      "governmentId": true
    },
    "eventLogDetailLevel": "standard",
    "eventLogRetentionDays": 90,
    "piiLogRetentionDays": 365
  },
  "kv_key": "pii_config:tenant_123",
  "field_descriptions": {
    "piiFields": {
      "email": "Email addresses"
    }
  },
  "retention_constraints": {
    "event_log": {
      "min_days": 1,
      "max_days": 730
    }
  },
  "gdpr_note": "Under GDPR, certain data like IP addresses may be considered PII."
}

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