tipo de recurso identityApiConnector
Espacio de nombres: microsoft.graph
Importante
Las API de la versión /beta
de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.
Representa los conectores de API en un identificador de Microsoft Entra y en los inquilinos de Azure AD B2C.
Un conector de API usado en el registro de autoservicio de Microsoft Entra External ID y los flujos de usuario de registro de Azure AD B2C le permiten llamar a una API durante la ejecución del flujo de usuario. Un conector de API proporciona la información necesaria para llamar a una API, incluida una dirección URL del punto de conexión y la autenticación. Un conector de API se puede usar en un paso específico de un flujo de usuario para afectar a la ejecución del flujo de usuario. Por ejemplo, la respuesta de la API puede impedir que un usuario se registre, mostrar un error de validación de entrada o sobrescribir los atributos recopilados por el usuario.
Use la API b2xIdentityUserFlow para usar un conector de API desde un flujo de usuario de registro de autoservicio de identidades externas.
Métodos
Método | Tipo devuelto | Descripción |
---|---|---|
List | ColecciónidentityApiConnector | Obtener una lista de conectores de API |
Crear | identityApiConnector | Cree un nuevo conector de API. |
Get | identityApiConnector | Lea las propiedades de un objeto identityApiConnector . |
Actualizar | identityApiConnector | Actualice las propiedades de un conector de API. |
Carga de un certificado de cliente | identityApiConnector | Cargue un certificado de cliente para usarlo para la autenticación. |
Delete | Ninguno | Elimine un conector de API. |
Propiedades
Propiedad | Tipo | Descripción |
---|---|---|
id | Cadena | Identificador generado aleatoriamente del conector de API. |
displayName | Cadena | Nombre del conector de API. |
targetUrl | Cadena | Dirección URL del punto de conexión de API al que se va a llamar. |
authenticationConfiguration | apiAuthenticationConfigurationBase | Objeto que describe los detalles de configuración de autenticación para llamar a la API. Se admiten los certificados de cliente básico y PKCS 12. |
Relaciones
Ninguna.
Representación JSON
La siguiente representación JSON muestra el tipo de recurso.
{
"@odata.type": "#microsoft.graph.identityApiConnector",
"id": "String (identifier)",
"displayName": "String",
"targetUrl": "String",
"authenticationConfiguration": {
"@odata.type": "microsoft.graph.apiAuthenticationConfigurationBase"
}
}