Remarque
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de vous connecter ou de modifier des répertoires.
L’accès à cette page nécessite une autorisation. Vous pouvez essayer de modifier des répertoires.
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 .
Créez un objet federatedIdentityCredential pour une application ou un agentIdentityBlueprint s’il n’existe pas, ou mettez à jour les propriétés d’un objet federatedIdentityCredential existant.
En configurant une relation d’approbation entre votre inscription d’application Microsoft Entra ou agentIdentityBlueprint et le fournisseur d’identité de votre plateforme de calcul, vous pouvez utiliser les jetons émis par cette plateforme pour vous authentifier auprès de Plateforme d'identités Microsoft et appeler des API dans l’écosystème Microsoft. Un maximum de 20 objets peuvent être ajoutés à une application ou à agentIdentityBlueprint.
Cette API est disponible dans les déploiements cloud nationaux suivants.
| Service global | Gouvernement américain L4 | Gouvernement américain L5 (DOD) | Chine exploitée par 21Vianet |
|---|---|---|---|
| ✅ | ✅ | ✅ | ✅ |
Autorisations
Choisissez l’autorisation ou les autorisations marquées comme étant les moins privilégiées pour cette API. Utilisez une ou plusieurs autorisations privilégiées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, voir Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez la référence des autorisations.
Autorisations pour une application
| Type d’autorisation | Autorisations les moins privilégiées | Autorisations à privilèges plus élevés |
|---|---|---|
| Déléguée (compte professionnel ou scolaire) | Application.ReadWrite.All | Non disponible. |
| Déléguée (compte Microsoft personnel) | Application.ReadWrite.All | Non disponible. |
| Application | Application.ReadWrite.OwnedBy | Application.ReadWrite.All |
Importante
Pour l’accès délégué à l’aide de comptes professionnels ou scolaires, l’utilisateur connecté doit disposer d’un rôle Microsoft Entra pris en charge ou d’un rôle personnalisé qui accorde les autorisations requises pour cette opération. Cette opération prend en charge les rôles intégrés suivants, qui n’offrent que le moindre privilège nécessaire :
- Un utilisateur membre non administrateur disposant des autorisations d’utilisateur par défaut pour les applications dont il est propriétaire
- Développeur d’applications : pour les applications dont il est propriétaire
- Administrateur de l'application cloud
- Administrateur de l'application
Autorisations pour un agentIdentityBlueprint
| Type d’autorisation | Autorisation de moindre privilège | Autorisations à privilèges plus élevés |
|---|---|---|
| Déléguée (compte professionnel ou scolaire) | AgentIdentityBlueprint.ReadWrite.All | Directory.ReadWrite.All |
| Déléguée (compte Microsoft personnel) | Non prise en charge. | Non prise en charge. |
| Application | AgentIdentityBlueprint.ReadWrite.All | Directory.ReadWrite.All |
Importante
- Un principal qui crée un blueprint d’identité d’agent ou un blueprint principal est automatiquement affecté en tant que propriétaire.
- Les propriétaires peuvent créer et modifier des identités d’agent associées à un blueprint dont ils sont propriétaires sans qu’un rôle d’ID d’agent ne leur soit attribué.
- Pour que les non-propriétaires puissent appeler cette API dans des scénarios de délégation à l’aide de comptes professionnels ou scolaires, un rôle Microsoft Entra pris en charge doit être attribué à l’administrateur. Cette opération prend en charge le rôle intégré de moindre privilège suivant :
Requête HTTP
Pour une application :
- Vous pouvez vous adresser à l’application à l’aide de son ID ou de son AppId. id et appId sont appelés respectivement ID d’objet et ID d’application (client) dans les inscriptions d’applications dans le centre d’administration Microsoft Entra.
PATCH /applications/{id}/federatedIdentityCredentials(name='{name}')
PATCH /applications(appId='{appId}')/federatedIdentityCredentials(name='{name}')
Pour un agentIdentityBlueprint :
PATCH /applications/{id}/microsoft.graph.agentIdentityBlueprint/federatedIdentityCredentials(name='{name}')
En-têtes de demande
| Nom | Description |
|---|---|
| Autorisation | Porteur {token}. Obligatoire. En savoir plus sur l’authentification et les autorisations. |
| Content-Type | application/json. Obligatoire. |
| Préférence |
create-if-missing. Obligatoire pour le comportement de mise à jour, sinon la demande est traitée comme une opération de mise à jour. |
Corps de la demande
Dans le corps de la demande, fournissez une représentation JSON de l’objet federatedIdentityCredential .
Le tableau suivant répertorie les propriétés qui sont requises lorsque vous créez federatedIdentityCredential. Notez que la propriété name est requise dans le cadre de l’URL de requête.
| Propriété | Type | Description |
|---|---|---|
| Audiences publiques | String collection | Public pouvant apparaître dans le jeton externe. Ce champ est obligatoire et doit être défini api://AzureADTokenExchange sur Microsoft Entra ID. Il indique ce que Plateforme d'identités Microsoft devez accepter dans la aud réclamation dans le jeton entrant. Cette valeur représente Microsoft Entra ID dans votre fournisseur d’identité externe et n’a pas de valeur fixe entre les fournisseurs d’identité. Vous devrez peut-être créer une inscription d’application dans votre fournisseur d’identité pour servir d’audience de ce jeton. Ce champ ne peut accepter qu’une seule valeur et sa limite est de 600 caractères. Obligatoire. |
| claimsMatchingExpression | federatedIdentityExpression | Pouvant accepter la valeur Null. Par défaut si null non défini. Permet d’utiliser des expressions de correspondance de revendications avec des revendications spécifiées. Si claimsMatchingExpression est défini, le sujet doit être null. Pour obtenir la liste de la syntaxe et des revendications d’expression prises en charge, consultez la référence FIC flexible. |
| de l’émetteur | String | L’URL du fournisseur d’identité externe doit correspondre à la revendication de l’émetteur du jeton externe échangé. La combinaison des valeurs de l’émetteur et du sujet doit être unique sur l’application. Il a une limite de 600 caractères. Obligatoire. |
| sujet | String | Pouvant accepter la valeur Null. Par défaut si null non défini. Identifiant de la charge de travail logicielle externe dans le fournisseur d’identité externe. Comme la valeur d’audience, il n’a pas de format fixe, car chaque fournisseur d’identité utilise son propre format - parfois un GUID, parfois un identificateur délimité par les deux-points, parfois des chaînes arbitraires. La valeur ici doit correspondre à la sous-revendication dans le jeton présenté à Microsoft Entra ID. Il a une limite de 600 caractères. La combinaison de l’émetteur et du sujet doit être unique sur l’application. Si subject est défini, claimsMatchingExpression doit être null. |
Réponse
En cas de réussite, si un objet d’application avec nom n’existe pas, cette méthode retourne un 201 Created code de réponse et un nouvel objet federatedIdentityCredential dans le corps de la réponse.
Si un objet d’application avec un nom existe déjà, cette méthode met à jour l’objet federatedIdentityCredential et retourne un 204 No Content code de réponse.
Exemples
Exemple 1 : créer un federatedIdentityCredential pour une application si elle n’existe pas
L’exemple suivant crée un federatedIdentityCredential, car il n’existe pas de federatedIdentityCredential avec la valeur de nom spécifiée.
Demande
L’exemple suivant illustre une demande.
PATCH https://graph.microsoft.com/beta/applications(uniqueName='app-65278')/federatedIdentityCredentials(name='fic01-app-65278')
Content-Type: application/json
{
"issuer": "https://login.microsoftonline.com/3d1e2be9-a10a-4a0c-8380-7ce190f98ed9/v2.0",
"subject": "a7d388c3-5e3f-4959-ac7d-786b3383006a",
"audiences": [
"api://AzureADTokenExchange"
]
}
Réponse
L’exemple suivant illustre la réponse.
Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.
HTTP/1.1 201 Created
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#applications('bcd7c908-1c4d-4d48-93ee-ff38349a75c8')/federatedIdentityCredentials/$entity",
"id": "d9b7bf1e-429e-4678-8132-9b00c9846cc4",
"name": "testing02fic01-app-65278",
"issuer": "https://login.microsoftonline.com/3d1e2be9-a10a-4a0c-8380-7ce190f98ed9/v2.0",
"subject": "a7d388c3-5e3f-4959-ac7d-786b3383006a",
"description": null,
"audiences": [
"api://AzureADTokenExchange"
]
}
Exemple 2 : mise à jour d’un federatedIdentityCredential existant pour une application
L’exemple suivant met à jour federatedIdentityCredential, car il existe une federatedIdentityCredential avec la valeur de nom spécifiée.
Demande
L’exemple suivant illustre une demande.
PATCH https://graph.microsoft.com/beta/applications(uniqueName='app-65278')/federatedIdentityCredentials(name='fic01-app-65278')
Content-Type: application/json
Prefer: create-if-missing
{
"issuer": "https://login.microsoftonline.com/3d1e2be9-a10a-4a0c-8380-7ce190f98ed9/v2.0",
"subject": "a7d388c3-5e3f-4959-ac7d-786b3383006a",
"audiences": [
"api://AzureADTokenExchange"
]
}
Réponse
L’exemple suivant illustre la réponse.
HTTP/1.1 204 No Content
Exemple 3 : créer un federatedIdentityCredential pour un agentIdentityBlueprint s’il n’existe pas
L’exemple suivant crée un federatedIdentityCredential pour un agentIdentityBlueprint, car il n’existe pas de federatedIdentityCredential avec la valeur de nom spécifiée.
Demande
L’exemple suivant illustre une demande.
PATCH https://graph.microsoft.com/beta/applications(uniqueName='app-65278')/microsoft.graph.agentIdentityBlueprint/federatedIdentityCredentials(name='fic01-app-65278')
Content-Type: application/json
{
"issuer": "https://login.microsoftonline.com/3d1e2be9-a10a-4a0c-8380-7ce190f98ed9/v2.0",
"subject": "a7d388c3-5e3f-4959-ac7d-786b3383006a",
"audiences": [
"api://AzureADTokenExchange"
]
}
Réponse
L’exemple suivant illustre la réponse.
Remarque : l’objet de réponse affiché ci-après peut être raccourci pour plus de lisibilité.
HTTP/1.1 201 Created
Content-Type: application/json
{
"@odata.context": "https://graph.microsoft.com/beta/$metadata#applications('bcd7c908-1c4d-4d48-93ee-ff38349a75c8')/federatedIdentityCredentials/$entity",
"id": "d9b7bf1e-429e-4678-8132-9b00c9846cc4",
"name": "testing02fic01-app-65278",
"issuer": "https://login.microsoftonline.com/3d1e2be9-a10a-4a0c-8380-7ce190f98ed9/v2.0",
"subject": "a7d388c3-5e3f-4959-ac7d-786b3383006a",
"description": null,
"audiences": [
"api://AzureADTokenExchange"
]
}