Compartir a través de


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 identidades externo especificado configurado 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 socialIdentityProvider, appleManagedIdentityProvider, builtinIdentityProvider o un recurso openIdConnectIdentityProvider .

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) IdentityProvider.ReadWrite.All No disponible.
Delegado (cuenta personal de Microsoft) No admitida. No admitida.
Aplicación IdentityProvider.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. El administrador del proveedor 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 la autenticación y la autorización.
Content-Type application/json. Obligatorio.

Cuerpo de la solicitud

En Id. externa de Microsoft Entra, proporcione un objeto JSON al cuerpo de la solicitud con una o varias propiedades que deben actualizarse para un objeto socialIdentityProviderappleManagedIdentityProvider o oidcIdentityProvider.

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

socialIdentityProvider (objeto)

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 En el caso de los inquilinos externos y de los empleados, valores posibles: Facebook, Google.
En el caso de los inquilinos de Azure AD B2C, los valores posibles son , MicrosoftGoogle, Amazon, LinkedIn, Facebook, GitHub, Twitter, Weibo, QQWeChat.

appleManagedIdentityProvider (objeto)

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.

openIdConnectIdentityProvider (objeto)

Propiedad Tipo Descripción
claimsMapping claimsMapping Una vez que el proveedor OIDC envía 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 de 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 ningún 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 se puede usar para ir directamente a la página de inicio de sesión del proveedor de identidades especificado, en lugar de hacer que el usuario realice una selección entre la lista de proveedores de identidades disponibles.
metadataUrl Cadena Dirección URL del documento de metadatos del proveedor de identidades de OpenID Connect. Cada proveedor de identidades 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ública del servicio. El documento de metadatos de OpenID Connect siempre se encuentra en un punto de conexión que termina en .well-known/openid-configuration. Proporcione la dirección URL de metadatos para el proveedor de identidades de OpenID Connect que agregue.
responseMode Cadena El modo de respuesta define el método usado 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 del proveedor de identidades personalizado.

oidcIdentityProvider (objeto)

Propiedad Tipo Descripción
clientAuthentication clientAuthentication La configuración de autenticación de cliente.
  • use el tipo oidcClientSecretAuthentication para configurar el proveedor de identidades con client_secret_post o client_secret_jwt authentication métodos.
  • 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 Una vez que el proveedor OIDC envía un token de identificador a Id. externa de Microsoft Entra, Id. externa 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 URI del emisor. El URI del emisor es una dirección URL que distingue mayúsculas de minúsculas que usa el esquema https que contiene esquema, host y, opcionalmente, componentes de número de puerto y ruta de acceso, y sin componentes de consulta o fragmento.
    Nota: Actualmente no se admite la configuración de otros inquilinos de Microsoft Entra como proveedor 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 del proveedor de identidades personalizado.
    wellKnownEndpoint Cadena Dirección URL del documento de metadatos del proveedor de identidades de OpenID Connect. Cada proveedor de identidades 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ública del servicio. El documento de metadatos de OpenID Connect siempre se encuentra en un punto de conexión que termina en .well-known/openid-configuration.
    Nota: Como mínimo, el documento de metadatos debe contener las siguientes propiedades: issuer, authorization_endpoint, token_endpoint, token_endpoint_auth_methods_supported, subject_types_supportedresponse_types_supportedy jwks_uri. Visite Las especificaciones de detección de OpenID Connect 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: Actualización de 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 identidades 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