Actualizar identityProvider

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.

Actualice las propiedades del proveedor de identidad externo especificado en el inquilino.

Entre los tipos de proveedores derivados de identityProviderBase, en Microsoft Entra, esta operación puede actualizar un recurso socialIdentityProvider, appleManagedIdentityProvider (solo inquilino externo) o un recurso oidcIdentityProvider (solo inquilino externo).

En Azure AD B2C, esta operación puede actualizar un recurso socialIdentityProvider, appleManagedIdentityProvider, builtinIdentityProvider o openIdConnectIdentityProvider.

Esta API está disponible en las siguientes implementaciones en la nube nacional.

Servicio global Administración pública de EE. UU. Gobierno de EE. UU. L5 (DOD) China operado por 21Vianet
✅ ✅ ✅ ✅

Permissions

Elija el permiso o los permisos marcados como con privilegios mínimos para esta API. Use uno o varios permisos con privilegios más altos 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) IdentityProvider.ReadWrite.All No disponible.
Delegado (cuenta personal de Microsoft) No admitida. No admitida.
Aplicación IdentityProvider.ReadWrite.All No disponible.

Importante

Para el acceso delegado con cuentas profesionales o educativas, el usuario que ha iniciado sesión debe tener asignado un rol compatible de Microsoft Entra o un rol personalizado que conceda los permisos necesarios para esta operación. El Administrador de proveedores de identidades externo es el rol con privilegios mínimos admitido para esta operación.

Solicitud HTTP

PATCH /identity/identityProviders/{id}

Encabezados de solicitud

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

Cuerpo de la solicitud

En el Id. externo de Microsoft Entra, proporcione un objeto JSON al cuerpo de la solicitud con una o más propiedades que deben actualizarse para un objeto socialIdentityProvider, appleManagedIdentityProvider u oidcIdentityProvider.

En Azure AD B2C, proporcione un objeto JSON al cuerpo de la solicitud con una o más propiedades que deben actualizarse para un objeto socialIdentityProvider, appleManagedIdentityProvider o un objeto openIdConnectIdentityProvider.

objeto socialIdentityProvider

Propiedad Tipo Descripción
clientId Cadena El identificador de cliente para la aplicación que se obtiene al registrar la aplicación con el proveedor de identidades.
clientSecret Cadena El secreto de cliente para la aplicación que se obtiene al registrar la aplicación con el proveedor de identidades. Es de solo escritura. Una operación de lectura devuelve ****.
displayName Cadena El nombre para mostrar del proveedor de identidades.
identityProviderType Cadena Para inquilinos externos y de mano de obra, los valores posibles: Facebook, Google.
Para inquilinos de Azure AD B2C, los valores posibles: Microsoft, Google, LinkedInTwitterAmazonQQFacebookWeiboGitHubWeChat.

Objeto appleManagedIdentityProvider

Propiedad Tipo Descripción
certificateData Cadena Los datos de certificado, que son una cadena larga de texto del certificado, puede ser nulo.
developerId Cadena El identificador de desarrollador de Apple.
displayName Cadena El nombre para mostrar del proveedor de identidades.
keyId Cadena El identificador de clave de Apple.
serviceId Cadena El identificador de servicio de Apple.

Objeto openIdConnectIdentityProvider

Propiedad Tipo Descripción
claimsMapping claimsMapping Después de que el proveedor OIDC devuelva un token de identificador a Microsoft Entra ID, Microsoft Entra ID debe poder asignar las notificaciones del token recibido a las notificaciones que Microsoft Entra ID reconoce y usa. Este tipo complejo captura esa asignación.
clientId Cadena El identificador de cliente para la aplicación que se obtiene al registrar la aplicación con el proveedor de identidades.
clientSecret String Secreto de cliente para la aplicación que se obtiene al registrar la aplicación con el proveedor de identidades. clientSecret tiene una dependencia en responseType.
  • Cuando responseType es code, se requiere un secreto para el intercambio de código de autenticación.
  • Cuando responseType es id_token el secreto, no es necesario porque no hay intercambio de código en la canalización de autenticación. En este modo, el id_token se devuelve directamente desde la respuesta de autorización.
displayName Cadena El nombre para mostrar del proveedor de identidades.
domainHint Cadena La sugerencia de dominio puede utilizarse para ir directamente a la página de inicio de sesión del proveedor de identidad especificado, en lugar de hacer que el usuario haga una selección entre la lista de proveedores de identidad disponibles.
metadataUrl Cadena La dirección URL del documento de metadatos del proveedor de identidad de OpenID Connect. Cada proveedor de identidad de OpenID Connect describe un documento de metadatos que contiene la mayor parte de la información necesaria para realizar el inicio de sesión. Esto incluye información como las direcciones URL que se van a usar y la ubicación de las claves de firma públicas del servicio. El documento de metadatos de OpenID Connect siempre se encuentra en un punto final que termina en .well-known/openid-configuration. Proporcione la dirección URL de metadatos del proveedor de identidad de OpenID Connect que agregue.
modo de respuesta Cadena El modo de respuesta define el método utilizado para enviar datos desde el proveedor de identidades personalizado a Azure AD B2C. Valores posibles: form_post, query.
responseType Cadena El tipo de respuesta describe el tipo de información que se devuelve en la llamada inicial al authorization_endpoint del proveedor de identidades personalizado. Valores posibles: code , id_token , token.
ámbito Cadena El ámbito define la información y los permisos que desea recopilar de su proveedor de identidades personalizado.

Objeto oidcIdentityProvider

Propiedad Tipo Descripción
clientAuthentication clientAuthentication La configuración de autenticación del cliente.
  • Use el tipo oidcClientSecretAuthentication para configurar su proveedor de identidad con client_secret_post métodos OR client_secret_jwt authentication .
  • Use el tipo oidcPrivateJwtKeyClientAuthentication para configurar el proveedor de identidades con private_key_jwt el método de autenticación.
  • Por motivos de seguridad, client_secret_basic no se admite el método de autenticación.
  • clientId Cadena Id. de cliente para la aplicación que se obtiene al registrar la aplicación con el proveedor de identidades.
    displayName Cadena El nombre para mostrar del proveedor de identidades.
    inboundclaimMapping inboundclaimMapping Después de que el proveedor OIDC devuelva un token de identificador al Id. externa de Microsoft Entra, el Id. externo de Microsoft Entra debe poder asignar las notificaciones del token recibido a las notificaciones que Microsoft Entra ID reconoce y usa. Este tipo complejo captura esa asignación.
    emisor Cadena El URI del emisor. El URI del emisor es una dirección URL que distingue mayúsculas de minúsculas mediante esquema https, contiene esquema, host y, opcionalmente, componentes de número de puerto y ruta de acceso, y ningún componente de consulta o fragmento.
    Nota: Actualmente no se admite la configuración de otros inquilinos de Microsoft Entra como proveedores de identidades externos. Como resultado, no se acepta el microsoftonline.com dominio en el URI del emisor.
    responseType Cadena El tipo de respuesta describe el tipo de información que se devuelve en la llamada inicial al authorization_endpoint del proveedor de identidades personalizado. Valores posibles: code , id_token , token.
    ámbito Cadena El ámbito define la información y los permisos que desea recopilar de su proveedor de identidades personalizado.
    wellKnownEndpoint Cadena La dirección URL del documento de metadatos del proveedor de identidad de OpenID Connect. Cada proveedor de identidad de OpenID Connect describe un documento de metadatos que contiene la mayor parte de la información necesaria para realizar el inicio de sesión. Esto incluye información como las direcciones URL que se van a usar y la ubicación de las claves de firma públicas del servicio. El documento de metadatos de OpenID Connect siempre se encuentra en un punto final que termina en .well-known/openid-configuration.
    Nota: El documento de metadatos debe, como mínimo, contener las siguientes propiedades: issuer, authorization_endpoint, response_types_supportedsubject_types_supportedtoken_endpointtoken_endpoint_auth_methods_supported, , y .jwks_uri Visite las especificaciones de OpenID Connect Discovery para obtener más detalles.

    Respuesta

    Si se ejecuta correctamente, este método devuelve un código de respuesta 204 No Content. Si falla, se devolverá un error 4xx con detalles específicos.

    Ejemplos

    Ejemplo 1: Actualización de un proveedor de identidades sociales

    Solicitud

    En el ejemplo siguiente se muestra la solicitud.

    PATCH https://graph.microsoft.com/beta/identity/identityProviders/Amazon-OAUTH
    Content-type: application/json
    
    {
      "@odata.type": "#microsoft.graph.socialIdentityProvider",
      "clientSecret": "4294967296"
    }
    

    Respuesta

    En el ejemplo siguiente se muestra la respuesta.

    HTTP/1.1 204 No Content
    

    Ejemplo 2: Actualizar un proveedor de identidades de Apple

    Solicitud

    En el ejemplo siguiente se muestra la solicitud.

    PATCH https://graph.microsoft.com/beta/identity/identityProviders/Apple-Managed-OIDC
    Content-type: application/json
    
    {
      "@odata.type": "#microsoft.graph.socialIdentityProvider",
      "displayName": "Apple"
    }
    

    Respuesta

    En el ejemplo siguiente se muestra la respuesta.

    HTTP/1.1 204 No Content
    

    Ejemplo 3: Actualización de un proveedor de identidades de OpenID Connect (inquilino de Azure AD B2C)

    Solicitud

    En el ejemplo siguiente se muestra la solicitud.

    PATCH https://graph.microsoft.com/beta/identity/identityProviders/Contoso-OIDC-00001111-aaaa-2222-bbbb-3333cccc4444
    Content-type: application/json
    
    {
      "@odata.type": "#microsoft.graph.openIdConnectIdentityProvider",
      "responseType": "id_token"
    }
    

    Respuesta

    En el ejemplo siguiente se muestra la respuesta.

    HTTP/1.1 204 No Content
    

    Ejemplo 4: Actualización de un proveedor de identidad de OpenID Connect (inquilino externo)

    Solicitud

    En el ejemplo siguiente se muestra la solicitud.

    PATCH https://graph.microsoft.com/beta/identity/identityProviders/ContosoOIDCIdentityProvider
    Content-type: application/json
    
    {
      "@odata.type": "#microsoft.graph.oidcIdentityProvider",
      "displayName": "Contoso"
    }
    

    Respuesta

    En el ejemplo siguiente se muestra la respuesta.

    HTTP/1.1 204 No Content