Hinweis
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, sich anzumelden oder das Verzeichnis zu wechseln.
Für den Zugriff auf diese Seite ist eine Autorisierung erforderlich. Sie können versuchen, das Verzeichnis zu wechseln.
In den folgenden Abschnitten werden die Details der REST-API (Microsoft Identity Manager, MIM)-Zertifikatverwaltung (CM) beschrieben.
Architektur
MIM CM-REST-API-Aufrufe werden von Controllern behandelt. Die folgende Tabelle enthält die vollständige Liste der Controller und Beispiele des Kontexts, in dem sie verwendet werden können.
| Controller | Beispielroute |
|---|---|
| CertificateDataController | /api/v1.0/requests/{requestid}/certificatedata/ |
| CertificateRequestGenerationOptionsController | /api/v1.0/requests/{requestid} |
| CertificatesController | /api/v1.0/smartcards/{smartcardid}/certificates /api/v1.0/profiles/{profileid}/zertifikate |
| OperationsController | /api/v1.0/smartcards/{smartcardid}/operations /api/v1.0/profiles/{profileid}/operations |
| PoliciesController | /api/v1.0/profiletemplates/{profiletemplateid}/policies/{id} |
| ProfilesController | /api/v1.0/profiles/{id} |
| ProfileTemplatesController | /api/v1.0/profiletemplates/{id} /api/v1.0/profiletemplates /api/v1.0/profiletemplates/{profiletemplateid}/policies/{id} |
| RequestsController | /api/v1.0/requests/{id} /api/v1.0/requests |
| SmartcardsController | /api/v1.0/requests/{requestid}/smartcards/{id}/diversifiedkey /api/v1.0/requests/{requestid}/smartcards/{id}/serverproposedpin /api/v1.0/requests/{requestid}/smartcards/{id}/authenticationresponse /api/v1.0/requests/{requestid}/smartcards/{id} /api/v1.0/smartcards/{id} /api/v1.0/smartcards |
| Smartcard-Konfigurationscontroller | /api/v1.0/profiletemplates/{profiletemplateid}/configuration/smartcards |
HTTP-Anforderungs- und Antwortheader
HTTP-Anforderungen, die an die API gesendet werden, sollten die folgenden Header enthalten (diese Liste ist nicht erschöpfend):
| Kopfzeile | BESCHREIBUNG |
|---|---|
| Autorisierung | Erforderlich. Der Inhalt hängt von der Authentifizierungsmethode ab. Die Methode kann konfigurierbar sein und auf Windows Integrated Authentication (WIA)) oder Active Directory-Verbunddiensten (Active Directory Federation Services, ADFS) basieren. |
| Inhaltstyp | Erforderlich, wenn die Anforderung Text enthält. Muss application/jsonlauten. |
| Inhaltslänge | Erforderlich, wenn die Anforderung Text enthält. |
| Keks | Das Sitzungscookie. Kann je nach Authentifizierungsmethode erforderlich sein. |
HTTP-Antworten enthalten die folgenden Header (diese Liste ist nicht erschöpfend):
| Kopfzeile | BESCHREIBUNG |
|---|---|
| Inhaltstyp | Die API gibt immer zurück application/json. |
| Inhaltslänge | Die Länge des Anforderungstexts (sofern vorhanden) in Byte. |
API-Versionsverwaltung
Die aktuelle Version der CM REST-API ist 1.0. Die Version wird im Segment direkt nach dem /api Segment im URI angegeben: /api/v1.0 Die Versionsnummer ändert sich, wenn wichtige Änderungen an der API-Schnittstelle vorgenommen werden.
Aktivieren der API
Der <ClmConfiguration> Abschnitt der Web.config Datei wurde mit einem neuen Schlüssel erweitert:
<add key="Clm.WebApi.Enabled" value="false" />
Dieser Schlüssel bestimmt, ob die CM-REST-API für Clients verfügbar gemacht wird. Wenn der Schlüssel auf "false" festgelegt ist, wird die Routenzuordnung für die API beim Starten der Anwendung nicht ausgeführt. Nachfolgende Anforderungen an API-Endpunkte geben einen HTTP 404-Fehlercode zurück. Der Schlüssel ist standardmäßig auf "deaktiviert" festgelegt.
Hinweis
Nachdem Sie diesen Wert auf "true" geändert haben, denken Sie daran, iisreset auf dem Server auszuführen.
Aktivieren der Ablaufverfolgung und Protokollierung
Die MIM CM-REST-API sendet Ablaufverfolgungsdaten für jede an sie gesendete HTTP-Anforderung. Sie können die Ausführlichkeitsebene der emittierten Tracedaten festlegen, indem Sie den folgenden Konfigurationswert einstellen:
<add name="Microsoft.Clm.Web.API" value="0" />
Fehlerbehandlung und Fehlerbehebung
Wenn Ausnahmen beim Verarbeiten einer Anforderung auftreten, gibt die MIM CM-REST-API einen HTTP-Statuscode an den Webclient zurück. Bei häufig auftretenden Fehlern gibt die API einen geeigneten HTTP-Statuscode und einen Fehlercode zurück.
Unbehandelte Ausnahmen werden in einen HttpResponseException HTTP-Statuscode 500 ("Interner Fehler") konvertiert und sowohl im Ereignisprotokoll als auch in der MIM CM-Ablaufverfolgungsdatei nachverfolgt. Jede unbehandelte Ausnahme wird mit einer entsprechenden Korrelations-ID in das Ereignisprotokoll geschrieben. Die Korrelations-ID wird auch in der Fehlermeldung an den Nutzer der API gesendet. Um den Fehler zu beheben, kann ein Administrator das Ereignisprotokoll nach der entsprechenden Korrelations-ID und Fehlerdetails durchsuchen.
Hinweis
Stapelablaufverfolgungen, die Fehlern entsprechen, die aufgrund der Verwendung der MIM CM-REST-API generiert werden, werden nicht an den Client zurückgesendet. Die Spuren werden aufgrund von Sicherheitsbedenken nicht an den Client zurückgegeben.