5.20.2 api cert user

Funkce /api/cert/user slouží ke správě uživatelských certifikátů.

Funkce je součástí služby Systém API a v případě použití autentizace je nutné, aby uživatel měl přiřazené privilegium Systém – řízení.

U této funkce lze použít metodu GET, PUT nebo DELETE. Metoda PUT vrací informace o certifikátech. v zařízení. Metoda PUT slouží k nahrání certifikátů do zařízení. Metoda DELETE slouží ke smazání certifikátu ze zařízení.

Metoda GET

Parametry požadavku GET:

Parametr

Popis

id

Volitelný parametr (string) identifikující uživatelský certifikát. Hodnota parametru id je přednastavené id nebo otisk (hash) certifikátu. Pokud není id zadáno, odpověď obsahuje úplný seznam všech uživatelských certifikátů v zařízení.

Odpověď je ve formátu application/json a může obsahovat následující parametry:

Parametr

Popis

fingerprint

Otisk (hash) certifikátu

subjet,issuer

Informace o subjektu nebo vydavateli: Common Name (CN), Organization (O), Organization Unit (OU), Location (L), State (S), Country (C).

id

Hodnota (řetězec) dříve nastavené identifikace certifikátu.

startDate

Datum začátku platnosti certifikátu

endDate

Datum konce platnosti certifikátu

protected

Hodnota určující, že certifikát nemůže být smazán (true/false). Interní certifikáty s id začínajícím znakem # nemohou být smazány.

systemUseOnly

Hodnota určující, zda může daný certifikát uživatel zvolit jako certifikát pro jakoukoli službu. Pokud je hodnota true, certifikát se v seznamu pro výběr nezobrazí.

Příklad 2:  Získání informací pro určitý certifikát identifikovaný otiskem

GET /api/cert/user?id=a164b11215a30f08603fd85c314327e274772b00   //požadavek
{
  "success" : true,
  "result" : {
    "certificates" : [
      {
        "fingerprint" : "a164b11215a30f08603fd85c314327e274772b00",
        "subject" : {
          "CN" : "00-0001-0205",
          "O" : "2N TELEKOMUNIKACE a.s.",
          "S" : "Czech Republic",
          "C" : "CZ"
        },
        "issuer" : {
          "CN" : "My2N Device Utility Certificate Authority",
          "O" : "2N TELEKOMUNIKACE a.s.",
          "S" : "Czech Republic",
          "C" : "CZ"
        },
        "startDate" : "2021-11-08T07:50:36Z",
        "endDate" : "2022-02-06T07:50:36Z",
        "protected" : false,
        "id" : "#my2n-utility",
        "systemUseOnly" : true
      }
    ]
  }
}

Metoda PUT

Při opakovaném nahrání stejného certifikátu se původní certifikát přepíše.

Parametry požadavku PUT:

Parametr

Popis

blob-cert

Povinný parametr obsahující soubor s certifikátem ve formátu DER nebo PEM.

blob-pk

Povinný parametr soukromého klíče ve formátu DER nebo PEM

password

Nepovinný parametr obsahující heslo k nahraného klíče.

id

Volitelný parametr (string) identifikující uživatelský certifikát.

Pokud je nahrán certifikát pod stejným id, původní certifikát s tímto id se přepíše.

Odpověď je ve formátu application/json a obsahuje otisk nahraného certifikátu

Parametr

Popis

fingerprint

Otisk (hash) nahraného certifikátu

replaced

Otisk přepsaného certifikátu

Příklad

PUT /api/cert/ca         //požadavek
{
  "success" : true,
  "result" : {
    "certificates" : [
      {
        "fingerprint": "9623fa25e414aa930ed22348a22d04a4c4fda26b"
      },
      {
        "fingerprint": "9623fa25e414aa930ed22348a22d04a4c4fda26b"
        "replaced": "9623fa25e414aa930ed22348a22d04a4c4fda26c"
      }
    ]
  }
}
Response
{
  "success" : false,
  "error" : {
    "code" : 12,
    "param" : "blob-cert",
    "description" : "invalid certificate",
    "data" : "invalid_cert"
  }
}

Metoda DELETE

Parametry požadavku:

Parametr

Popis

id

Povinný parametr (string) identifikující uživatelský certifikát. Parametr id je přednastavené id nebo otisk (hash) certifikátu.

Odpověď je ve formátu application/json.

Příklad

DELETE /api/cert/ca?fingerprint=4deea7060d80babf1643b4e0f0104c82995075b7
{
  "success" true
}