Die benutzerdefinierten Konfigurationen einer Domain auflisten¶

Note

Die Antwort ist nicht paginiert. Sie enthält alle Einträge des angefragten Bereichs.

Note

Das Ergebnis enthält ausschließlich die Einträge, die Myra für die Kundin oder den Kunden freigegeben hat. Intern gehaltene Einträge sind nicht Teil der Antwort.

Senden einer GET-Anfrage an den Endpunkt /domain/{domainId}/custom-configurations.

Beschreibung¶

Mit der List-Custom-Configurations-Anfrage rufen Sie die benutzerdefinierten Konfigurationen ab, die Myra für eine Domain der Organisation eingerichtet hat.

Eine benutzerdefinierte Konfiguration dokumentiert eine vom Standard abweichende Einstellung, die Myra Security auf Anfrage vorgenommen hat. Die Einträge bestehen auf zwei Ebenen: Ein Eintrag auf Domain-Ebene beschreibt die gesamte Domain, ein Eintrag auf Subdomain-Ebene beschreibt eine einzelne Subdomain. Beide Ebenen fragen Sie über diesen Endpunkt ab, der Parameter subDomainName wählt die Ebene aus.

Voraussetzungen¶

Werte der Anfrage: Domain-ID {domainId}

Objekte: keine

Anfrage¶

Um die benutzerdefinierten Konfigurationen einer Domain abzurufen, fügen Sie die Domain-ID {domainId} dem Pfad der Anfrage hinzu.

Der folgende Parameter ist optional:

Parameter	Beschreibung	Werte
`subDomainName`	Gibt die Einträge dieser Subdomain statt der Einträge der Domain zurück. Ohne diesen Parameter gibt die Anfrage ausschließlich die Einträge auf Domain-Ebene zurück.	`string`

Als Ergebnis erhalten Sie ein oder mehrere Objekte CustomConfigurationVO mit den angefragten Informationen.

Das Objekt liefert die folgenden Informationen:

Attribut	Beschreibung	Werte
`type`	Die Art der Einstellung, die der Eintrag beschreibt. In der Myra App trägt das Attribut die Bezeichnung Typ.	`feature` `header` `ssl_cipher`
`name`	Der Name der Einstellung. In der Myra App trägt das Attribut die Bezeichnung Name.	`string`
`value`	Der Wert der Einstellung. Welcher Inhalt zulässig ist, hängt vom Typ ab. In der Myra App trägt das Attribut die Bezeichnung Wert.	`string`
`description`	Eine Erläuterung, warum die Einstellung vorgenommen wurde. In der Myra App trägt das Attribut die Bezeichnung Beschreibung.	`string`
`id`	Die ID des Eintrags.	`integer`
`modified`	Das Datum der letzten Änderung im ISO-8601-Format.	`string($date-time)`
`created`	Das Erstellungsdatum im ISO-8601-Format.	`string($date-time)`

Beispiel¶

Beispiel-Antwort:

[
  {
    "objectType": "string",
    "type": "string",
    "name": "string",
    "value": "string",
    "description": "string",
    "id": 0,
    "modified": "string",
    "created": "string"
  }
]

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.