Information om REST API-tjänsten för Certifikathantering

I följande avsnitt beskrivs information om REST-API:et Microsoft Identity Manager (MIM) Certificate Management (CM).

Arkitektur

MIM CM REST API-anrop hanteras av kontrollanter. I följande tabell visas en fullständig lista över kontrollanter och exempel på den kontext där de kan användas.

Kontrollant Exempelväg
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}/certificates
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/smartkort/{id}
/api/v1.0/smartkort
SmartcardsConfigurationController /api/v1.0/profiletemplates/{profiletemplateid}/configuration/smartcards

HTTP-begärande- och svarshuvuden

HTTP-begäranden som skickas till API:et bör innehålla följande huvuden (den här listan är inte fullständig):

Huvud Beskrivning
Auktorisering Krävs. Innehållet beror på autentiseringsmetoden. Metoden kan konfigureras och kan baseras på Windows-integrerad autentisering (WIA)) eller Active Directory Federation Services (AD FS) (ADFS).
Content-Type Krävs om begäran har en brödtext. Måste vara application/json.
Innehållslängd Krävs om begäran har en brödtext.
Cookie Sessionscookie. Kan krävas beroende på autentiseringsmetod.

HTTP-svar innehåller följande huvuden (den här listan är inte fullständig):

Huvud Beskrivning
Content-Type API:et returnerar application/jsonalltid .
Innehållslängd Längden på begärandetexten, om den finns, i byte.

API-versionshantering

Den aktuella versionen av CM REST API är 1.0. Versionen anges i segmentet direkt efter /api segmentet i URI:n: /api/v1.0. Versionsnumret ändras när större ändringar görs i API-gränssnittet.

Aktivera API:et

Avsnittet <ClmConfiguration> i Web.config-filen har utökats med en ny nyckel:

<add key="Clm.WebApi.Enabled" value="false" />

Den här nyckeln avgör om CM REST-API:et exponeras för klienter. Om nyckeln är inställd på "false" utförs inte routningsmappningen för API:et vid programstart. Efterföljande begäranden till API-slutpunkter returnerar en HTTP 404-felkod. Nyckeln är inställd på "inaktiverad" som standard.

Anteckning

När du har ändrat det här värdet till "true" ska du komma ihåg att köra iisreset på servern.

Aktivera spårning och loggning

MIM CM REST API genererar spårningsdata för varje HTTP-begäran som skickas till den. Du kan ange utförlighetsnivån för spårningsinformationen som genereras genom att ange följande konfigurationsvärde:

<add name="Microsoft.Clm.Web.API" value="0" />

Felhantering och felsökning

När undantag inträffar när en begäran bearbetas returnerar MIM CM REST API en HTTP-statuskod till webbklienten. För vanliga fel returnerar API:et en lämplig HTTP-statuskod och en felkod.

Ohanterade undantag konverteras till en HttpResponseException med HTTP-statuskod 500 ("Internt fel") och spåras i både händelseloggen och MIM CM-spårningsfilen. Varje ohanterat undantag skrivs till händelseloggen med motsvarande korrelations-ID. Korrelations-ID:t skickas också till konsumenten av API:et i felmeddelandet. Om du vill felsöka felet kan en administratör söka i händelseloggen efter motsvarande korrelations-ID och felinformation.

Anteckning

Stackspårningar som motsvarar fel, som genereras till följd av användning av MIM CM REST API, skickas inte tillbaka till klienten. Spårningarna skickas inte tillbaka till klienten på grund av säkerhetsproblem.