type de ressource claimsMappingPolicy

Espace de noms: microsoft.graph

Représente les stratégies de mappage des revendications pour les protocoles WS-Fed, SAML, OAuth 2.0 et OpenID Connecter, pour les jetons émis à une application spécifique. Vous pouvez utiliser des stratégies de mappage de revendications pour :

  • Sélectionner les revendications incluses dans les jetons
  • Créer des types de revendications qui n’existent pas déjà
  • Choisir ou modifier la source de données émises dans des revendications spécifiques

Le nombre de revendications et de transformations qui peuvent être ajoutées à une stratégie de mappage de revendications est limité pour réduire la taille des jetons. Toutes les entrées ou transformations de schéma de revendications rencontrées une fois la limite atteinte sont ignorées et incluses dans le jeton émis. Pour plus d’informations sur les limites, consultez Propriétés d’une définition de stratégie de mappage de revendications

Pour plus d’informations sur le scénario et la configuration, consultez Le type de stratégie de mappage des revendications et comment : personnaliser les revendications émises dans les jetons d’une application spécifique dans un locataire.

Hérite de stsPolicy.

Méthodes

Méthode Type renvoyé Description
Créer claimsMappingPolicy claimsMappingPolicy Créez un objet claimsMappingPolicy.
Get claimsMappingPolicy claimsMappingPolicy Lit les propriétés et les relations d’un objet claimsMappingPolicy.
Liste de claimsMappingPolicies claimsMappingPolicy Lit les propriétés et les relations des objets claimsMappingPolicies.
Mettre à jour claimsMappingPolicy Aucune Mettez à jour un objet claimsMappingPolicy.
Supprimer claimsMappingPolicy Aucune Supprimez un objet claimsMappingPolicy.
Objets d’annuaire
List appliesTo collection directoryObject Obtenez la liste des directoryObjects auxquels cette stratégie a été appliquée.
Attribuer claimsMappingPolicy Aucune Affectez une claimsMappingPolicy à un objet servicePrincipal .
List assigned claimsMappingPolicy Collection de claimsMappingPolicy Répertoriez les objets claimsMappingPolicy qui sont affectés à un objet servicePrincipal .
Supprimer la claimsMappingPolicy Aucune Supprimez une claimsMappingPolicy d’un objet servicePrincipal .

Propriétés

Propriété Type Description
id Chaîne Identificateur unique pour cette stratégie. En lecture seule.
Définition String collection Collection de chaînes contenant une chaîne JSON qui définit les règles et les paramètres de cette stratégie. Pour plus d’informations sur le schéma JSON de cette propriété, consultez Propriétés d’une définition de stratégie de mappage de revendications . Obligatoire.
description Chaîne Description de cette stratégie.
displayName Chaîne Nom d’affichage de cette stratégie. Obligatoire.
isOrganizationDefault Booléen Ignorez cette propriété. La stratégie de mappage des revendications ne peut être appliquée qu’aux principaux de service et ne peut pas être définie globalement pour l’organisation.

Propriétés d’une définition de stratégie de mappage de revendications

Les propriétés ci-dessous forment l’objet JSON qui représente une stratégie de mappage des revendications. Cet objet JSON doit être converti en chaîne avec des guillemets placés dans une séquence d’échappement pour être inséré dans la propriété de définition . Quelques exemples de définition sont présentés ci-dessous :

Exemple : définition d’inclure EmployeeID et TenantCountry en tant que revendications dans les jetons

{
    "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"
}

Exemple : définition qui utilise une transformation de revendications

{
    "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"
}
Propriété Type Description
Version Entier Définissez la valeur 1. Obligatoire.
IncludeBasicClaimSet Booléen Si la valeur est définie true, toutes les revendications du jeu de revendications de base sont émises dans les jetons affectés par la stratégie. Si la valeur est définie falsesur , les revendications du jeu de revendications de base ne figurent pas dans les jetons, sauf si elles sont ajoutées individuellement dans la propriété ClaimsSchema de la même stratégie.
ClaimsSchema Objet JSON Définit les revendications présentes dans les jetons affectés par la stratégie, en plus du jeu de revendications de base et du jeu de revendications de base. Pour chaque entrée de schéma de revendication définie dans cette propriété, certaines informations sont requises. Spécifiez d’où proviennent les données (paire Valeur ou Source/ID) et quelles revendications les données sont émises en tant que (Type de revendication). Un maximum de 50 revendications sont incluses dans le jeton via l’objet ClaimsSchema. Toutes les entrées de schéma de revendication rencontrées une fois la limite atteinte seront ignorées et n’apparaîtront pas dans le jeton émis. Des détails supplémentaires sont disponibles dans la définition claimsSchema.
ClaimsTransformation Objet JSON Définit les transformations courantes qui peuvent être appliquées aux données sources afin de générer les données de sortie pour les revendications spécifiées dans ClaimsSchema. Un maximum de 50 transformations sont incluses dans le jeton via l’objet ClaimsTransformation. Toutes les transformations rencontrées une fois la limite atteinte sont ignorées et n’apparaissent pas dans le jeton émis. Pour plus d’informations sur ClaimsTransformation et les fonctions prises en charge, consultez Transformation des revendications.

Relations

Relation Type Description
appliesTo collection directoryObject Collection directoryObject à laquelle cette stratégie a été appliquée. En lecture seule.

Représentation JSON

Voici une représentation JSON de la ressource.

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