identityApiConnector-Ressourcentyp

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.

Stellt API-Connectors in einer Microsoft Entra-ID und Azure AD B2C-Mandanten dar.

Ein API-Connector, der bei der Self-Service-Registrierung von Microsoft Entra External ID und azure AD B2C-Registrierungsbenutzerflows verwendet wird, ermöglicht es Ihnen, während der Ausführung des Benutzerflows eine API aufzurufen. 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 eines 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
id	Zeichenfolge	Die zufällig generierte ID des API-Connectors.
displayName	Zeichenfolge	Der Name des API-Connectors.
targetUrl	Zeichenfolge	Die URL des aufzurufenden API-Endpunkts.
authenticationConfiguration	apiAuthenticationConfigurationBase	Das -Objekt, das die Authentifizierungskonfigurationsdetails für den Aufruf der API beschreibt. Basic- und PKCS 12-Clientzertifikate werden unterstützt.

Beziehungen

Keine.

JSON-Darstellung

Die folgende JSON-Darstellung zeigt den Ressourcentyp.

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