identityApiConnector-Ressourcentyp

Namespace: microsoft.graph

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

Ein API-Connector, der in Ihren Self-Service-Benutzerabläufen für die Azure AD-Registrierung für externe Identitäten verwendet wird, ermöglicht es Ihnen, während der Ausführung des Benutzerflusses eine API aufzurufen. Ein API-Connector stellt die erforderlichen Informationen zum Aufrufen einer API bereit, einschließlich einer Endpunkt-URL und -Authentifizierung. Ein API-Connector kann in einem bestimmten Schritt in einem Benutzerablauf verwendet werden, um die Ausführung des Benutzerflusses zu beeinflussen. Die API-Antwort kann beispielsweise verhindern, dass sich ein Benutzer anmeldet, einen Eingabeüberprüfungsfehler anzeigt oder vom Benutzer erfasste Attribute überschreibt.

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

Methoden

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

Eigenschaften

Eigenschaft	Typ	Beschreibung
id	String	Der zufällig generierte Bezeichner des API-Connectors.
displayName	String	Der Name des API-Connectors.
targetUrl	String	Die URL des aufzurufenden API-Endpunkts.
authenticationConfiguration	apiAuthenticationConfigurationBase	Das Objekt, das die Authentifizierungskonfigurationsdetails für den Aufruf der API beschreibt. Basis- 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"
  }
}