SSL/TLS-Anbieter-Zugangsdaten erstellen¶

Note

Diese Anfrage steht nur Mitgliedern der Root-Gruppe und Organisationsadministratoren zur Verfügung. Das Attribut id darf nicht im Body enthalten sein.

Senden einer POST-Anfrage an den Endpunkt /ssl/providers.

Beschreibung¶

Mit der Create-Ssl-Provider-Credentials-Anfrage erstellen Sie neue SSL/TLS-Anbieter-Zugangsdaten für die Organisation.

Voraussetzungen¶

Werte der Anfrage: keine Objekte: SslProviderCredentialsVO

Anfrage¶

Um SSL/TLS-Anbieter-Zugangsdaten zu erstellen, senden Sie eine POST-Anfrage an den Endpunkt /ssl/providers. Für eine detaillierte Spezifikation, welche Informationen zum Erstellen von SSL/TLS-Anbieter-Zugangsdaten erforderlich sind, muss im Body ein Objekt SslProviderCredentialsVO mit den folgenden Attributen definiert werden:

Attribut	Beschreibung	Werte
`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`
`eabHmac`	Der EAB-HMAC-Schlüssel des ACME-Kontos.	`string`

Die folgenden Attribute sind optional:

Attribut	Beschreibung	Werte
`cert`	Das Zertifikat des ACME-Kontos. Bleiben `cert` und `privateKey` beide leer, generiert Myra automatisch ein selbstsigniertes Platzhalter-Schlüsselpaar; die Angabe nur eines der beiden Attribute wird abgelehnt.	`string`
`privateKey`	Der private Schlüssel zu `cert`. Es gilt dieselbe Regel zur automatischen Generierung wie bei `cert`.	`string`
`email`	Die Kontakt-E-Mail-Adresse des ACME-Kontos. Muss beim Anbieter `DTRUST` leer bleiben.	`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 erstellten 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
201	Die Anfrage war erfolgreich und ein neues Objekt wurde erstellt.
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.