Skip to content
Authrim

Update tenant audit PII configuration

PUT
/api/admin/tenants/{tenantId}/audit/pii-config
Code sample: Shell / cURL 
curl --request PUT \
  --url https://auth.example.com/api/admin/tenants/example/audit/pii-config \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "piiFields": { "email": true, "ipAddress": true }, "eventLogDetailLevel": "standard", "eventLogRetentionDays": 90, "piiLogRetentionDays": 365 }'

Merges and validates tenant audit PII configuration fields before saving to AUTHRIM_CONFIG.

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
tenantId
required
string

Request Body required

Section titled “Request Body required ”

JSON request body.

Media type application/json
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
Example 
{
  "piiFields": {
    "email": true,
    "ipAddress": true
  },
  "eventLogDetailLevel": "standard",
  "eventLogRetentionDays": 90,
  "piiLogRetentionDays": 365
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful JSON response.

Media type application/json
object
success
required
boolean
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
kv_key
required
string
note
required
string
key
additional properties
Example 
{
  "success": true,
  "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
  },
  "kv_key": "pii_config:tenant_123",
  "note": "PII configuration updated. Changes will take effect within 3 minutes (config cache TTL)."
}

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