claimsMappingPolicy-Ressourcentyp

Artikel
05/11/2022
3 Minuten Lesedauer

Namespace: microsoft.graph

Stellt die Anspruchszuordnungsrichtlinien für WS-Fed-, SAML-, OAuth 2.0- und OpenID-Verbinden-Protokolle für Token dar, die für eine bestimmte Anwendung ausgestellt wurden. Sie können Anspruchszuordnungsrichtlinien für Folgendes verwenden:

Auswählen, welche Ansprüche in Token enthalten sind
Erstellen von Anspruchstypen, die noch nicht vorhanden sind
Auswählen oder Ändern der Datenquelle, die in bestimmten Ansprüchen ausgegeben wird

Die Anzahl der Ansprüche und Transformationen, die einer Anspruchszuordnungsrichtlinie hinzugefügt werden können, ist begrenzt, um die Tokengröße zu verringern. Alle Anspruchsschemaeinträge oder Transformationen, die nach Erreichen des Grenzwerts gefunden werden, werden ignoriert und in das ausgestellte Token eingeschlossen. Weitere Informationen zu den Grenzwerten finden Sie unter Eigenschaften einer Anspruchszuordnungsrichtliniendefinition.

Weitere Szenario- und Konfigurationsdetails finden Sie unter "Richtlinientyp für die Anspruchszuordnung " und " How to: Customize claims emitted in tokens for a specific app in a tenant".

Erbt von stsPolicy.

Methoden

Methode	Rückgabetyp	Beschreibung
Create claimsMappingPolicy	claimsMappingPolicy	Erstellen Sie ein claimsMappingPolicy-Objekt.
ClaimsMappingPolicy abrufen	claimsMappingPolicy	Lesen von Eigenschaften und Beziehungen eines claimsMappingPolicy-Objekts.
List claimsMappingPolicies	claimsMappingPolicy	Dient zum Lesen von Eigenschaften und Beziehungen von claimsMappingPolicies-Objekten.
ClaimsMappingPolicy aktualisieren	Keine	Dient zum Aktualisieren eines claimsMappingPolicy-Objekts.
ClaimsMappingPolicy löschen	Keine	Löschen eines claimsMappingPolicy-Objekts.
Verzeichnisobjekte
Liste appliesTo	directoryObject-Sammlung	Rufen Sie die Liste der directoryObjects ab, auf die diese Richtlinie angewendet wurde.
Assign claimsMappingPolicy	Keine	Weisen Sie einem servicePrincipal-Objekt eine claimsMappingPolicy zu.
Zugewiesene ClaimsMappingPolicy auflisten	claimsMappingPolicy-Sammlung	Auflisten der claimsMappingPolicy-Objekte, die einem servicePrincipal-Objekt zugewiesen sind.
Remove claimsMappingPolicy	Keine	Entfernen Sie eine claimsMappingPolicy aus einem servicePrincipal-Objekt .

Eigenschaften

Eigenschaft	Typ	Beschreibung
id	Zeichenfolge	Eindeutiger Bezeichner für diese Richtlinie. Schreibgeschützt.
Definition	String-Sammlung	Eine Zeichenfolgensammlung mit einer JSON-Zeichenfolge, die die Regeln und Einstellungen für diese Richtlinie definiert. Weitere Informationen zum JSON-Schema für diese Eigenschaft finden Sie unter Eigenschaften einer Anspruchszuordnungsrichtliniendefinition . Erforderlich.
description	Zeichenfolge	Beschreibung für diese Richtlinie.
displayName	Zeichenfolge	Anzeigename für diese Richtlinie. Erforderlich.
isOrganizationDefault	Boolesch	Diese Eigenschaft ignorieren. Die Anspruchszuordnungsrichtlinie kann nur auf Dienstprinzipale angewendet und nicht global für die Organisation festgelegt werden.

Eigenschaften einer Anspruchszuordnungsrichtliniendefinition

Die folgenden Eigenschaften bilden das JSON-Objekt, das eine Anspruchszuordnungsrichtlinie darstellt. Dieses JSON-Objekt muss in eine Zeichenfolge mit Escapezeichen konvertiert werden, um in die Definitionseigenschaft eingefügt zu werden. Nachfolgend sind einige Definitionsbeispiele dargestellt:

Beispiel: Definition zum Einschließen von EmployeeID und TenantCountry als Ansprüche in Token

{
    "definition": [
        "{\"ClaimsMappingPolicy\":{\"Version\":1,\"IncludeBasicClaimSet\":\"true\",\"ClaimsSchema\": [{\"Source\":\"user\",\"ID\":\"employeeid\",\"SamlClaimType\":\"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name\",\"JwtClaimType\":\"name\"},{\"Source\":\"company\",\"ID\":\"tenantcountry\",\"SamlClaimType\":\"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/country\",\"JwtClaimType\":\"country\"}]}}"
    ],
    "displayName": "Test1234"
}

Beispiel: Definition , die eine Anspruchstransformation verwendet

{
    "definition": [
        "{\"ClaimsMappingPolicy\":{\"Version\":1,\"IncludeBasicClaimSet\":\"true\",\"ClaimsSchema\": [{\"Source\":\"user\",\"ID\":\"userprincipalname\",\"SamlClaimType\":\"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/nameidentifier\"},{\"Source\":\"user\",\"ID\":\"givenname\",\"SamlClaimType\":\"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/givenname\"},{\"Source\":\"user\",\"ID\":\"displayname\",\"SamlClaimType\":\"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/name\"},{\"Source\":\"user\",\"ID\":\"surname\",\"SamlClaimType\":\"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/surname\"},{\"Source\":\"user\",\"ID\":\"userprincipalname\",\"SamlClaimType\":\"username\"}],\"ClaimsTransformation\":[{\"ID\":\"CreateTermsOfService\",\"TransformationMethod\":\"CreateStringClaim\",\"InputParameters\": [{\"ID\":\"value\",\"DataType\":\"string\", \"Value\":\"sandbox\"}],\"OutputClaims\":[{\"ClaimTypeReferenceId\":\"TOS\",\"TransformationClaimType\":\"createdClaim\"}]}]}}"
    ],
    "displayName": "Test1234"
}

Eigenschaft	Typ	Beschreibung
Version	Ganzzahl	Legen Sie den Wert 1 fest. Erforderlich.
IncludeBasicClaimSet	Boolescher Wert	Wenn diese Einstellung festgelegt ist `true`, werden alle Ansprüche im grundlegenden Anspruchssatz in Token ausgegeben, die von der Richtlinie betroffen sind. Bei Festlegung auf `false`, befinden sich Ansprüche im grundlegenden Anspruchssatz nicht in den Token, es sei denn, sie werden einzeln in der ClaimsSchema-Eigenschaft derselben Richtlinie hinzugefügt.
ClaimsSchema	JSON-Objekt	Definiert, welche Ansprüche in den von der Richtlinie betroffenen Token vorhanden sind, zusätzlich zum grundlegenden Anspruchssatz und dem Kernanspruchssatz. Für jeden in dieser Eigenschaft definierten Anspruchsschemaeintrag sind bestimmte Informationen erforderlich. Geben Sie an, woher die Daten stammen (Wert- oder Quell-/ID-Paar) und welchen Anspruch die Daten als (Anspruchstyp) ausgibt. Maximal 50 Ansprüche werden über das ClaimsSchema-Objekt in das Token eingeschlossen. Alle Anspruchsschemaeinträge, die gefunden werden, nachdem der Grenzwert erreicht wurde, werden ignoriert und nicht im ausgestellten Token angezeigt. Weitere Details finden Sie in der ClaimsSchema-Definition.
ClaimsTransformation	JSON-Objekt	Definiert allgemeine Transformationen, die auf Quelldaten angewendet werden können, um die Ausgabedaten für im ClaimsSchema angegebene Ansprüche zu generieren. Über das ClaimsTransformation -Objekt sind maximal 50 Transformationen im Token enthalten. Alle Transformationen, die nach Erreichen des Grenzwerts auftreten, werden ignoriert und nicht im ausgestellten Token angezeigt. Weitere Informationen zu ClaimsTransformation und den unterstützten Funktionen finden Sie unter Claims transformation.

Beziehungen

Beziehung	Typ	Beschreibung
Appliesto	directoryObject-Sammlung	Die directoryObject-Auflistung , auf die diese Richtlinie angewendet wurde. Schreibgeschützt.

JSON-Darstellung

Es folgt eine JSON-Darstellung der Ressource.

{
  "definition": ["String"],
  "description": "String",
  "displayName": "String",
  "id": "String (identifier)",
  "isOrganizationDefault": false,
}