GET | Key
  • 1 minute to read
  • Dark
    Light
  • PDF

GET | Key

  • Dark
    Light
  • PDF

Article summary

Gets a list of all authorized encryption keys.

Endpoint

GET /iso/sctm/encryption/key

Expected Response

{
  "code": 200,
  "response": {
    "status": 200,
    "message": "Encryption keys loaded successfully",
    "error": false,
    "error_code": 0
  },
  "encryption_keys": [
    {
      "id": "xxxx",
      "name": "Chave_API-Example",
      "description": "Example description for the encryption key.",
      "algorithm": "aes256-gcm96",
      "expiration_date": "2023-11-30T15:00:00Z",
      "enabled": false
    }
    // ... other keys
  ]
}

Additional Fields

FieldTypeDescription
encryption_keysArrayList of Objects representing each encryption key.
idStringUnique identifier of the created key.
nameStringName of the key.
descriptionStringDetailed description of the key.
algorithmStringNew encryption algorithm.
expiration_dateStringDate and time of expiration of the key (ISO 8601 format).
enabledBooleanKey status. True to enabled, False to disabled..

Was this article helpful?