Erstellen oder Ersetzen von claimsPolicy
Namespace: microsoft.graph
Wichtig
Die APIs unter der /beta
Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.
Erstellen Sie ein neues customClaimsPolicy-Objekt , falls es nicht vorhanden ist, oder ersetzen Sie ein vorhandenes Objekt.
Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.
Globaler Dienst | US Government L4 | US Government L5 (DOD) | China, betrieben von 21Vianet |
---|---|---|---|
✅ | ❌ | ❌ | ❌ |
Berechtigungen
Wählen Sie für diese API die Als am wenigsten privilegierten Berechtigungen gekennzeichneten Berechtigungen aus. Verwenden Sie nur dann eine Berechtigung mit höheren Berechtigungen , wenn dies für Ihre App erforderlich ist. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.
Berechtigungstyp | Berechtigungen mit den geringsten Berechtigungen | Berechtigungen mit höheren Berechtigungen |
---|---|---|
Delegiert (Geschäfts-, Schul- oder Unikonto) | Policy.Read.ApplicationConfiguration | Policy.ReadWrite.ApplicationConfiguration |
Delegiert (persönliches Microsoft-Konto) | Nicht unterstützt | Nicht unterstützt |
Anwendung | Policy.Read.ApplicationConfiguration | Policy.ReadWrite.ApplicationConfiguration |
In delegierten Szenarien mit Geschäfts-, Schul- oder Unikonten muss dem angemeldeten Benutzer eine unterstützte Microsoft Entra-Rolle oder eine benutzerdefinierte Rolle mit einer unterstützten Rollenberechtigung zugewiesen werden. Anwendungsadministrator ist die Rolle mit den geringsten Berechtigungen, die für diesen Vorgang unterstützt wird.
HTTP-Anforderung
PUT /servicePrincipals/{servicePrincipalsId}/claimsPolicy
Anforderungsheader
Name | Beschreibung |
---|---|
Authorization | Bearer {token}. Erforderlich. Erfahren Sie mehr über die Authentifizierung und Autorisierung. |
Content-Type | application/json. Erforderlich. |
Anforderungstext
Geben Sie im Anforderungstext eine JSON-Darstellung des customClaimsPolicy-Objekts an.
Sie können die folgenden Eigenschaften angeben, wenn Sie eine customClaimsPolicy erstellen.
Eigenschaft | Typ | Beschreibung |
---|---|---|
includeBasicClaimSet | Boolesch | Bestimmt, ob der grundlegende Anspruchssatz in Token enthalten ist, die von dieser Richtlinie betroffen sind. Wenn auf true festgelegt ist, werden alle Ansprüche im grundlegenden Anspruchssatz in Token ausgegeben, die von der Richtlinie betroffen sind. Standardmäßig ist der grundlegende Anspruchssatz nicht in den Token enthalten, es sei denn, sie sind in dieser Richtlinie explizit konfiguriert. Optional. |
includeApplicationIdInIssuer | Boolesch | Gibt an, ob die Anwendungs-ID dem Anspruch hinzugefügt wird. Dies ist nur für SAML2.0 und bei Verwendung eines benutzerdefinierten Signaturschlüssels relevant. Der Standardwert ist true . Optional. |
audienceOverride | String | Falls angegeben, wird der Inhalt des Zielgruppenanspruchs für WS-Federation- und SAML2-Protokolle außer Kraft gesetzt. Für die Anwendung von audienceOverride muss ein benutzerdefinierter Signaturschlüssel verwendet werden, andernfalls wird der AudienceOverride-Wert ignoriert. Der angegebene Wert muss im Format eines absoluten URI vorliegen. Optional. |
Ansprüche | customClaimBase-Sammlung | Definiert, welche Ansprüche in den token vorhanden sind, die von der Richtlinie betroffen sind, zusätzlich zum Basisanspruch und dem Kernanspruchssatz. Optional. |
Antwort
Bei erfolgreicher Ausführung gibt die Methode den 204
Antwortcode und ein customClaimsPolicy-Objekt im Antworttext zurück.
Beispiele
Anforderung
Das folgende Beispiel zeigt eine Anfrage.
PUT https://graph.microsoft.com/beta/servicePrincipals/{servicePrincipalsId}/claimsPolicy
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.customClaimsPolicy",
"includeBasicClaimSet": "Boolean",
"includeApplicationIdInIssuer": "Boolean",
"audienceOverride": "String",
"claims": [
{
"@odata.type": "microsoft.graph.customClaim"
}
]
}
Antwort
Das folgende Beispiel zeigt die Antwort.
Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.
HTTP/1.1 201 Created
Content-Type: application/json
{
"@odata.type": "#microsoft.graph.customClaimsPolicy",
"id": "f914f36d-167e-3fa7-cfa2-355cc5a36689",
"includeBasicClaimSet": "Boolean",
"includeApplicationIdInIssuer": "Boolean",
"audienceOverride": "String",
"claims": [
{
"@odata.type": "microsoft.graph.customClaim"
}
]
}