identityApiConnector-Ressourcentyp

Namespace: microsoft.graph

Stellt API-Connectors in einem Microsoft Entra Mandanten dar.

Mit einem API-Connector, der in Ihren Microsoft Entra External ID Benutzerflows für die Self-Service-Registrierung verwendet wird, können Sie während der Ausführung des Benutzerflows eine API aufrufen. Ein API-Connector stellt die informationen bereit, die zum Aufrufen einer API benötigt werden, einschließlich einer Endpunkt-URL und Authentifizierung. Ein API-Connector kann in einem bestimmten Schritt in einem Benutzerflow verwendet werden, um die Ausführung des Benutzerflows zu beeinflussen. Beispielsweise kann die API-Antwort die Registrierung eines Benutzers blockieren, einen Eingabevalidierungsfehler anzeigen oder vom Benutzer gesammelte Attribute überschreiben.

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

Methoden

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

Eigenschaften

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

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