Abrufen einer Workflowrichtlinie
Ruft die Profilvorlagenrichtlinie für einen angegebenen Workflow ab. Die Daten werden während der Anforderungserstellung verwendet. Die Workflowrichtlinie gibt an, welche Daten vom Client benötigt werden, um eine Anforderung zu erstellen. Die Daten können verschiedene Datensammlungselemente, Anforderungskommentare und eine Einmalkennwortrichtlinie enthalten.
Hinweis
Die URLs in diesem Artikel beziehen sich auf den Hostnamen, der während der API-Bereitstellung ausgewählt wird, z https://api.contoso.com
. B. .
Anforderung
Methode | Anforderungs-URL |
---|---|
GET | /CertificateManagement/api/v1.0/profiletemplates/{id}/policy/workflow/{type} |
URL-Parameter
Parameter | BESCHREIBUNG |
---|---|
id | Erforderlich. Die GUID, die der Profilvorlage entspricht, aus der die Richtlinie extrahiert werden soll. |
type | Erforderlich. Der Typ der angeforderten Richtlinie. Die möglichen Werte sind "Enroll", "Duplicate", "OfflineUnblock", "OnlineUpdate", "Renew", "Recover", "RecoverOnBehalf", "Reinstate", "Retire", "Revoke", "TemporaryEnroll" und "Unblock". |
Anforderungsheader
Informationen zu gängigen Anforderungsheadern finden Sie unter HTTP-Anforderungs- und Antwortheader in CM-REST-API-Dienstdetails.
Anforderungstext
Keine.
Antwort
In diesem Abschnitt wird die Antwort beschrieben.
Antwortcodes
Code | BESCHREIBUNG |
---|---|
200 | OK |
403 | Verboten |
204 | Kein Inhalt |
500 | Interner Fehler |
Antwortheader
Informationen zu allgemeinen Antwortheadern finden Sie unter HTTP-Anforderungs- und Antwortheader in CM REST API-Dienstdetails.
Antworttext
Gibt bei Erfolg ein Richtlinienobjekt zurück, das auf einem ProfileTemplatePolicy-Objekt basiert. Das Richtlinienobjekt enthält mindestens die Eigenschaften in der folgenden Tabelle, kann jedoch je nach angeforderter Richtlinie zusätzliche Eigenschaften enthalten. Beispielsweise gibt eine Anforderung für eine Registrierungsrichtlinie ein EnrollPolicy-Objekt zurück. Weitere Informationen finden Sie in der Dokumentation für das Richtlinienobjekt, das dem {type}-Parameter in der Anforderung zugeordnet ist. Die Dokumentation für die verschiedenen Typen von Richtlinienobjekten finden Sie in der Dokumentation zum Microsoft.Clm.Shared.ProfileTemplates-Namespace .
Eigenschaft | BESCHREIBUNG |
---|---|
ApprovalsNeeded | Die Anzahl der Genehmigungen, die für Anforderungen der Forefront Identity Manager (FIM) Certificate Management (CM) für die Richtlinie erforderlich sind. |
AuthorizedApprover | Die Sicherheitsbeschreibung für Benutzer, die berechtigt sind, FIM CM-Anforderungen für die Richtlinie zu genehmigen. |
AuthorizedEnrollmentAgent | Die Sicherheitsbeschreibung für Benutzer, die für die Richtlinie als Enrollment Agent fungieren können. |
AuthorizedInitiator | Die Sicherheitsbeschreibung für Benutzer, die FIM CM-Anforderungen für die Richtlinie initiieren können. |
CollectComments | Ein boolescher Wert, der angibt, ob die Kommentarsammlung für FIM CM-Anforderungen für die Richtlinie aktiviert ist. |
CollectRequestPriority | Ein boolescher Wert, der angibt, ob die Anforderungsprioritätssammlung für FIM CM-Anforderungen für die Richtlinie aktiviert ist. |
DefaultRequestPriority | Die Standardpriorität für FIM CM-Anforderungen für die Richtlinie. |
Dokumente | Die Richtliniendokumente, die für die Richtlinie konfiguriert sind. |
Aktiviert | Ein boolescher Wert, der angibt, ob die Richtlinie aktiviert ist. |
EnrollAgentRequired | Ein boolescher Wert, der angibt, ob für FIM CM-Anforderungen für die Richtlinie Enrollment Agents erforderlich sind. |
OneTimePasswordPolicy | Die Verteilungsmethode für Einmalkennwörter für FIM CM-Anforderungen für die Richtlinie. |
Personalisierung | Die Smartcard-Personalisierungsoptionen für die Richtlinie. |
PolicyDataCollection | Die Datensammlungselemente, die der Richtlinie zugeordnet sind. |
SelfServiceEnabled | Ein boolescher Wert, der angibt, ob die Self-Service-Initiierung von FIM CM-Anforderungen für die Richtlinie aktiviert ist. |
Beispiel
Dieser Abschnitt enthält ein Beispiel zum Abrufen der Profilvorlagenrichtlinie für einen Workflow.
Beispiel: Anforderung 1
GET /CertificateManagement/api/v1.0/profiletemplates/97CD65FA-AF4B-4587-9309-0DD6BFD8B4E1/policies/enroll HTTP/1.1
Beispiel: Antwort 1
HTTP/1.1 200 OK
... body coming soon
Beispiel: Anforderung 2
GET /CertificateManagement/api/v1.0/profiletemplates/97CD65FA-AF4B-4587-9309-0DD6BFD8B4E1/policies/renew HTTP/1.1
Beispiel: Antwort 2
HTTP/1.1 200 OK
... body coming soon