Type de ressource claimsMappingPolicy

Article
07/16/2024

Espace de noms: microsoft.graph

Importante

Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .

Représente les stratégies de mappage de revendications pour les protocoles WS-Fed, SAML, OAuth 2.0 et OpenID Connect, pour les jetons émis pour 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 encore
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 du jeton. Toutes les entrées ou transformations de schéma de revendications qui sont 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 Type de stratégie de mappage de revendications et Guide pratique pour personnaliser les revendications émises dans des jetons pour une application spécifique dans un locataire.

En outre, consultez Personnalisation des revendications à l’aide d’une stratégie pour découvrir la différence entre cette stratégie et la stratégie de revendications personnalisées.

Hérite de stsPolicy.

Méthodes

Méthode	Type renvoyé	Description
List	claimsMappingPolicy	Lit les propriétés et les relations des objets claimsMappingPolicies.
Create	claimsMappingPolicy	Créez un objet claimsMappingPolicy.
Obtenir	claimsMappingPolicy	Lit les propriétés et les relations d’un objet claimsMappingPolicy.
Mettre à jour	Aucun	Mettre à jour un objet claimsMappingPolicy.
Supprimer	Aucune	Supprime un objet claimsMappingPolicy.
La liste s’applique à	collection directoryObject	Obtenez la liste des directoryObjects auxquels cette stratégie a été appliquée.
Affecter au principal de service	Aucune	Affectez un claimsMappingPolicy à un objet servicePrincipal .
Liste attribuée au principal de service	Collection de claimsMappingPolicy	Répertorie les objets claimsMappingPolicy qui sont affectés à un objet servicePrincipal .
Annuler l’affectation d’un principal de service	Aucune	Supprimez un 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.
displayName	Chaîne	Nom d’affichage de cette stratégie. Obligatoire.
isOrganizationDefault	Valeur booléenne	Ignorez cette propriété. La stratégie de mappage de revendications ne peut être appliquée qu’aux principaux de service et ne peut pas être définie globalement pour le organization.

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

L’objet JSON à insérer dans la propriété de définition doit d’abord être converti en chaîne avec des guillemets placés dans une séquence d’échappement. Cette section présente quelques exemples de définition.

Exemple : définition pour 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	Valeur booléenne	Si la `true`valeur est , toutes les revendications de l’ensemble de revendications de base sont émises dans des jetons affectés par la stratégie. `false`Si la valeur est , les revendications du jeu de revendications de base ne figurent pas dans les jetons, sauf si elles sont ajoutées individuellement à 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 de l’ensemble 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 (valeur ou paire Source/ID) et quelle revendication 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 revendications rencontrées une fois la limite atteinte sont ignorées et n’apparaissent pas dans le jeton émis. Pour plus d’informations, consultez 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

La représentation JSON suivante montre le type de ressource.

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

Partager via