tipo de recurso do aplicativo
Namespace: microsoft.graph
Representa um aplicativo. Qualquer aplicativo que terceiriza a autenticação para Microsoft Entra ID deve ser registrado no plataforma de identidade da Microsoft. O registro do aplicativo envolve informar Microsoft Entra ID sobre seu aplicativo, incluindo a URL em que ele está localizado, a URL para enviar respostas após a autenticação, o URI para identificar seu aplicativo e muito mais.
Herda de directoryObject.
Esse recurso é um tipo aberto que permite que outras propriedades sejam passadas.
Esse recurso permite:
- Adicionar seus próprios dados às propriedades personalizadas como extensions.
- Usar a consulta delta para controlar adições, exclusões e atualizações incrementais oferecendo uma função delta.
- Sintaxe de chave alternativa. A
appIdpropriedade é uma chave alternativa com suporte. Para obter mais informações, confira Obter aplicativo.
Métodos
| Método | Tipo de retorno | Descrição |
|---|---|---|
| Listar aplicativos | Coleção application | Recuperar a lista de aplicativos na organização. |
| Criar aplicativo | application | Cria (registra) um novo aplicativo. |
| Obter aplicativo | application | Ler as propriedades e as relações de um objeto de aplicativo. |
| Atualizar aplicativo | Nenhum | Atualize o objeto application. |
| Aplicativo upsert | application | Crie um novo aplicativo se ele não existir ou atualize as propriedades de um aplicativo existente. |
| Excluir aplicativo | Nenhum | Exclua o objeto application. |
| Obter delta | aplicativo | Obtenha os aplicativos recentemente criados, atualizados ou excluídos sem ter que executar uma leitura completa de toda a coleção de recursos. |
| Listar aplicativos excluídos | Conjunto directoryObject | Recuperar uma lista de aplicativos excluídos recentemente. |
| Lista de aplicativos excluídos pertencentes a usuários | Coleção directoryObject | Recupere os aplicativos excluídos no locatário nos últimos 30 dias e que um usuário possui. |
| Obter o aplicativo excluído | directoryObject | Recuperar as propriedades de um aplicativo excluído recentemente. |
| Excluir aplicativo permanentemente | Nenhum | Exclua permanentemente um aplicativo. |
| Restaurar aplicativo excluído | directoryObject | Restaurar um aplicativo excluído recentemente. |
| Certificados e segredos | ||
| Adicionar senha | passwordCredential | Adicionar uma senha forte a um aplicativo. |
| Remover senha | passwordCredential | Remover uma senha de um aplicativo. |
| Adicionar chave | keyCredential | Adicione uma credencial de chave a um aplicativo. |
| Remover chave | Nenhum(a) | Remova uma credencial de chave de um aplicativo. |
| Owners | ||
| Listar proprietários | Coleção directoryObject | Obtenha os proprietários de um aplicativo. |
| Adicionar proprietário | directoryObject | Atribua um proprietário a um aplicativo. Os proprietários de aplicativos podem ser usuários ou entidades de serviço. |
| Remover proprietário | Nenhum | Remover um proprietário de um aplicativo. Como uma prática recomendada, os aplicativos devem ter pelo menos dois proprietários. |
| Distribuidor verificado | ||
| Definir distribuidor verificado | Nenhum | Definir o distribuidor verificado de um aplicativo. |
| Desmarcar distribuidor verificado | Nenhum | Desmarcar o distribuidor verificado de um aplicativo. |
Propriedades
Importante
O uso específico de $filter e o parâmetro de consulta $search é suportado somente quando se usa o cabeçalho ConsistencyLevel definido como eventual e $count. Para obter mais informações, consulte Recursos avançados de consulta em objetos de diretório.
| Propriedade | Tipo | Descrição |
|---|---|---|
| addIns | Coleção addIn | Define o comportamento personalizado que um serviço de consumo pode usar para chamar um aplicativo em contextos específicos. Por exemplo, aplicativos que podem renderizar fluxos de arquivos podem definir a propriedade addIns para sua funcionalidade "FileHandler". Isso permite que serviços como o Microsoft 365 chamem o aplicativo no contexto de um documento em que o usuário está trabalhando. |
| api | apiApplication | Especifica configurações para um aplicativo que implementa uma API Web. |
| appId | Cadeia de caracteres | O identificador exclusivo do aplicativo atribuído a um aplicativo por Microsoft Entra ID. Não anulável. Somente leitura. Chave alternativa. Suporta $filter (eq). |
| applicationTemplateId | Cadeia de caracteres | Identificador exclusivo do applicationTemplate. Suporta $filter (eq, not, ne). Somente leitura. null se o aplicativo não foi criado a partir de um modelo de aplicativo. |
| appRoles | Coleção appRole | A coleção de funções definidas para o aplicativo. Com as atribuições de funções do aplicativo, essas funções podem ser atribuídas a usuários, grupos ou entidades de serviço de outros aplicativos. Não anulável. |
| certificação | certificação | Especifica o status de certificação do aplicativo. |
| createdDateTime | DateTimeOffset | A data e a hora que o aplicativo foi registrado. O tipo DateTimeOffset representa informações de data e hora usando o formato ISO 8601 e está sempre no horário UTC. Por exemplo, meia-noite UTC em 1 de janeiro de 2014 é 2014-01-01T00:00:00Z. Somente leitura. Dá suporte $filter (eq, ne, not, ge, le, ine eq em null valores ) e $orderby. |
| deletedDateTime | DateTimeOffset | A data e a hora que o aplicativo foi excluído. O tipo DateTimeOffset representa informações de data e hora usando o formato ISO 8601 e está sempre no horário UTC. Por exemplo, meia-noite UTC em 1 de janeiro de 2014 é 2014-01-01T00:00:00Z. Somente leitura. |
| description | Cadeia de caracteres | Campo de texto livre para fornecer uma descrição do objeto de aplicativo aos usuários finais. O tamanho máximo permitido é de 1.024 caracteres. Suporta $filter (eq, ne, not, ge, le, startsWith) e $search. |
| disabledByMicrosoftStatus | Cadeia de caracteres | Especifica se a Microsoft desabilitou o aplicativo registrado. Os valores possíveis são: null (valor padrão), NotDisablede DisabledDueToViolationOfServicesAgreement (os motivos incluem atividade suspeita, abusiva ou mal-intencionada ou uma violação do Contrato de Serviços da Microsoft). Suporta $filter (eq, ne, not). |
| displayName | String | O nome de exibição do aplicativo. Suporta $filter (eq, ne, not, ge, le, in, startsWith, e eq em null valores), $search, e $orderby. |
| groupMembershipClaims | Cadeia de caracteres | Configura a declaração groups emitida em um usuário ou o token de acesso OAuth 2.0 que o aplicativo espera. Para definir esse atributo, use um dos seguintes valores de cadeia de caracteres válidos: None, SecurityGroup (para grupos de segurança e funções Microsoft Entra), All (isso obtém 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). |
| id | Cadeia de caracteres | Identificador exclusivo para o objeto de aplicativo. Essa propriedade é chamada de ID do objeto no centro de administração do Microsoft Entra. Herdado de directoryObject. Chave. Não anulável. Somente leitura. Suporta $filter (eq, ne, not, in). |
| identifierUris | Coleção de cadeias de caracteres | Também conhecido como URI de ID do aplicativo, esse valor é definido quando um aplicativo é usado como um aplicativo de recurso. O identifierUris atua como o prefixo para os escopos que você referencia no código da API e deve ser globalmente exclusivo. Você pode usar o valor padrão fornecido, que está no formato api://<application-client-id>, ou especificar um URI mais acessível como https://contoso.com/api . Para obter mais informações sobre padrões de identifierUris válidos e práticas recomendadas, consulte Microsoft Entra práticas recomendadas de segurança de registro de aplicativo. Não anulável. Suporta $filter (eq, ne, ge, le, startsWith). |
| 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 Como adicionar termos de serviço e declaração de privacidade para aplicativos Microsoft Entra registrados. Dá suporte $filter (eq, ne, not, ge, lee eq em null valores). |
| isDeviceOnlyAuthSupported | Booliano | Especifica se o aplicativo dá suporte à autenticação de dispositivo sem um usuário. O padrão é false. |
| 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 um aplicativo Web. Há certos cenários em que Microsoft Entra ID não pode determinar o tipo de aplicativo cliente. Por exemplo, o fluxo ROPC em que ele está configurado sem especificar um URI de redirecionamento. Nesses casos, Microsoft Entra ID interpreta 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. Suporta $filter (eq, not, ge, le). |
| logo | Stream | O principal logotipo do aplicativo. Não anulável. |
| notes | String | Anotações relevantes para o gerenciamento do aplicativo. |
| oauth2RequiredPostResponse | Booliano | Especifica se, como parte das solicitações de token OAuth 2.0, Microsoft Entra ID permite solicitações POST, em oposição às solicitações GET. O padrão é false, que especifica que somente as solicitações GET são permitidas. |
| optionalClaims | optionalClaims | Os desenvolvedores de aplicativos podem configurar declarações opcionais em seus aplicativos Microsoft Entra para especificar as declarações enviadas ao aplicativo pelo serviço de token de segurança da Microsoft. Para saber mais, confira Como: Fornecer declarações opcionais ao aplicativo. |
| parentalControlSettings | parentalControlSettings | Especifica as configurações de controle parental de um aplicativo. |
| passwordCredentials | Coleção passwordCredential | A coleção de credenciais de senha associada ao aplicativo. Não anulável. |
| publicClient | publicClientApplication | Especifica configurações para clientes instalados, como dispositivos móveis ou da área de trabalho. |
| publisherDomain | String | O domínio do publicador verificado para o aplicativo. Somente leitura. Para obter mais informações, consulte Como: configurar o domínio do publisher de um aplicativo. Suporta $filter (eq, ne, ge, le, startsWith). |
| requestSignatureVerification | requestSignatureVerification | Especifica se esse aplicativo requer Microsoft Entra ID para verificar as solicitações de autenticação assinadas. |
| 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. Para obter mais informações, consulte Limites de permissões solicitadas por aplicativo. Não anulável. Suporta $filter (eq, not, ge, le). |
| 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. Anulável. |
| referênciaDeGerenciamentoDeServiços | Cadeia de caracteres | Faz referência as informações de contato do aplicativo ou serviço de um banco de dados de Gerenciamento de Serviços ou Ativos. Anulável. |
| servicePrincipalLockConfiguration | servicePrincipalLockConfiguration | Especifica se as propriedades confidenciais de um aplicativo multilocatário devem ser bloqueadas para edição depois que o aplicativo for provisionado em um locatário. Anulável. null por padrão. |
| signInAudience | Cadeia de caracteres | Especifique quais contas Microsoft têm suporte para o aplicativo atual. Os valores possíveis são: AzureADMyOrg (padrão), AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccounte PersonalMicrosoftAccount. Confira mais na tabela. O valor desse objeto também limita o número de permissões que um aplicativo pode solicitar. Para obter mais informações, consulte Limites de permissões solicitadas por aplicativo. 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. Suporta $filter (eq, ne, not). |
| 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. As cadeias de caracteres adicionadas aqui também aparecerão na propriedade tags de quaisquer entidades de serviço associadas.$filter Dá suporte (eq, , genot, , startsWithle) e $search. |
| 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. Imutável. Somente leitura. |
| verifiedPublisher | verifiedPublisher | Especifica o fornecedor verificado para o aplicativo. Para obter mais informações sobre como a verificação do editor ajuda a dar suporte à segurança, confiabilidade e conformidade do aplicativo, confira verificação do Publisher. |
| web | webApplication | Especifica configurações para um aplicativo Web. |
signInAudience values
| Valor | Descrição |
|---|---|
| AzureADMyOrg | Usuários com uma conta corporativa ou de estudante da Microsoft no locatário Microsoft Entra da minha organização (locatário único). Este é o valor padrão para a propriedade signInAudience. |
| AzureADMultipleOrgs | Usuários com uma conta corporativa ou de estudante da Microsoft no locatário Microsoft Entra de qualquer organização (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. Para autenticar usuários com fluxos de usuário do Active Directory B2C, use o AzureADandPersonalMicrosoftAccount. Este valor permite o mais amplo conjunto de identidades de usuário, incluindo contas locais e identidades de usuário da Microsoft, Facebook, Google, Twitter ou qualquer provedor de conexão OpenID. |
| PersonalMicrosoftAccount | Usuários com uma conta Microsoft pessoal apenas. |
Limites de permissões solicitadas por aplicativo
Microsoft Entra ID limita o número de permissões que podem ser solicitadas e consentidas por um aplicativo cliente. Esses limites dependem do signInAudience valor de um aplicativo, mostrado no manifesto do aplicativo.
| signInAudience | Usuários permitidos | Máximo de permissões que o aplicativo pode solicitar | Máximo de permissões do Microsoft Graph que o aplicativo pode solicitar | Máximo de permissões que podem ser consentidas em uma única solicitação |
|---|---|---|---|---|
| AzureADMyOrg | Usuários da organização em que o aplicativo está registrado | 400 | 400 | Cerca de 155 permissões delegadas e cerca de 300 permissões de aplicativo |
| AzureADMultipleOrgs | Usuários de qualquer organização Microsoft Entra | 400 | 400 | Cerca de 155 permissões delegadas e cerca de 300 permissões de aplicativo |
| PersonalMicrosoftAccount | Usuários consumidores (como contas do Outlook.com ou Live.com) | 30 | 30 | 30 |
| AzureADandPersonalMicrosoftAccount | Usuários e usuários consumidores de qualquer organização Microsoft Entra | 30 | 30 | 30 |
Relações
Importante
O uso específico do $filter parâmetro de consulta só é compatível quando você usa o cabeçalho ConsistencyLevel definido como eventual e $count. Para obter mais informações, consulte Recursos avançados de consulta em objetos de diretório.
| Relação | Tipo | Descrição |
|---|---|---|
| appManagementPolicies | appManagementPolicy collection | O appManagementPolicy aplicado a este aplicativo. |
| createdOnBehalfOf | directoryObject | Suporta $filter (/$count eq 0, /$count ne 0). Somente leitura. |
| extensionProperties | Coleção extensionProperty | Somente leitura. Anulável. $expand Dá suporte e $filter (/$count eq 0, /$count ne 0). |
| federatedIdentityCredentials | Coleção federatedIdentityCredential | Identidades federadas para aplicativos. $expand Dá suporte e $filter (startsWith, , /$count ne 0/$count eq 0). |
| owners | Coleção directoryObject | Objetos de diretório que são proprietários do aplicativo. Somente leitura. Anulável. $expandDá suporte a , $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1), e $select aninhado em $expand. |
| Sincronização | sincronização | Representa o recurso para Microsoft Entra sincronização de identidade por meio do microsoft API do Graph. |
Representação JSON
A representação JSON a seguir mostra o tipo de recurso.
{
"addIns": [{"@odata.type": "microsoft.graph.addIn"}],
"api": {"@odata.type": "microsoft.graph.apiApplication"},
"appId": "String",
"applicationTemplateId": "String",
"appRoles": [{"@odata.type": "microsoft.graph.appRole"}],
"certification": {"@odata.type": "microsoft.graph.certification"},
"createdDateTime": "String (timestamp)",
"deletedDateTime": "String (timestamp)",
"disabledByMicrosoftStatus": "String",
"displayName": "String",
"groupMembershipClaims": "String",
"id": "String (identifier)",
"identifierUris": ["String"],
"info": {"@odata.type": "microsoft.graph.informationalUrl"},
"isDeviceOnlyAuthSupported": false,
"isFallbackPublicClient": false,
"keyCredentials": [{"@odata.type": "microsoft.graph.keyCredential"}],
"logo": "Stream",
"notes": "String",
"oauth2RequiredPostResponse": false,
"optionalClaims": {"@odata.type": "microsoft.graph.optionalClaims"},
"parentalControlSettings": {"@odata.type": "microsoft.graph.parentalControlSettings"},
"passwordCredentials": [{"@odata.type": "microsoft.graph.passwordCredential"}],
"publicClient": {"@odata.type": "microsoft.graph.publicClientApplication"},
"publisherDomain": "String",
"requestSignatureVerification": {"@odata.type": "microsoft.graph.requestSignatureVerification"},
"requiredResourceAccess": [{"@odata.type": "microsoft.graph.requiredResourceAccess"}],
"servicePrincipalLockConfiguration": {"@odata.type": "microsoft.graph.servicePrincipalLockConfiguration"},
"serviceManagementReference": "String",
"signInAudience": "String",
"spa": {"@odata.type": "microsoft.graph.spaApplication"},
"tags": ["String"],
"tokenEncryptionKeyId": "String",
"uniqueName": "String",
"verifiedPublisher": {"@odata.type": "microsoft.graph.verifiedPublisher"},
"web": {"@odata.type": "microsoft.graph.webApplication"}
}
Conteúdo relacionado
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de