Compartilhar via


Atualizar aplicativo

Namespace: microsoft.graph

Atualize as propriedades de um objeto de aplicativo .

Importante

Não há suporte para o uso do PATCH para definir passwordCredential. Use os métodos addPassword e removePassword para atualizar a senha ou o segredo de um aplicativo.

Essa API está disponível nas seguintes implantações nacionais de nuvem.

Serviço global Governo dos EUA L4 GOVERNO DOS EUA L5 (DOD) China operada pela 21Vianet

Permissões

Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão Permissões menos privilegiadas Permissões privilegiadas mais altas
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

Você pode abordar o aplicativo usando sua id ou appId. Id e appId são chamados de ID de Objeto e ID do Aplicativo (Cliente), respectivamente, em registros de aplicativo no centro de administração do Microsoft Entra. Substitua {applicationObjectId} pela ID do objeto do aplicativo.

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

Para atualizar o logotipo, use o método PUT da seguinte maneira.

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. Propriedades existentes que não estão incluídas no corpo da solicitação terão seus valores anteriores mantidos ou serão recalculadas com base nas 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 o aplicativo. 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 declaração de grupo emitida em um usuário ou token de acesso OAuth 2.0 que o aplicativo 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 de Microsoft Entra
  • All: isso obterá todos os grupos de segurança, grupos de distribuição e Microsoft Entra funções de diretório das quais o usuário conectado é membro
identifierUris Coleção de cadeias de caracteres As URIs que identificam o aplicativo em seu locatário Microsoft Entra ou em um domínio personalizado verificado se o aplicativo é multilocatário. 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 de perfil do aplicativo, como marketing do aplicativo, suporte, termos de serviço e URLs de instrução de privacidade. 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 aplicativos Microsoft Entra registrados.
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 padrão é false, o que significa que o tipo de aplicativo de fallback é um cliente confidencial, como o aplicativo Web. Há certos cenários em que Microsoft Entra ID não pode determinar o tipo de aplicativo cliente (por exemplo, fluxo ROPC em que ele está configurado sem especificar um URI de redirecionamento). Nesses casos, Microsoft Entra ID interpretará o tipo de aplicativo com base no valor dessa 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. Use o método PUT para atualizar o logotipo.
optionalClaims optionalClaims Os desenvolvedores de aplicativos podem configurar declarações opcionais em seus aplicativos Microsoft Entra para especificar quais declarações eles desejam em tokens enviados para seu aplicativo pelo serviço de token de segurança da Microsoft. Consulte declaraçõ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: Usuários com uma conta corporativa ou de estudante da Microsoft no locatário Microsoft Entra da minha organização (ou seja, locatário único)
  • AzureADMultipleOrgs: Usuários com uma conta corporativa ou de estudante da Microsoft no locatário Microsoft Entra de qualquer organização (ou seja, multilocatário)
  • AzureADandPersonalMicrosoftAccount: Usuários com uma conta microsoft pessoal ou uma conta corporativa ou escolar no locatário Microsoft Entra de qualquer organização

O valor dessa propriedade tem implicações em outras propriedades de objeto de aplicativo. Como resultado, se você alterar essa propriedade, talvez seja necessário alterar outras propriedades primeiro. Para obter mais informações, confira 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, Microsoft Entra ID criptografa todos os tokens que emite usando a chave para a qual essa 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 um aplicativo e usado como uma chave alternativa. Só é possível atualizar se null e for imutável uma vez definido.
web webApplication Especifica configurações para um aplicativo Web.

Resposta

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

Exemplos

Exemplo 1: atualizar o displayName para um aplicativo

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 os appRoles para um aplicativo

O exemplo a seguir atualiza a coleção appRoles para um aplicativo. Para manter todas as funções de aplicativo existentes, inclua-as na solicitação. Todos os objetos existentes na coleção que não estão incluídos na solicitação são substituídos pelos novos objetos. Esse objeto é sincronizado com a propriedade correspondente da entidade de serviço no locatário.

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