type de ressource identityApiConnector
Espace de noms: microsoft.graph
Importante
Les API sous la version /beta
dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .
Représente des connecteurs d’API dans un ID Microsoft Entra et des locataires Azure AD B2C.
Un connecteur d’API utilisé dans votre inscription en libre-service à l’ID externe Microsoft Entra et dans vos flux d’utilisateurs d’inscription Azure AD B2C vous permet d’appeler une API pendant l’exécution du flux d’utilisateur. Un connecteur d’API fournit les informations nécessaires pour appeler une API, notamment une URL de point de terminaison et une authentification. Un connecteur d’API peut être utilisé à une étape spécifique d’un flux utilisateur pour affecter l’exécution du flux utilisateur. Par exemple, la réponse de l’API peut empêcher un utilisateur de s’inscrire, afficher une erreur de validation d’entrée ou remplacer les attributs collectés par l’utilisateur.
Utilisez l’API b2xIdentityUserFlow pour utiliser un connecteur d’API à partir d’un flux d’utilisateur d’inscription en libre-service des identités externes.
Méthodes
Méthode | Type de retour | Description |
---|---|---|
List | identityApiConnector collection | Obtenir la liste des connecteurs d’API |
Create | identityApiConnector collection | Créez un connecteur d’API. |
Obtenir | identityApiConnector collection | Lisez les propriétés d’un objet identityApiConnector . |
Mettre à jour | identityApiConnector collection | Mettez à jour les propriétés d’un connecteur d’API. |
Charger un certificat client | identityApiConnector collection | Chargez un certificat client à utiliser pour l’authentification. |
Supprimer | Aucune | Supprimer un connecteur d’API. |
Propriétés
Propriété | Type | Description |
---|---|---|
id | Chaîne | ID généré de manière aléatoire du connecteur d’API. |
displayName | Chaîne | Nom du connecteur d’API. |
targetUrl | Chaîne | URL du point de terminaison d’API à appeler. |
authenticationConfiguration | apiAuthenticationConfigurationBase | Objet qui décrit les détails de configuration de l’authentification pour l’appel de l’API. Les certificats client de base et PKCS 12 sont pris en charge. |
Relations
Aucun.
Représentation JSON
La représentation JSON suivante montre le type de ressource.
{
"@odata.type": "#microsoft.graph.identityApiConnector",
"id": "String (identifier)",
"displayName": "String",
"targetUrl": "String",
"authenticationConfiguration": {
"@odata.type": "microsoft.graph.apiAuthenticationConfigurationBase"
}
}