Erstellen von „federatedIdentityCredential“

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.

Erstellen Sie ein neues federatedIdentityCredential-Objekt für eine Anwendung oder einen agentIdentityBlueprint.

Indem Sie eine Vertrauensstellung zwischen Ihrer Microsoft Entra-Anwendungsregistrierung oder Agentidentitätsblaupause und dem Identitätsanbieter für Ihre Computeplattform konfigurieren, können Sie von dieser Plattform ausgestellte Token verwenden, um sich bei der Microsoft Identity Platform zu authentifizieren und APIs im Microsoft-Ökosystem aufzurufen. Maximal 20 Objekte können einer Blaupause für Anwendungs- oder Agentidentitäten hinzugefügt werden.

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Weltweiter Service US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet

Berechtigungen

Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungen für eine Anwendung

Berechtigungstyp Berechtigungen mit den geringsten Berechtigungen Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto) Application.ReadWrite.All Nicht verfügbar.
Delegiert (persönliches Microsoft-Konto) Application.ReadWrite.All Nicht verfügbar.
Application Application.ReadWrite.OwnedBy Application.ReadWrite.All

Wichtig

Für den delegierten Zugriff mit Geschäfts-, Schul- oder Unikonten muss dem angemeldeten Benutzer eine unterstützte Microsoft Entra-Rolle oder eine benutzerdefinierte Rolle zugewiesen werden, die die für diesen Vorgang erforderlichen Berechtigungen gewährt. Dieser Vorgang unterstützt die folgenden integrierten Rollen, die nur die geringstmöglichen Berechtigungen gewähren:

  • Ein Nicht-Administrator-Mitgliedsbenutzer mit Standardbenutzerberechtigungen – für Anwendungen, deren Besitzer
  • Anwendungsentwickler - für Anwendungen, die sie besitzen
  • Cloudanwendungsadministrator
  • Anwendungsadministrator

Berechtigungen für einen agentIdentityBlueprint

Berechtigungstyp Berechtigung mit den geringsten Berechtigungen Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto) AgentIdentityBlueprint.Create AgentIdentityBlueprint.ReadWrite.All, Directory.ReadWrite.All
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt Nicht unterstützt
Application AgentIdentityBlueprint.Create AgentIdentityBlueprint.ReadWrite.All, Directory.ReadWrite.All

Wichtig

  • Ein Prinzipal, der eine Agentidentität, eine Blaupause oder einen Blaupausenprinzipal erstellt, wird automatisch als Besitzer zugewiesen.
  • Besitzer können Agentidentitäten erstellen und ändern, die einer Blaupause zugeordnet sind, die sie besitzen, ohne dass ihnen eine Agent-ID-Rolle zugewiesen wird.
  • Damit Nichtbesitzer diese API in delegierten Szenarien mit Geschäfts-, Schul- oder Unikonten aufrufen können, muss dem Administrator eine Rolle für den unterstützten Microsoft Entra zugewiesen werden. Dieser Vorgang unterstützt die folgende integrierte Rolle mit den geringsten Berechtigungen:

HTTP-Anforderung

Für eine Anwendung:

  • Sie können die Anwendung entweder mit ihrer ID oder appId ansprechen. ID und appId werden bei App-Registrierungen im Microsoft Entra Admin Center als Objekt-ID bzw. Anwendungs-ID (Client-ID) bezeichnet.
POST /applications/{id}/federatedIdentityCredentials
POST /applications(appId='{appId}')/federatedIdentityCredentials

Für einen agentIdentityBlueprint:

POST /applications/{id}/microsoft.graph.agentIdentityBlueprint/federatedIdentityCredentials

Anforderungsheader

Name Beschreibung
Authorization Bearer {token}. Erforderlich. Erfahren Sie mehr über Authentifizierung und Autorisierung.
Content-Type application/json. Erforderlich.

Anforderungstext

Geben Sie im Anforderungstext eine JSON-Darstellung des federatedIdentityCredential-Objekts an.

In der folgenden Tabelle sind die Eigenschaften aufgeführt, die beim Erstellen von federatedIdentityCredential erforderlich sind.

Eigenschaft Typ Beschreibung
Benutzergruppen Zeichenfolgensammlung Erforderlich. Die Zielgruppe, die im externen Token angezeigt werden kann. Dieses Feld ist obligatorisch und sollte für Microsoft Entra ID festgelegt api://AzureADTokenExchange werden. Es gibt an, was die Microsoft Identity Platform im aud Anspruch im eingehenden Token akzeptieren soll. Dieser Wert stellt die Microsoft Entra ID in Ihrem externen Identitätsanbieter dar und hat keinen festen Wert für alle Identitätsanbieter – möglicherweise müssen Sie eine neue Anwendungsregistrierung bei Ihrem Identitätsanbieter erstellen, um als Zielgruppe dieses Tokens zu dienen. Dieses Feld akzeptiert nur einen einzelnen Wert und ist auf 600 Zeichen beschränkt.
claimsMatchingExpression federatedIdentityExpression Nullwerte zulassend. Standardwerte sind null , wenn nicht festgelegt. Ermöglicht die Verwendung von Ansprüchen, die mit Ausdrücken übereinstimmen, die mit angegebenen Ansprüchen übereinstimmen. Wenn claimsMatchingExpression definiert ist, muss der Antragsteller sein null. Eine Liste der unterstützten Ausdruckssyntax und Ansprüche finden Sie in der Referenz zu flexiblen FIC.
Aussteller Zeichenfolge Erforderlich. Die URL des externen Identitätsanbieters und muss mit dem Ausstelleranspruch des ausgetauschten externen Tokens übereinstimmen. Die Kombination der Werte " Aussteller " und "Antragsteller " muss in der App eindeutig sein. Die maximale Länge beträgt 600 Zeichen.
name Zeichenfolge Erforderlich. Der eindeutige Bezeichner für die Anmeldeinformationen für die Verbundidentität, der maximal 120 Zeichen umfasst und URL-freundlich sein muss. Er ist unveränderlich, sobald er erstellt wurde.
subject Zeichenfolge Nullwerte zulassend. Standardwerte sind null , wenn nicht festgelegt. Der Bezeichner der externen Softwareworkload innerhalb des externen Identitätsanbieters. Wie der Zielgruppenwert hat er kein festes Format, da jeder Identitätsanbieter sein eigenes Format verwendet – manchmal eine GUID, manchmal einen durch Doppelpunkte getrennten Bezeichner, manchmal beliebige Zeichenfolgen. Der Wert hier muss mit dem Unteranspruch innerhalb des Tokens übereinstimmen, das Microsoft Entra ID präsentiert wird. Die maximale Länge beträgt 600 Zeichen. Die Kombination aus Aussteller und Antragsteller muss in der App eindeutig sein. Wenn ein Antragsteller definiert ist, muss claimsMatchingExpression sein null.

Antwort

Bei erfolgreicher Ausführung gibt diese Methode einen 201 Created Antwortcode und ein federatedIdentityCredential-Objekt im Antworttext zurück.

Beispiele

Beispiel 1: Erstellen von Verbundidentitäts-Anmeldeinformationen für eine Anwendung

Anforderung

POST https://graph.microsoft.com/beta/applications/bcd7c908-1c4d-4d48-93ee-ff38349a75c8/federatedIdentityCredentials/
Content-Type: application/json

{
    "name": "testing02",
    "issuer": "https://login.microsoftonline.com/3d1e2be9-a10a-4a0c-8380-7ce190f98ed9/v2.0",
    "subject": "a7d388c3-5e3f-4959-ac7d-786b3383006a",
    "audiences": [
        "api://AzureADTokenExchange"
    ]
}

Antwort

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

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",
    "@odata.id": "https://graph.microsoft.com/v2/3d1e2be9-a10a-4a0c-8380-7ce190f98ed9/directoryObjects/$/Microsoft.DirectoryServices.Application('bcd7c908-1c4d-4d48-93ee-ff38349a75c8')/federatedIdentityCredentials/d9b7bf1e-429e-4678-8132-9b00c9846cc4",
    "id": "d9b7bf1e-429e-4678-8132-9b00c9846cc4",
    "name": "testing02",
    "issuer": "https://login.microsoftonline.com/3d1e2be9-a10a-4a0c-8380-7ce190f98ed9/v2.0",
    "subject": "a7d388c3-5e3f-4959-ac7d-786b3383006a",
    "description": null,
    "audiences": [
        "api://AzureADTokenExchange"
    ]
}

Beispiel 2: Erstellen von Verbundidentitätsanmeldeinformationen für eine agentIdentityBlueprint

Anforderung

POST https://graph.microsoft.com/beta/applications/bcd7c908-1c4d-4d48-93ee-ff38349a75c8/microsoft.graph.agentIdentityBlueprint/federatedIdentityCredentials/
Content-Type: application/json

{
    "name": "testing02",
    "issuer": "https://login.microsoftonline.com/3d1e2be9-a10a-4a0c-8380-7ce190f98ed9/v2.0",
    "subject": "a7d388c3-5e3f-4959-ac7d-786b3383006a",
    "audiences": [
        "api://AzureADTokenExchange"
    ]
}

Antwort

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

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",
    "@odata.id": "https://graph.microsoft.com/v2/3d1e2be9-a10a-4a0c-8380-7ce190f98ed9/directoryObjects/$/Microsoft.DirectoryServices.Application('bcd7c908-1c4d-4d48-93ee-ff38349a75c8')/federatedIdentityCredentials/d9b7bf1e-429e-4678-8132-9b00c9846cc4",
    "id": "d9b7bf1e-429e-4678-8132-9b00c9846cc4",
    "name": "testing02",
    "issuer": "https://login.microsoftonline.com/3d1e2be9-a10a-4a0c-8380-7ce190f98ed9/v2.0",
    "subject": "a7d388c3-5e3f-4959-ac7d-786b3383006a",
    "description": null,
    "audiences": [
        "api://AzureADTokenExchange"
    ]
}