Actualizar aplicación

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.

Actualizar las propiedades de un objeto de aplicación . Esta API también puede actualizar un objeto agentIdentityBlueprint cuando la propiedad @odata.type se establece en #microsoft.graph.agentIdentityBlueprint.

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

Importante

Para el acceso delegado con cuentas profesionales o educativas, el administrador debe tener asignado un rol compatible de Microsoft Entra o un rol personalizado que conceda los permisos necesarios para esta operación. Esta operación admite los siguientes roles integrados, que proporcionan solo el privilegio mínimo necesario:

  • Un miembro o invitado no administrador que tiene permisos de usuario predeterminados, a menos que el administrador del espacio empresarial restrinja el acceso.
  • Desarrollador de aplicaciones. Este rol puede crear aplicaciones incluso cuando el administrador restringió el acceso a miembros e invitados. A la entidad de seguridad con este rol se le asigna la propiedad de la aplicación que crea.
  • Escritores de directorios. Este rol puede actualizar las propiedades de extensión.
  • Administrador de identidades híbridas. Este rol solo puede actualizar propiedades básicas.
  • Administrador de seguridad
  • Administrador de aplicaciones en la nube
  • Administrador de la aplicación

En escenarios delegados con cuentas profesionales o educativas, se admiten los siguientes privilegios para administrar planos técnicos de identidad de agente:

  • El usuario que ha iniciado sesión es el propietario, o bien
  • Al usuario que ha iniciado sesión se le asigna el rol de administrador de ID de agente .

Solicitud HTTP

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

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

Para actualizar el logotipo, utilice el método PUT de la siguiente manera.

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 autenticación y 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 están incluidas en el cuerpo de la solicitud mantienen sus valores anteriores o se recalculan en función de los cambios realizados en otros valores de propiedad. Para obtener el mejor rendimiento, no incluyas valores sin cambios.

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 usuario o token de acceso 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: para grupos de seguridad, grupos de distribución y roles de directorio de Microsoft Entra de los que es miembro el usuario que ha iniciado sesión
identifierUris Colección string Los URI que identifican la aplicación dentro de su inquilino de 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. No admite valores NULL.
info informationalUrl Información de perfil básica de la aplicación, como el marketing de la aplicación, el soporte técnico, los términos del servicio y las direcciones URL de la declaración de privacidad. 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 las aplicaciones de Microsoft Entra registradas.
isDisabled Booleano Especifica si la entidad de servicio de la aplicación en un inquilino o entre inquilinos para aplicaciones multiinquilino puede obtener nuevos tokens de acceso o acceder a recursos protegidos. Cuando se establece en true, los tokens existentes siguen siendo válidos hasta que expiran en función de su duración configurada y la aplicación permanece visible en la lista de aplicaciones empresariales, pero los usuarios no pueden iniciar sesión.true si la aplicación está desactivada (deshabilitada); en caso contrario false.
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 aplicación web. Hay determinados escenarios en los que Microsoft Entra ID no puede determinar el tipo de aplicación cliente (por ejemplo, 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.
nativeAuthenticationApisEnabled Cadena Especifica si las API de autenticación nativa están habilitadas para que la aplicación pueda usarlas para proporcionar autenticación nativa. Los valores posibles son none, all, y unknownFutureValue. Para obtener más información, consulte Autenticación nativa.
onPremisesPublishing onPremisesPublishing Representa el conjunto de propiedades para configurar el proxy de aplicación de Microsoft Entra para una aplicación local. Esta propiedad solo se puede establecer después de que se haya creado 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 tokens de seguridad de Microsoft. Para obtener más información, consulte reclamaciones opcionales.
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 los tipos de cuenta admitidos para la aplicación. 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, inquilino único)
  • 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 personal de Microsoft 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 del objeto de la aplicación. Como resultado, si cambia esta propiedad, es posible que primero tenga que cambiar otras propiedades. Para obtener más información, consulte Diferencias de validación para signInAudience.
signInAudienceRestrictions signInAudienceRestrictionsBase Especifica las restricciones sobre los tipos de cuenta admitidos especificados en signInAudience. El tipo de valor determina las restricciones que se pueden aplicar:
  • unrestrictedAudience: no hay restricciones adicionales en los tipos de cuenta admitidos permitidos por signInAudience.
  • allowedTenantsAudience: la aplicación solo se puede utilizar en los inquilinos de Entra especificados. Solo se admite cuando signInAudience es AzureADMultipleOrgs.
El valor predeterminado es un valor de tipo unrestrictedAudience.
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 Identificador único que se puede asignar a una aplicación y usar como clave alternativa. Solo se puede actualizar si null y es inmutable una vez que se establece.
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 SID de paquete y URI de redireccionamiento para códigos de autorización y tokens de acceso.

Respuesta

Si tiene éxito, 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: Actualizar el nombre para mostrar de una aplicación

Solicitud

En la siguiente solicitud 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: Actualizar los appRoles de una aplicación

En el ejemplo siguiente se actualiza la colección appRoles para una aplicación. Para mantener los roles de aplicación existentes, inclúyalos en la solicitud. Los objetos existentes en 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

Ejemplo 3: Convertir una aplicación de inquilino único en multiinquilino limitada

Solicitud

En la solicitud siguiente se muestra un ejemplo actualizando el signInAudience de una aplicación de un solo inquilino (AzureADMyOrg) a multiinquilino (AzureADMultipleOrgs) y, al mismo tiempo, configurando signInAudienceRestrictions para que la aplicación solo se pueda usar en dos espacios empresariales permitidos (y el espacio empresarial en el que está registrada la aplicación).

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

{
  "signInAudience": "AzureADMultipleOrgs",
  "signInAudienceRestrictions": {
    "@odata.type": "#microsoft.graph.allowedTenantsAudience",
    "isHomeTenantAllowed": true,
    "allowedTenantIds": [
      "818ce016-78c2-457c-91d7-c02c2faaa5fe",
      "c62670b0-53a1-4a38-b26c-4093cbaa510a"
    ]
  }
}

Respuesta

HTTP/1.1 204 No Content

Ejemplo 4: Convertir una aplicación restringida de varios inquilinos en un solo inquilino

Solicitud

En la solicitud siguiente se muestra un ejemplo actualizando signInAudience de una aplicación a inquilino único (AzureADMyOrg) y al mismo tiempo quitando signInAudienceRestrictions. Se recomienda hacer esto al mismo tiempo para evitar cualquier período de tiempo en el que la aplicación sea multiinquilino y no esté limitada, lo que pueden requerir las directivas de la organización.

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

{
  "signInAudience": "AzureADMyOrg",
  "signInAudienceRestrictions": {
    "@odata.type": "#microsoft.graph.unrestrictedAudience"
  }
}

Respuesta

HTTP/1.1 204 No Content
  • Last updated on