Strukturen

Zugriffsschlüsselobjekt

Das Zugriffsschlüsselobjekt enthält Informationen über einen API-Schlüssel oder eine ACME-URL.

Name Typ Beschreibung
id int Schlüssel-ID.
user object Angaben über den mit dem Schlüssel verknüpften Benutzer.
.. id int Benutzer-ID.
.. first_name string Vorname des Benutzers.
.. last_name string Nachname des Benutzers.
status string Schlüsselstatus.
Mögliche Werte: active, revoked
create_date string Zeitstempel, wann der Schlüssel erstellt wurde.
Format: UTC-Zeitzone und ISO 8601-Datum
last_used_date string Zeitstempel der letzten Schlüsselverwendung.
Format: UTC-Zeitzone und ISO 8601-Datum
name string Name der Schlüssels.
is_legacy bool Legacy-Status des Schlüssels.
restricted_to_role_id int Gibt an, ob die API-Schlüsselberechtigungen auf ein definiertes Aktionsset beschränkt sind.
Siehe Glossar – API-Schlüsselrollen
acme_directory_url string Verschleierte ACME-Verzeichnis-URL.
Wird nur für ACME-Schlüssel zurückgegeben.
product_name_id string Namens-ID des über ACME bestellten Produkts.
Wird nur für ACME-Schlüssel zurückgegeben.
Siehe Glossar – Produkt-IDs
product_name string Anzeigename des über ACME bestellten Produkts.
Wird nur für ACME-Schlüssel zurückgegeben.
Siehe Glossar – Produkt-IDs
organization_id string Organisations-ID assoziiert mit Zertifikataufträgen über ACME.
Wird nur für ACME-Schlüssel zurückgegeben.
organization_name string Name der Organisation assoziiert mit Zertifikataufträgen über ACME.
Wird nur für ACME-Schlüssel zurückgegeben.
validity_days string Die Anzahl der Tage, die das Zertifikat gültig ist.
Wird nur für ACME-Schlüssel zurückgegeben.
validity_years string Die Anzahl der Jahre, die das Zertifikat gültig ist
Wird nur für ACME-Schlüssel zurückgegeben.

Kontaktdatenobjekt

Das Kontaktdatenobjekt enthält Informationen über ein Unternehmens- oder technischen Kontakt.

Name Typ Beschreibung
first_name string Vorname des Kontakts.
last_name string Nachname des Kontakts.
email string E-Mail-Adresse des Kontakts.
job_title string Funktion des Kontakts.
telephone string Telefonnummer des Kontakts.
telephone_extension string Durchwahl des Kontakts.

Seitendatenobjekt

Name Typ Beschreibung
total int Gesamtzahl der gefundenen Ergebnisse.
limit int Ergebnisse, gekürzt auf die angegebenen Anzahl.
Ändern mithilfe der Limit-Abfragezeichenfolge.
Max.: 1000
Standard: 1000
offset int Ergebnisse beginnen bei der angegebenen Nummer.
Ändern mithilfe der Limit-Abfragezeichenfolge.
Standard: 0

Benutzerdatenobjekt

Das Benutzerdatenobjekt enthält grundlegende Informationen über einen bestimmten Benutzer. Je nach Endpunkt, werden nicht alle Parameter zurückgegeben.

Name Typ Beschreibung
id int Benutzer-ID.
username string Für die Anmeldung verwendeter Benutzername.
account_id int Konto, zu dem der Benutzer gehört.
first_name string Vorname des Benutzers.
last_name string Nachname des Benutzers.
email string E-Mail-Adresse des Benutzers.
status string Aktiver Status des Benutzers.

Validierungsobjekt

Die Validierungsobjekt enthält Validierungsstatusinformationen für ein Unternehmen oder eine Domäne.

Name Typ Beschreibung
type string Validierungstyp-ID:
Siehe Glossar – Validierungstypen
name string Name des Validierungstyps.
description string Beschreibung des Validierungstyps
date_created string Zeitstempel, wann die Domäne validiert wurde.
Format: UTC-Zeitzone und ISO 8601-Datum
validated_until string Zeitstempel, wann die Domänenvalidierung abläuft.
Format: UTC-Zeitzone und ISO 8601-Datum
status string Status der Validierung.
Mögliche Werte: pending, active, expired
dcv_status string Status der Validierung der Domänenkontrolle (Domain Control Validation, DCV)
Mögliche Werte: pending, complete, expired
org_status string Status der Validierung der Organisation.
Mögliche Werte: pending, complete, expired
verified_users string Liste der Benutzer, die für diesen Validierungstyp geprüft wurden.
Siehe Kontaktdatenobjekt

Validierungstypobjekt

Das Validierungstypobjekt enthält Informationen über einen bestimmten Validierungstyp, der sowohl für Organisations- als auch für Domänenvalidierung verwendet wird.

Name Typ Beschreibung
type string Validierungstyp-ID:
name string Name des Validierungstyps.
description string Beschreibung des Validierungstyps
requires_user bool Zeigt an, ob der Validierungstyp eine Benutzervalidierung erfordert.
requires_dcv bool Zeigt an, ob der Validierungstyp eine DCV erfordert.
Wird nur mit Domänenvalidierungstypen zurückgegeben.