Skip to content
Authrim

Update sensitive detail logging policy

PATCH
/api/admin/admin-logging/sensitive-detail-policy
Code sample: Shell / cURL 
curl --request PATCH \
  --url https://auth.example.com/api/admin/admin-logging/sensitive-detail-policy \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "log_type": "admin_audit", "destination_id": "dest_123", "confirmation": "CHANGE SENSITIVE DETAIL admin_audit", "enabled": true }'

Updates the platform sensitive-detail logging destination for a log type after validating destination eligibility and confirmation phrase.

Authorizations

Section titled “Authorizations ”

Request Body required

Section titled “Request Body required ”

JSON request body.

Media type application/json
object
log_type
required
string
destination_id
required
string
confirmation
required
string
enabled
boolean
key
additional properties
Example 
{
  "log_type": "admin_audit",
  "destination_id": "dest_123",
  "confirmation": "CHANGE SENSITIVE DETAIL admin_audit",
  "enabled": true
}

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Successful JSON response.

Media type application/json
object
item
required
object
key
additional properties
audit_id
One of:
string
version
integer
key
additional properties
Example 
{
  "item": {
    "id": "pol_123",
    "tenant_id": "tenant_123",
    "log_type": "security",
    "plane": "control",
    "destination_id": "dest_123",
    "fallback_policy_id": null,
    "enabled": 1,
    "managed_by": "platform",
    "change_protection": "confirm",
    "approval_policy_id": null,
    "policy_hash": "sha256:abc123",
    "version": 1,
    "created_at": 1770000000000,
    "updated_at": 1770000000000
  },
  "audit_id": "audit_123",
  "version": 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"
}