SSL/TLS-Anbieter-Zugangsdaten aktualisieren¶

Note

Diese Anfrage steht nur Mitgliedern der Root-Gruppe und Organisationsadministratoren zur Verfügung. Die ID des Eintrags im Pfad der Anfrage muss mit dem Wert des Attributs id im Body übereinstimmen. Gelöschte oder nicht vorhandene Zugangsdaten liefern immer eine 403-Antwort anstelle einer 404-Antwort.

Senden einer PUT-Anfrage an den Endpunkt /ssl/providers/{id}.

Beschreibung¶

Mit der Update-Ssl-Provider-Credentials-Anfrage aktualisieren Sie bestehende SSL/TLS-Anbieter-Zugangsdaten der Organisation.

Voraussetzungen¶

Werte der Anfrage: Provider-ID {id}

Objekte: SslProviderCredentialsVO

Anfrage¶

Um SSL/TLS-Anbieter-Zugangsdaten zu aktualisieren, fügen Sie die Provider-ID {id} in den Pfad der Anfrage ein. Für eine detaillierte Spezifikation, welche Informationen zum Aktualisieren von SSL/TLS-Anbieter-Zugangsdaten erforderlich sind, muss im Body ein Objekt SslProviderCredentialsVO mit den folgenden Attributen definiert werden:

Attribut	Beschreibung	Werte
`id`	Die ID des Zugangsdaten-Eintrags. Muss mit der Provider-ID `{id}` im Pfad übereinstimmen.	`integer`
`name`	Der Name des Zugangsdaten-Eintrags.	`string`
`provider`	Der ACME-Anbieter, zu dem diese Zugangsdaten gehören.	`SECTIGO` `DTRUST`
`eabKid`	Die EAB-KID (External Account Binding Key Identifier) des ACME-Kontos.	`string`

Die folgenden Attribute sind optional:

Attribut	Beschreibung	Werte
`eabHmac`	Der EAB-HMAC-Schlüssel des ACME-Kontos. Jeder autorisierte Nutzende kann ihn rotieren. Bleibt das Feld leer, wird der gespeicherte Wert beibehalten.	`string`
`cert`	Das Zertifikat des ACME-Kontos. Bleibt das Feld leer, wird der gespeicherte Wert beibehalten.	`string`
`privateKey`	Der private Schlüssel zu `cert`. Kann nur von Myra-Superadministratoren geändert werden; bei anderen Aufrufenden wird der Wert ignoriert. Bleibt das Feld leer, wird der gespeicherte Wert beibehalten.	`string`
`email`	Die Kontakt-E-Mail-Adresse des ACME-Kontos. Muss beim Anbieter `DTRUST` leer bleiben. Bei `SECTIGO` löscht ein leerer Wert die gespeicherte Kontakt-E-Mail-Adresse.	`string`
`endpoint`	Die ACME-Endpunkt-URL. Erforderlich beim Anbieter `SECTIGO`, muss eine gültige URL sein, sofern gesetzt.	`string`
`comment`	Ein individueller Kommentar für den Eintrag.	`string`

Das System gibt das Objekt SslProviderCredentialsVO mit den aktualisierten Informationen zurück.

Beispiel¶

Beispiel-Request-Body:

{
  "name": "My Sectigo Account",
  "provider": "SECTIGO",
  "eabKid": "kid-12345",
  "eabHmac": "base64-hmac-value",
  "cert": "-----BEGIN CERTIFICATE-----...",
  "privateKey": "-----BEGIN PRIVATE KEY-----...",
  "email": "admin@example.com",
  "endpoint": "https://acme.sectigo.com/v2/OV",
  "comment": "Sectigo production account"
}

Antworten¶

Die folgenden Antworten sind möglich:

STATUSCODE	BESCHREIBUNG
200	Die Anfrage war erfolgreich.
400	Die Anfrage war nicht erfolgreich. Die Anfrage war fehlerhaft oder es fehlen Informationen.
401	Die Anfrage war nicht erfolgreich, da die Authentifizierung fehlerhaft war.
403	Die Anfrage war nicht erfolgreich, da die erforderlichen Berechtigungen fehlen.