Get PII encryption status

GET

/api/admin/settings/encryption/status

Code sample: Shell / cURL

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

Returns read-only PII encryption diagnostics derived from environment variables, including algorithm, encrypted fields, key version, warnings, and recommendations.

Authorizations

• adminBearer
• adminSessionCookie

Responses

200

Read-only PII encryption status and diagnostics.

Media type application/json

object

status

string

Allowed values: disabled enabled misconfigured

enabled

boolean

algorithm

string

encryptedFields

Array<string>

keyVersion

string

keyConfigured

boolean

warnings

Array<string>

recommendations

Array<string>

supportedAlgorithms

Array<string>

allEncryptableFields

Array<string>

note

string

key

additional properties

Example

{
  "status": "enabled",
  "enabled": true,
  "algorithm": "AES-256-GCM",
  "encryptedFields": [
    "email",
    "phone_number",
    "name"
  ],
  "keyVersion": 2,
  "keyConfigured": true,
  "warnings": [],
  "recommendations": [],
  "supportedAlgorithms": [
    "AES-256-GCM",
    "AES-256-CBC",
    "NONE"
  ],
  "allEncryptableFields": [
    "email",
    "phone_number",
    "name",
    "address",
    "birthdate"
  ],
  "note": "Encryption settings are controlled via environment variables. Redeploy to change settings."
}

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

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