Partner-Zertifikate (REST API)

Allgemein: Siehe Abschnitt REST API.

images/download/thumbnails/135168154/image2020-3-12_14-40-21-version-1-modificationdate-1679977230807-api-v2.png

Sie können Partner-Zertifikate per HTTP anlegen und widerrufen. Aus Sicherheitsgründen können keine eigenen Zertifikate importiert werden. Zudem können Partner-Zertifikate und eigene Zertifikate heruntergeladen werden.

Logs für Anfragen dieser Art finden Sie in den Server-Logs unter internal/message.log.

Zertifikat anlegen


URL (HTTP POST mit JSON):

http://<IP oder URL des Integration Servers>/dw/auth/v1/certificate

https://<IP oder URL des Integration Servers>/dw/auth/v1/certificate

Hinweis: Siehe Abschnitt Hinzufügen eines HTTPS-Listeners.


JSON:

{
"operation": "add",
"id": 0,
"relation": "My partner",
"commonName": "",
"certificate": "MIIDXDCCAkSgAwIBAgIGAXdnKI1FMA0GCSqGSIb3DQEBCwUAMEExDTALBgNVBAMMBHRlc3QxDTALBgNVBAoMBHRlc3QxCzAJBgNVBAYTAmRlMRQwEgYKCZImiZPyLGQBGRYEdGVzdDAeFw0yMTAyMDIyMzAwMDBaFw00MTAyMDIyMzAwMDBaMEExDTALBgNVBAMMBHRlc3QxDTALBgNVBAoMBHRlc3QxCzAJBgNVBAYTAmRlMRQwEgYKCZImiZPyLGQBGRYEdGVzdDCCASAwCwYJKoZIhvcNAQEKA4IBDwAwggEKAoIBAQC7mwTRTO6ckaF1paQ/0fmEfX4Ue1BgTXlOUNSbfX+xY6yi+AQsboajcsth3hdrga6utEEwWNh89ya/KZiVZsF6m/R8xuEu+vXG3KfENhSI12bgvQSN7qOVFitRrQ4c4AM0hWxnRgVTdUgPwabDxuUBYbC1Q42JWbEiMWJjboJX736sifLfbJODO/wrV5ErIv8Y+r1ez7vktkaLzTPZ4iqaeozohj3vWf5YD958ASv4gJIZTgkES+A5eyA4oqTTurgW4WItZRHjdTgbHaxLuZrwG64DchaCBsiPVi6sxRkWnOibVSUw3ItVK7CjjBQIj+d4T0ZAD4243WGHwhu6ylJPAgMBAAGjXDBaMCkGA1UdDgQiBCBXPK15NyhJrNLkiK06/b2t3buAJORzFuMAdt9kGB6IaTAOBgNVHQ8BAf8EBAMCBLAwHQYDVR0lBBYwFAYIKwYBBQUHAwIGCCsGAQUFBwMBMA0GCSqGSIb3DQEBCwUAA4IBAQBDxNnzt3hKJHSXDthQC4W7jCFTeSdCRHM7wCoyF2Lv4onUnKFkTznjVfNfBpYfHgRRD0ioZOQUs7LShicxn4sz2yyHWNQbrnwPoWnUn516QS8L1l46BgcF12/7nfy25lK3QgGwprZg9wu64x1Mlcefb7+rFKT+4cl6+zCedSL00vdKUJMJZ2f0EhABHrjfDLvFjFmROBzmxL66OkVHwiL7uk70t0CYV+Y54J0UobTOuUR+Oxv3JvO6A0GYJJaOw2MLfJRHBmqj/e6bpGzpRttTfpyBZ3+jaSAcaLEH7QKgcGU8pvQ77v1+O/3ucLKYfgKn67guHC1lfNbfLzKoMFKl"
}

Sie können hier entweder 0 für die id angeben oder die Zeile ganz weglassen, da die ID des Partner-Zertifikats bei dieser Operation ja erst erzeugt wird.

Beim Parameter certificate wird alles akzeptiert (allerdings mit Base64 kodiert), was der Upload-Dialog in der GUI annimmt (.pem und .cer).

Beispiel:

Gehen wir von folgendem .pem-Zertifikat aus (welches bereits in Base64 kodiert ist).


-----BEGIN CERTIFICATE-----
MIIDXDCCAkSgAwIBAgIGAXdnKI1FMA0GCSqGSIb3DQEBCwUAMEExDTALBgNVBAMM
BHRlc3QxDTALBgNVBAoMBHRlc3QxCzAJBgNVBAYTAmRlMRQwEgYKCZImiZPyLGQB
GRYEdGVzdDAeFw0yMTAyMDIyMzAwMDBaFw00MTAyMDIyMzAwMDBaMEExDTALBgNV
BAMMBHRlc3QxDTALBgNVBAoMBHRlc3QxCzAJBgNVBAYTAmRlMRQwEgYKCZImiZPy
LGQBGRYEdGVzdDCCASAwCwYJKoZIhvcNAQEKA4IBDwAwggEKAoIBAQC7mwTRTO6c
kaF1paQ/0fmEfX4Ue1BgTXlOUNSbfX+xY6yi+AQsboajcsth3hdrga6utEEwWNh8
9ya/KZiVZsF6m/R8xuEu+vXG3KfENhSI12bgvQSN7qOVFitRrQ4c4AM0hWxnRgVT
dUgPwabDxuUBYbC1Q42JWbEiMWJjboJX736sifLfbJODO/wrV5ErIv8Y+r1ez7vk
tkaLzTPZ4iqaeozohj3vWf5YD958ASv4gJIZTgkES+A5eyA4oqTTurgW4WItZRHj
dTgbHaxLuZrwG64DchaCBsiPVi6sxRkWnOibVSUw3ItVK7CjjBQIj+d4T0ZAD424
3WGHwhu6ylJPAgMBAAGjXDBaMCkGA1UdDgQiBCBXPK15NyhJrNLkiK06/b2t3buA
JORzFuMAdt9kGB6IaTAOBgNVHQ8BAf8EBAMCBLAwHQYDVR0lBBYwFAYIKwYBBQUH
AwIGCCsGAQUFBwMBMA0GCSqGSIb3DQEBCwUAA4IBAQBDxNnzt3hKJHSXDthQC4W7
jCFTeSdCRHM7wCoyF2Lv4onUnKFkTznjVfNfBpYfHgRRD0ioZOQUs7LShicxn4sz
2yyHWNQbrnwPoWnUn516QS8L1l46BgcF12/7nfy25lK3QgGwprZg9wu64x1Mlcef
b7+rFKT+4cl6+zCedSL00vdKUJMJZ2f0EhABHrjfDLvFjFmROBzmxL66OkVHwiL7
uk70t0CYV+Y54J0UobTOuUR+Oxv3JvO6A0GYJJaOw2MLfJRHBmqj/e6bpGzpRttT
fpyBZ3+jaSAcaLEH7QKgcGU8pvQ77v1+O/3ucLKYfgKn67guHC1lfNbfLzKoMFKl
-----END CERTIFICATE-----


Entfernen Sie die erste und letzte Zeile und alle Zeilenumbrüche, dann können Sie diesen String oben als Wert des Parameters certificate verwenden.

Wenn Sie eine .cer-Datei (binär) verwenden möchten, müssen Sie diese zuvor mit einem entsprechenden Tool in Base64 umwandeln.

Beispielhafte Response


Die Struktur der Response ist bei jeder erfolgreichen Zertifikats-Operation identisch.

Die id ist hier die ID des erzeugten Partner-Zertifikats.


{
"response": {
"status": "ok",
"id": "1616398381212487"
}
}

Zertifikat widerrufen


URL (HTTP POST mit JSON):

http://<IP oder URL des Integration Servers>/dw/auth/v1/certificate

https://<IP oder URL des Integration Servers>/dw/auth/v1/certificate


JSON:

{
"operation": "revoke",
"id": 1616398381212487,
"relation": "My partner"
}

Zertifikate herunterladen


Sie können Partner-Zertifikate und eigene Zertifikate herunterladen.

URL:

http://<IP oder URL des Integration Servers>/dw/auth/v1/exportcertificate?id=<id>format=<format>

https://<IP oder URL des Integration Servers>/dw/auth/v1/exportcertificate?id=<id>&format=<format>


Wobei <id> die Zertifikats-ID ist und <format> das Export-Format. Erlaubte Werte: DER, PEM, OPENSSH, PKCS12, PKCS7, PUTTY oder INFO.

Bei unbekannten Formaten wird immer DER verwendet. INFO liefert nur Basis-Informationen (Felder aus Zertifikatsübersicht), aber nicht das Zertifikat.

Logs


Logs für Anfragen dieser Art finden Sie in den Server-Logs unter internal/message.log (bzw. in der Datei ./logs/services/message.log).