Actualizar aplicación

  • Artículo

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 de un objeto de aplicación .

Importante

No es compatible con el uso de PATCH para establecer passwordCredential. Use los métodos addPassword y removePassword para actualizar la contraseña o el secreto de una aplicación.

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) Application.ReadWrite.All No disponible.
Delegado (cuenta personal de Microsoft) Application.ReadWrite.All No disponible.
Aplicación Application.ReadWrite.OwnedBy Application.ReadWrite.All

Solicitud HTTP

Puede dirigirse a la aplicación mediante su id . o appId. id y appId se conocen como id. de objeto y id. de aplicación (cliente), respectivamente, en los registros de aplicaciones en el Centro de administración Microsoft Entra. Reemplace por {applicationObjectId} el identificador del objeto de aplicación.

PATCH /applications/{applicationObjectId}
PATCH /applications(appId='{appId}')

Para actualizar el logotipo, use el método PUT como se indica a continuación.

PUT /applications/{applicationObjectId}/logo
PUT /applications(appId='{appId}')/logo

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 solicitud

En el cuerpo de la solicitud, proporcione los valores de los campos relevantes que deben actualizarse. Las propiedades existentes que no se incluyan en el cuerpo de la solicitud mantendrán los valores anteriores o se recalcularán según los cambios efectuados en otros valores de propiedad. Para obtener el mejor rendimiento, no incluya valores existentes que no hayan cambiado.

Propiedad Tipo Descripción
api apiApplication Especifica la configuración de una aplicación que implementa una API web.
appRoles Colección appRole Colección de roles definidos para la aplicación. Estos roles pueden asignarse a usuarios, grupos o entidades de servicio. No admite valores NULL.
displayName Cadena Nombre para mostrar de la aplicación.
groupMembershipClaims Cadena Configura la notificación de grupos emitida en un token de acceso de usuario o de OAuth 2.0 que espera la aplicación. Para establecer este atributo, use uno de los siguientes valores de cadena válidos:
  • None
  • SecurityGroup: para grupos de seguridad y roles de Microsoft Entra
  • All: esto obtendrá todos los grupos de seguridad, grupos de distribución y roles de directorio Microsoft Entra de los que el usuario que ha iniciado sesión es miembro.
identifierUris Colección string Uri que identifican la aplicación dentro de su inquilino Microsoft Entra, o dentro de un dominio personalizado comprobado si la aplicación es multiinquilino. Para más información, vea Objetos de aplicación y de entidad de servicio. El operador any es necesario para las expresiones de filtro en las propiedades de varios valores. No admite valores NULL.
info informationalUrl Información básica del perfil de la aplicación, como las direcciones URL de marketing, soporte técnico, términos de servicio y declaración de privacidad de la aplicación. Las condiciones del servicio y la declaración de privacidad se exponen a los usuarios mediante la experiencia de consentimiento del usuario. Para obtener más información, consulte Agregar términos de servicio y declaración de privacidad para aplicaciones Microsoft Entra registradas.
isFallbackPublicClient Boolean Especifica el tipo de aplicación de reserva como un cliente público, por ejemplo, una aplicación instalada que se ejecuta en un dispositivo móvil. El valor predeterminado es false, lo que significa que el tipo de aplicación de reserva es cliente confidencial, como la aplicación web. Hay ciertos escenarios en los que Microsoft Entra ID no puede determinar el tipo de aplicación cliente (por ejemplo, el flujo ROPC donde se configura sin especificar un URI de redireccionamiento). En esos casos, Microsoft Entra ID interpretará el tipo de aplicación en función del valor de esta propiedad.
keyCredentials Colección keyCredential La colección de credenciales de clave asociada a la aplicación. No admite valores NULL.
logo Stream Logotipo principal de la aplicación. No admite valores NULL. Use el método PUT para actualizar el logotipo.
onPremisesPublishing onPremisesPublishing Representa el conjunto de propiedades para configurar Microsoft Entra proxy de aplicación para una aplicación local. Esta propiedad solo se puede establecer una vez creada la aplicación y no se puede actualizar en la misma solicitud que otras propiedades de la aplicación.
optionalClaims optionalClaims Los desarrolladores de aplicaciones pueden configurar notificaciones opcionales en sus aplicaciones de Microsoft Entra para especificar qué notificaciones desean en los tokens enviados a su aplicación por el servicio de token de seguridad de Microsoft. Consulte notificaciones opcionales para obtener más información.
parentalControlSettings parentalControlSettings Especifica opciones de configuración de control parental para una aplicación.
publicClient publicClientApplication Especifica opciones de configuración para clientes instalados, como dispositivos móviles o de escritorio.
requiredResourceAccess Colección requiredResourceAccess Especifica los recursos a los que necesita obtener acceso la aplicación. Esta propiedad también especifica el conjunto de permisos delegados y roles de aplicación que necesita para cada uno de esos recursos. Esta configuración de acceso a los recursos necesarios controla la experiencia del consentimiento. No se pueden configurar más de 50 servicios de recursos (API). A partir de mediados de octubre de 2021, el número total de permisos necesarios no debe superar los 400. No admite valores NULL.
samlMetadataUrl Cadena La dirección URL donde el servicio muestra los metadatos de SAML para la federación. Esta propiedad solo es válida para aplicaciones de un solo inquilino.
signInAudience Cadena Especifica las cuentas Microsoft compatibles con la aplicación actual. Los valores admitidos son los siguientes:
  • AzureADMyOrg: usuarios con una cuenta profesional o educativa de Microsoft en el inquilino de Microsoft Entra de mi organización (es decir, un solo inquilino)
  • AzureADMultipleOrgs: usuarios con una cuenta profesional o educativa de Microsoft en el inquilino de Microsoft Entra de cualquier organización (es decir, multiinquilino)
  • AzureADandPersonalMicrosoftAccount: usuarios con una cuenta microsoft personal o una cuenta profesional o educativa en el inquilino de Microsoft Entra de cualquier organización

El valor de esta propiedad tiene implicaciones en otras propiedades de objeto de aplicación. Como resultado, si cambia esta propiedad, es posible que primero tenga que cambiar otras propiedades. Para obtener más información, vea Diferencias de validación para signInAudience.
spa spaApplication Especifica la configuración de aplicación de una sola página, incluidas las direcciones URL de cierre de sesión y los URI de redirección para los códigos de autorización y los tokens de acceso.
tags Colección string Cadenas personalizadas que pueden usarse para clasificar por categorías e identificar aplicaciones. No admite valores NULL.
tokenEncryptionKeyId Cadena Especifica el valor keyId de una clave pública de la colección keyCredentials. Cuando se configura, Microsoft Entra ID cifra todos los tokens que emite mediante la clave a la que apunta esta propiedad. El código de aplicación que recibe el token cifrado debe usar la clave privada coincidente para descifrar el token a fin de poder usarlo para el usuario que ha iniciado sesión.
uniqueName Cadena El identificador único que se puede asignar a una aplicación como identificador alternativo. Inmutable. Solo lectura.
web webApplication Especifica opciones de configuración para una aplicación web.
spa spaApplication Especifica la configuración de aplicación de una sola página, incluidas las direcciones URL de cierre de sesión y los URI de redirección para los códigos de autorización y los tokens de acceso.
windows windowsApplication Especifica la configuración de las aplicaciones que ejecutan Microsoft Windows y que están publicadas en Microsoft Store o en la tienda Xbox Games. Incluye el SID del paquete y los URI de redireccionamiento para los códigos de autorización y los tokens de acceso.

Respuesta

Si se ejecuta correctamente, este método devuelve un 204 No Content código de respuesta y no devuelve nada en el cuerpo de la respuesta.

Ejemplos

Ejemplo 1: Actualización del displayName de una aplicación

Solicitud

En la solicitud siguiente se muestra un ejemplo.

PATCH https://graph.microsoft.com/beta/applications/{id}
Content-type: application/json

{
  "displayName": "New display name"
}

Respuesta

HTTP/1.1 204 No Content

Ejemplo 2: Actualización de appRoles para una aplicación

En el ejemplo siguiente se actualiza la colección appRoles para una aplicación. Para conservar los roles de aplicación existentes, insclútelos en la solicitud. Los objetos existentes de la colección que no se incluyen en la solicitud se reemplazan por los nuevos objetos. Este objeto se sincroniza con la propiedad correspondiente de la entidad de servicio en el inquilino.

Solicitud

PATCH https://graph.microsoft.com/beta/applications/fda284b5-f0ad-4763-8289-31a273fca865
Content-type: application/json

{
    "appRoles": [
        {
            "allowedMemberTypes": [
                "User",
                "Application"
            ],
            "description": "Survey.Read",
            "displayName": "Survey.Read",
            "id": "ebb7c86c-fb47-4e3f-8191-420ff1b9de4a",
            "isEnabled": false,
            "origin": "Application",
            "value": "Survey.Read"
        }
    ]
}

Respuesta

HTTP/1.1 204 No Content