Ressourcentyp "claimsMappingPolicy"

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 WS-Fed-, SAML-, OAuth 2.0- und OpenID Connect-Protokolle für Token dar, die für eine bestimmte Anwendung ausgestellt wurden. Sie können Anspruchszuordnungsrichtlinien für Folgendes verwenden:

  • Wählen Sie aus, welche Ansprüche in Token enthalten sind.
  • Erstellen von Anspruchstypen, die noch nicht vorhanden sind
  • Wählen Sie die Quelle der in bestimmten Ansprüchen ausgegebenen Daten aus, oder ändern Sie sie.

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 nach Erreichen des Grenzwerts auftreten, werden ignoriert und sind nicht im ausgestellten Token enthalten. Weitere Informationen zu den Grenzwerten finden Sie unter Eigenschaften einer Anspruchszuordnungsrichtliniendefinition.

Erbt von stsPolicy.

Weitere Szenarien und Konfigurationsdetails finden Sie in den folgenden Artikeln:

Methoden

Methode Rückgabetyp Beschreibung
List claimsMappingPolicy Lesen Sie Eigenschaften und Beziehungen von claimsMappingPolicies-Objekten.
Create claimsMappingPolicy Erstellen Sie ein claimsMappingPolicy-Objekt.
Get claimsMappingPolicy Lesen von Eigenschaften und Beziehungen eines claimsMappingPolicy-Objekts.
Update Keine Aktualisieren Sie ein claimsMappingPolicy-Objekt.
Löschen Keine Löschen Sie ein claimsMappingPolicy-Objekt.
Liste gilt für directoryObject collection Rufen Sie die Liste der directoryObjects ab, für die diese Richtlinie gilt.
Dem Dienstprinzipal zuweisen Keine Weisen Sie einem servicePrincipal-Objekt eine claimsMappingPolicy zu.
Dem Dienstprinzipal zugewiesene Liste claimsMappingPolicy-Sammlung Listen Sie 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 Zeichenfolge Eindeutiger Bezeichner für diese Richtlinie. Schreibgeschützt.
Definition String collection Eine Zeichenfolgensammlung, 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 Richtliniendefinition für die Anspruchszuordnung. Erforderlich.
displayName Zeichenfolge Anzeigename für diese Richtlinie. Erforderlich.
isOrganizationDefault Boolean Diese Eigenschaft ignorieren. Die Anspruchszuordnungsrichtlinie kann nur auf Dienstprinzipale angewendet und nicht global für die organization festgelegt werden.

Eigenschaften einer Richtliniendefinition für die Anspruchszuordnung

Das JSON-Objekt, das in die definitionseigenschaft eingefügt werden soll, muss zuerst in eine Zeichenfolge mit Escape-Zeichen für Anführungszeichen konvertiert werden. Dieser Abschnitt enthält einige Definitionsbeispiele.

Beispiel: Definition , um EmployeeID und TenantCountry als Ansprüche in Token einzuschließen

{
    "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 Integer Legen Sie den Wert "1" fest. Erforderlich.
IncludeBasicClaimSet Boolean Wenn festgelegt auf true, werden alle Ansprüche im grundlegenden Anspruchssatz in Token ausgegeben, die von der Richtlinie betroffen sind. Wenn festgelegt 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 zusätzlich zum Basisanspruchssatz und dem Kernanspruchssatz vorhanden sind. 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 als welcher Anspruch die Daten ausgegeben werden (Anspruchstyp). Über das ClaimsSchema-Objekt sind maximal 50 Ansprüche im Token enthalten. Alle Anspruchsschemaeinträge, die nach Erreichen des Grenzwerts auftreten, werden ignoriert und nicht im ausgestellten Token angezeigt. Weitere Informationen finden Sie in der ClaimsSchema-Definition und in den Eigenschaften der Richtlinie, die zur Anspruchsanpassung verwendet wird.
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 auftreten, werden ignoriert und werden nicht im ausgegebenen Token angezeigt. Weitere Informationen zu ClaimsTransformation und den unterstützten Funktionen finden Sie unter Anspruchstransformation.

Beziehungen

Beziehung Typ Beschreibung
appliesTo directoryObject collection Die directoryObject-Sammlung , für die diese Richtlinie gilt. Schreibgeschützt.

JSON-Darstellung

Die folgende JSON-Darstellung veranschaulicht den Ressourcentyp.

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