customClaimsPolicy-Ressourcentyp

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.

Stellt eine Anspruchsrichtlinie dar, die es Anwendungsadministratoren ermöglicht, die in Token ausgegebenen Ansprüche anzupassen, die von dieser Richtlinie betroffen sind. Weitere Informationen zu dieser Richtlinie finden Sie in den folgenden Artikeln:

• Anpassen von Ansprüchen mithilfe der benutzerdefinierten Anspruchsrichtlinie (Vorschau)
• Anspruchsanpassung mithilfe einer Richtlinie, um den Unterschied zwischen dieser Richtlinie und der Anspruchszuordnungsrichtlinie zu erfahren

Erbt von entity.

Methoden

Methode	Rückgabetyp	Beschreibung
Get	customClaimsPolicy	Lesen der Eigenschaften und Beziehungen eines benutzerdefinierten Anspruchsrichtlinienobjekts.
Erstellen oder ersetzen	customClaimsPolicy	Erstellen Sie ein neues benutzerdefiniertes Anspruchsrichtlinienobjekt, wenn es nicht vorhanden ist, oder ersetzen Sie ein vorhandenes.
Update	customClaimsPolicy	Aktualisieren Sie die Eigenschaften eines benutzerdefinierten Anspruchsrichtlinienobjekts.

Eigenschaften

Eigenschaft	Typ	Beschreibung
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 wert audienceOverride ignoriert. Der angegebene Wert muss im Format eines absoluten URI vorliegen.
Ansprüche	customClaim-Sammlung	Definiert, welche Ansprüche in den token vorhanden sind, die von der Richtlinie betroffen sind, zusätzlich zum Basisanspruch und dem Kernanspruchssatz. Geerbt von customclaimbase.
id	String	Richtlinienbezeichnerzeichenfolge. Geerbt von entity.
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.
includeBasicClaimSet	Boolesch	Bestimmt, ob der grundlegende Anspruchssatz in Token enthalten ist, die von dieser Richtlinie betroffen sind. Wenn auf truefestgelegt 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.

Beziehungen

Keine.

JSON-Darstellung

Die folgende JSON-Darstellung veranschaulicht den Ressourcentyp.

{
  "@odata.type": "#microsoft.graph.customClaimsPolicy",
  "id": "String (identifier)",
  "includeBasicClaimSet": "Boolean",
  "includeApplicationIdInIssuer": "Boolean",
  "audienceOverride": "String",
  "groupFilter": {
    "@odata.type": "microsoft.graph.groupClaimFilterBase"
  },
  "claims": [
    {
      "@odata.type": "microsoft.graph.customClaim"
    }
  ]
}