claimsMappingPolicy-Ressourcentyp

Artikel
10/14/2024

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 die Anspruchszuordnungsrichtlinien für die Protokolle WS-Fed, SAML, OAuth 2.0 und OpenID Connect für Token dar, die für eine bestimmte Anwendung ausgestellt werden. 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 Quelle der in bestimmten Ansprüchen ausgegebenen Daten

Die Anzahl der Ansprüche und Transformationen, die einer Anspruchszuordnungsrichtlinie hinzugefügt werden können, ist begrenzt, um die Tokengröße zu reduzieren. Alle Anspruchsschemaeinträge oder Transformationen, die gefunden werden, nachdem der Grenzwert erreicht wurde, 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 Anspruchszuordnungsrichtlinientyp und Vorgehensweise: Anpassen von Ansprüchen, die in Token für eine bestimmte App in einem Mandanten ausgegeben werden.

Besuchen Sie darüber hinaus Die Anspruchsanpassung mithilfe einer Richtlinie , um den Unterschied zwischen dieser Richtlinie und der richtlinie für benutzerdefinierte Ansprüche zu erfahren.

Erbt von stsPolicy.

Methoden

Methode	Rückgabetyp	Beschreibung
List	claimsMappingPolicy	Lesen von Eigenschaften und Beziehungen von claimsMappingPolicies-Objekten.
Create	claimsMappingPolicy	Erstellen Sie ein claimsMappingPolicy-Objekt.
Get	claimsMappingPolicy	Liest Eigenschaften und Beziehungen eines claimsMappingPolicy-Objekts.
Update	Keine	Aktualisieren eines claimsMappingPolicy-Objekts.
Delete	Keine	Löschen sie ein claimsMappingPolicy-Objekt.
Liste gilt für	directoryObject collection	Rufen Sie die Liste der directoryObjects ab, auf die diese Richtlinie angewendet wurde.
Dem Dienstprinzipal zuweisen	Keine	Weisen Sie einem servicePrincipal-Objekt eine claimsMappingPolicy zu.
Dem Dienstprinzipal zugewiesene Liste	claimsMappingPolicy-Sammlung	Listet die claimsMappingPolicy-Objekte auf, die einem servicePrincipal-Objekt zugewiesen sind.
Aufheben der Zuweisung vom Dienstprinzipal	Keine	Entfernen Sie eine claimsMappingPolicy aus einem servicePrincipal-Objekt .

Eigenschaften

Eigenschaft	Typ	Beschreibung
id	String	Eindeutiger Bezeichner für diese Richtlinie. Schreibgeschützt.
Definition	String collection	Eine Zeichenfolgenauflistung, die eine JSON-Zeichenfolge enthält, 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.
displayName	String	Anzeigename für diese Richtlinie. Erforderlich.
isOrganizationDefault	Boolesch	Ignorieren Sie diese Eigenschaft. Die Anspruchszuordnungsrichtlinie kann nur auf Dienstprinzipale angewendet und nicht global für die organization festgelegt werden.

Eigenschaften einer Anspruchszuordnungsrichtliniendefinition

Das JSON-Objekt, das in die Definitionseigenschaft eingefügt werden soll, muss zuerst in eine Zeichenfolge mit Escapezeichen für Anführungszeichen konvertiert werden. In diesem Abschnitt werden einige Definitionsbeispiele gezeigt.

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	Ganze Zahl	Legen Sie den Wert 1 fest. Erforderlich.
IncludeBasicClaimSet	Boolesch	Wenn auf `true`festgelegt ist, werden alle Ansprüche im grundlegenden Anspruchssatz in Token ausgegeben, die von der Richtlinie betroffen sind. Wenn auf `false`festgelegt ist, 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 Anspruchsschemaeintrag, der in dieser Eigenschaft definiert ist, sind bestimmte Informationen erforderlich. Geben Sie an, woher die Daten stammen (Wert- oder Quell-ID-Paar) und welchen Anspruch die Daten ausgegeben werden (Anspruchstyp). Über das ClaimsSchema-Objekt sind maximal 50 Ansprüche im Token enthalten. Alle Anspruchsschemaeinträge, die gefunden werden, nachdem der Grenzwert erreicht wurde, werden ignoriert und werden nicht im ausgestellten Token angezeigt. Weitere Informationen finden Sie in der ClaimsSchema-Definition.
ClaimsTransformation	JSON-Objekt	Definiert allgemeine Transformationen, die auf Quelldaten angewendet werden können, um die Ausgabedaten für ansprüche zu generieren, die im ClaimsSchema angegeben sind. Über das ClaimsTransformation-Objekt sind maximal 50 Transformationen im Token enthalten. Alle Transformationen, die nach Erreichen des Grenzwerts gefunden werden, werden ignoriert und werden nicht im ausgestellten Token angezeigt. Weitere Informationen zu ClaimsTransformation und den unterstützten Funktionen finden Sie unter Anspruchstransformation.

Beziehungen

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

JSON-Darstellung

Die folgende JSON-Darstellung veranschaulicht den Ressourcentyp.

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

Freigeben über