Compartilhar via


Atualizar aplicativo

Namespace: microsoft.graph

Atualize as propriedades de um objeto de aplicação .

Importante

Não há suporte para o uso do PATCH para definir passwordCredential. Utilize os métodos addPassword e removePassword para atualizar a palavra-passe ou o segredo de uma aplicação.

Esta API está disponível nas seguintes implementações de cloud nacionais.

Serviço global US Government L4 US Government L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Tipo de permissão Permissões com menos privilégios Permissões com privilégios superiores
Delegado (conta corporativa ou de estudante) Application.ReadWrite.All Indisponível.
Delegado (conta pessoal da Microsoft) Application.ReadWrite.All Indisponível.
Application Application.ReadWrite.OwnedBy Application.ReadWrite.All

Solicitação HTTP

Pode abordar a aplicação com o respetivo ID ou appId. O id e o appId são referidos como o ID do Objeto e o ID da Aplicação (Cliente), respetivamente, nos registos de aplicações no centro de administração do Microsoft Entra. Substitua {applicationObjectId} pelo ID do objeto da aplicação.

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

Para atualizar o logótipo, utilize o método PUT da seguinte forma.

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

Cabeçalhos de solicitação

Nome Descrição
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type application/json. Obrigatório.

Corpo da solicitação

No corpo da solicitação, forneça os valores para os campos relevantes que devem ser atualizados. As propriedades existentes que não estão incluídas no corpo do pedido mantêm os valores anteriores ou são recalculadas com base em alterações a outros valores de propriedade. Para alcançar o melhor desempenho, não inclua valores existentes que não foram alterados.

Propriedade Tipo Descrição
api apiApplication Especifica configurações para um aplicativo que implementa uma API Web.
appRoles Coleção appRole A coleção de funções definidas para a aplicação. Essas funções podem ser atribuídas a usuários, grupos ou entidades de serviço. Não anulável.
displayName String O nome de exibição do aplicativo.
groupMembershipClaims Cadeia de caracteres Configura a afirmação de grupos emitida num token de acesso de utilizador ou OAuth 2.0 que a aplicação espera. Para definir esse atributo, use um dos seguintes valores válidos de cadeia de caracteres:
  • None
  • SecurityGroup: Para grupos de segurança e funções do Microsoft Entra
  • All: esta ação obterá todos os grupos de segurança, grupos de distribuição e funções de diretório do Microsoft Entra das quais o utilizador com sessão iniciada é membro
identifierUris Coleção de cadeias de caracteres Os URIs que identificam a aplicação no respetivo inquilino do Microsoft Entra ou num domínio personalizado verificado se a aplicação for multi-inquilino. Para saber mais, confira Objetos de aplicativo e Objetos de entidade de serviço. O operador any é obrigatório para expressões de filtro em propriedades de vários valores. Não anulável.
informações informationalUrl Informações básicas do perfil da aplicação, tais como os URLs de marketing, suporte, termos de serviço e declaração de privacidade da aplicação. Os termos de serviço e a política de privacidade são revelados aos usuários por meio da experiência de consentimento do usuário. Para obter mais informações, consulte Adicionar Termos de serviço e declaração de privacidade para aplicações do Microsoft Entra registadas.
isFallbackPublicClient Booliano Especifica o tipo de aplicativo de fallback como cliente público; por exemplo, um aplicativo instalado em um dispositivo móvel. O valor predefinido é false, o que significa que o tipo de aplicação de contingência é um cliente confidencial, como a aplicação Web. Existem determinados cenários em que o ID do Microsoft Entra não consegue determinar o tipo de aplicação cliente (por exemplo, o fluxo ROPC onde está configurado sem especificar um URI de redirecionamento). Nesses casos, o ID do Microsoft Entra interpretará o tipo de aplicação com base no valor desta propriedade.
keyCredentials keyCredential collection A coleção de credenciais chaves associada ao aplicativo. Não anulável.
logo Stream O principal logotipo do aplicativo. Não anulável. Utilize o método PUT para atualizar o logótipo.
nativeAuthenticationApisEnabled nativeAuthenticationApisEnabled Especifica se as APIs de autenticação nativa estão ativadas para que a aplicação possa utilizá-las para fornecer autenticação nativa. Os valores possíveis são none, all e unknownFutureValue. Para obter mais informações, veja Autenticação Nativa.
optionalClaims optionalClaims Os programadores de aplicações podem configurar afirmações opcionais nas respetivas aplicações do Microsoft Entra para especificar as afirmações que pretendem nos tokens enviados para a respetiva aplicação pelo serviço de tokens de segurança da Microsoft. Veja afirmações opcionais para obter mais informações.
parentalControlSettings parentalControlSettings Especifica as configurações de controle parental de um aplicativo.
publicClient publicClientApplication Especifica configurações para clientes instalados, como dispositivos móveis ou da área de trabalho.
requiredResourceAccess requiredResourceAccess collection Especifique os recursos que o aplicativo precisa acessar. Essa propriedade também especifica o conjunto de permissões delegadas e funções de aplicativo necessárias para cada um desses recursos. Essa configuração de acesso aos recursos necessários impulsiona a experiência de consentimento. Não é possível configurar mais de 50 APIs (serviços de recursos). A partir de meados de outubro de 2021, o número total de permissões necessárias não deve exceder 400. Não anulável.
samlMetadataUrl Cadeia de caracteres A URL em que o serviço expõe os metadados SAML para federação. Essa propriedade é válida apenas para aplicativos de locatário único.
signInAudience String Especifica a quais contas da Microsoft são compatíveis com o aplicativo atual. Os valores compatíveis são:
  • AzureADMyOrg: utilizadores com uma conta escolar ou profissional da Microsoft no inquilino do Microsoft Entra da minha organização (ou seja, inquilino único)
  • AzureADMultipleOrgs: utilizadores com uma conta escolar ou profissional da Microsoft no inquilino do Microsoft Entra de qualquer organização (ou seja, multi-inquilino)
  • AzureADandPersonalMicrosoftAccount: utilizadores com uma conta Microsoft pessoal ou uma conta escolar ou profissional no inquilino do Microsoft Entra de qualquer organização

O valor desta propriedade tem implicações noutras propriedades de objetos de aplicação. Como resultado, se alterar esta propriedade, poderá ter de alterar primeiro outras propriedades. Para obter mais informações, veja Validation differences for signInAudience (Diferenças de validação para signInAudience).
spa spaApplication Especifica as configurações de um aplicativo de página simples, incluindo URLs de saída e de redirecionamento de URIs para os códigos de autorização e tokens de acesso.
categorias Coleção String Sequências personalizadas que podem ser usadas para categorizar e identificar o aplicativo. Não anulável.
tokenEncryptionKeyId Cadeia de caracteres Especifica a keyId de uma chave pública da coleção keyCredentials. Quando configurado, o Microsoft Entra ID encripta todos os tokens que emite através da chave para a qual esta propriedade aponta. O código de aplicativo que recebe o token criptografado deve usar a chave privada correspondente para descriptografar o token a fim de que ele possa ser usado para o usuário conectado.
Nome único Cadeia de caracteres O identificador exclusivo que pode ser atribuído a uma aplicação e utilizado como uma chave alternativa. Só pode ser atualizado se null e for imutável uma vez definido.
web webApplication Especifica configurações para um aplicativo Web.

Resposta

Se for bem-sucedido, este método devolve um 204 No Content código de resposta e não devolve nada no corpo da resposta.

Exemplos

Exemplo 1: Atualizar o displayName para uma aplicação

Solicitação

O exemplo a seguir mostra a solicitação.

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

{
  "displayName": "New display name"
}

Resposta

HTTP/1.1 204 No Content

Exemplo 2: Atualizar appRoles para uma aplicação

O exemplo seguinte atualiza a coleção appRoles de uma aplicação. Para manter quaisquer funções de aplicação existentes, inclua-as no pedido. Todos os objetos existentes na coleção que não estão incluídos no pedido são substituídos pelos novos objetos. Este objeto é sincronizado com a propriedade correspondente do principal de serviço no inquilino.

Solicitação

PATCH https://graph.microsoft.com/v1.0/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"
        }
    ]
}

Resposta

HTTP/1.1 204 No Content