Compartir a través de


Actualizar identityApiConnector

Espacio de nombres: microsoft.graph

Actualice las propiedades de un objeto identityApiConnector .

Esta API está disponible en las siguientes implementaciones nacionales de nube.

Servicio global Gobierno de EE. UU. L4 Us Government L5 (DOD) China operada por 21Vianet

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use un permiso o permisos con privilegios superiores solo si la aplicación lo requiere. Para obtener más información sobre los permisos delegados y de aplicación, consulte Tipos de permisos. Para obtener más información sobre estos permisos, consulte la referencia de permisos.

Tipo de permiso Permisos con privilegios mínimos Permisos con privilegios más altos
Delegado (cuenta profesional o educativa) APIConnectors.ReadWrite.All No disponible.
Delegado (cuenta personal de Microsoft) No admitida. No admitida.
Aplicación APIConnectors.ReadWrite.All No disponible.

Importante

En escenarios delegados con cuentas profesionales o educativas, al usuario que ha iniciado sesión se le debe asignar un rol de Microsoft Entra compatible o un rol personalizado con un permiso de rol admitido. Id. externa administrador de Flujo de usuario es el rol con privilegios mínimos admitido para esta operación.

Solicitud HTTP

PATCH /identity/apiConnectors/{identityApiConnectorId}

Encabezados de solicitud

Nombre Descripción
Authorization {token} de portador. Obligatorio. Obtenga más información sobre la autenticación y la autorización.
Content-Type application/json. Obligatorio.

Cuerpo de la solicitud

En el cuerpo de la solicitud, proporcione una representación JSON del objeto identityApiConnector .

En la tabla siguiente se muestran las propiedades de identityApiConnector que se pueden actualizar.

Propiedad Tipo Descripción
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. Solo se admiten la autenticación básica y el certificado de cliente PKCS 12 .

Respuesta

Si se ejecuta correctamente, este método devuelve un código de respuesta 204 No Content.

Ejemplos

Ejemplo 1: Cambiar el nombre para mostrar, targetUrl y el nombre de usuario & contraseña usada para la autenticación básica

Solicitud

En el ejemplo siguiente se muestra la solicitud.

PATCH https://graph.microsoft.com/v1.0/identity/apiConnectors/{identityApiConnectorId}
Content-Type: application/json

{
  "displayName": "New Test API",
  "targetUrl": "https://otherapi.com/api/endpoint",
  "authenticationConfiguration": {
    "@odata.type": "microsoft.graph.basicAuthentication",
    "username":"<NEW_USERNAME>", 
    "password":"<NEW_PASSWORD>"
  }
}

Respuesta

En el ejemplo siguiente se muestra la respuesta.

HTTP/1.1 204 No Content

Ejemplo 2: Cambio del conector de API para usar la autenticación de certificado de cliente

Esto sobrescribirá cualquier configuración de authenticationConfiguration anterior. Para cambiar de autenticación básica a autenticación de certificado, úsela. Para agregar certificados adicionales a la lista de certificados, use el método Upload client certificate (Cargar certificado de cliente ). Al usar este método, las operaciones "Get" o "List" de los conectores authenticationConfiguration de API serán de tipo microsoft.graph.clientCertificateAuthentication.

Solicitud

En el ejemplo siguiente se muestra la solicitud.

PATCH https://graph.microsoft.com/v1.0/identity/apiConnectors/be1f769b-9b13-437e-b540-79a905c4932c
Content-Type: application/json

{
  "authenticationConfiguration": {
    "@odata.type": "#microsoft.graph.pkcs12Certificate",
    "pkcs12Value": "eyJhbGciOiJSU0EtT0FFUCIsImVuYyI6IkEyNTZHQ00ifQ...kDJ04sJShkkgjL9Bm49plA",
    "password": "secret"
  }
}

Respuesta

En el ejemplo siguiente se muestra la respuesta.

HTTP/1.1 204 No Content