identityApiConnector-Ressourcentyp

Namespace: microsoft.graph

Wichtig

APIs unter der /beta Version in Microsoft Graph können geändert werden. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in Version 1.0 verfügbar ist, verwenden Sie die Versionsauswahl .

Stellt API-Connectors in einem Azure Active Directory (Azure AD) und Azure AD B2C-Mandanten dar.

Mit einem API-Connector, der in Ihrer Azure AD External Identities-Self-Service-Anmeldung und azure AD B2C-Anmeldebenutzerflüssen verwendet wird, können Sie während der Ausführung des Benutzerflusses eine API aufrufen. Ein API-Connector stellt die Informationen bereit, die zum Aufrufen einer API erforderlich sind, einschließlich einer Endpunkt-URL und Authentifizierung. Ein API-Connector kann in einem bestimmten Schritt in einem Benutzerfluss verwendet werden, um die Ausführung des Benutzerflusses zu beeinflussen. Die API-Antwort kann beispielsweise die Anmeldung eines Benutzers blockieren, einen Eingabeüberprüfungsfehler anzeigen oder vom Benutzer erfasste Attribute überschreiben.

Verwenden Sie die b2xIdentityUserFlow-API, um einen API-Connector aus einem Self-Service-Anmeldebenutzerfluss für externe Identitäten zu verwenden.

Methoden

Methode	Rückgabetyp	Beschreibung
List	identityApiConnector-Auflistung	Abrufen einer Liste von API-Connectors
Create	identityApiConnector	Erstellen Sie einen neuen API-Connector.
Get	identityApiConnector	Lesen Sie die Eigenschaften eines identityApiConnector-Objekts.
Update	identityApiConnector	Aktualisieren Sie die Eigenschaften eines API-Connectors.
Hochladen eines Clientzertifikats	identityApiConnector	Laden Sie ein Clientzertifikat hoch, das für die Authentifizierung verwendet werden soll.
Löschen	Keine	Löschen eines API-Connectors.

Eigenschaften

Eigenschaft	Typ	Beschreibung
id	Zeichenfolge	Die zufällig generierte ID des API-Connectors.
displayName	Zeichenfolge	Der Name des API-Connectors.
targetUrl	Zeichenfolge	Die URL des aufrufende API-Endpunkts.
authenticationConfiguration	apiAuthenticationConfigurationBase	Das Objekt, das die Details der Authentifizierungskonfiguration für den Aufruf der API beschreibt. Basic- und PKCS 12-Clientzertifikate werden unterstützt.

Beziehungen

Keine.

JSON-Darstellung

Es folgt eine JSON-Darstellung der Ressource.

{
  "@odata.type": "#microsoft.graph.identityApiConnector",
  "id": "String (identifier)",
  "displayName": "String",
  "targetUrl": "String",
  "authenticationConfiguration": {
    "@odata.type": "microsoft.graph.apiAuthenticationConfigurationBase"
  }
}