Skip to content
Authrim

Get global logging settings

GET
/api/admin/settings/logging
Code sample: Shell / cURL 
curl --request GET \
  --url https://auth.example.com/api/admin/settings/logging \
  --header 'Authorization: Bearer <token>'

Returns global log level, log format, and user ID hashing settings with KV/env/default priority metadata.

Authorizations

Section titled “Authorizations ”

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Global logging configuration.

Media type application/json
object
level

Global log level setting state.

object
key
additional properties
format

Log format setting state.

object
key
additional properties
hash_user_id

User ID hashing setting state.

object
key
additional properties
priority
string
cache_ttl_seconds
integer
note
string
key
additional properties
Example 
{
  "level": {
    "current": "info",
    "source": "default",
    "kv_value": null,
    "env_value": null,
    "default": "info",
    "valid_values": [
      "debug",
      "info",
      "warn",
      "error"
    ],
    "kv_key": "log_level",
    "description": {
      "debug": "Verbose output for development (includes all logs)",
      "info": "Standard operation logs (default for production)",
      "warn": "Warnings and errors only",
      "error": "Errors only"
    }
  },
  "format": {
    "current": "json",
    "source": "default",
    "kv_value": null,
    "env_value": null,
    "default": "json",
    "valid_values": [
      "json",
      "pretty"
    ],
    "kv_key": "log_format",
    "description": {
      "json": "Structured JSON logs (recommended for production)",
      "pretty": "Human-readable logs (recommended for development)"
    }
  },
  "hash_user_id": {
    "current": true,
    "source": "default",
    "kv_value": null,
    "env_value": null,
    "default": true,
    "kv_key": "log_hash_user_id",
    "description": "When enabled, user IDs are hashed using HMAC-SHA256 before logging (privacy protection)"
  },
  "priority": "KV > Environment Variables > Default Values",
  "cache_ttl_seconds": 10,
  "note": "Changes take effect within 10 seconds (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"
}

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