tipo de recurso do aplicativo
Namespace: microsoft.graph
Importante
As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.
Representa um aplicativo. Qualquer aplicação que subcontrata a autenticação para Microsoft Entra ID tem de ser registada no plataforma de identidade da Microsoft. O registo de aplicações envolve informar Microsoft Entra ID sobre a sua aplicação, incluindo o URL onde está localizada, o URL para enviar respostas após a autenticação, o URI para identificar a sua aplicação 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 tecla alternativa. A
appIdpropriedade é uma chave alternativa suportada. Para obter mais informações, veja Obter aplicação.
Métodos
| Método | Tipo de retorno | Descrição |
|---|---|---|
| List | Coleção application | Recuperar a lista de aplicativos na organização. |
| Create | application | Cria (registra) um novo aplicativo. |
| Get | application | Ler as propriedades e as relações de um objeto de aplicativo. |
| Atualizar | Nenhum | Atualize o objeto application. |
| Upsert | application | Crie uma nova aplicação se não existir ou atualize as propriedades de uma aplicação existente. |
| Delete | Nenhum | Exclua o objeto application. |
| Obter delta | Coleção application | Obtenha alterações incrementais para aplicativos. |
| Itens excluídos | ||
| List | Conjunto directoryObject | Recuperar uma lista de aplicativos excluídos recentemente. |
| Get | directoryObject | Recuperar as propriedades de um aplicativo excluído recentemente. |
| Restaurar | directoryObject | Restaurar um aplicativo excluído recentemente. |
| Excluir permanentemente | Nenhum | Eliminar permanentemente uma aplicação. |
| Listar itens excluídos pertencentes ao usuário | Coleção directoryObject | Recupere os aplicativos excluídos no locatário nos últimos 30 dias e que pertencem a um usuário. |
| Certificados e segredos | ||
| Adicionar senha | passwordCredential | Adicione uma senha ou segredo forte a um aplicativo. |
| Remover senha | passwordCredential | Remover uma senha ou segredo 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 | ||
| List | Coleção directoryObject | Obtenha os proprietários de uma aplicação. |
| Add | directoryObject | Atribuir um proprietário a uma aplicação. Os proprietários de aplicações podem ser utilizadores ou principais de serviço. |
| Remove | Nenhum | Remover um proprietário de um aplicativo. Como melhor prática recomendada, as aplicações devem ter, pelo menos, dois proprietários. |
| Distribuidor verificado | ||
| Set | Nenhum | Definir o distribuidor verificado de um aplicativo. |
| Desmarcar | 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, veja Capacidades avançadas 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, as aplicações que podem compor fluxos de ficheiros podem definir a propriedade addIns para a respetiva funcionalidade "FileHandler". Isto permite que serviços como Office 365 chamem a aplicação no contexto de um documento em que o utilizador está a trabalhar. |
| api | apiApplication | Especifica configurações para um aplicativo que implementa uma API Web. |
| appId | Cadeia de caracteres | O identificador exclusivo da aplicação atribuída 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 a aplicação não tiver sido criada a partir de um modelo de aplicação. |
| appRoles | Coleção appRole | A coleção de funções definidas para a aplicação. 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. |
| authenticationBehaviors | authenticationBehaviors | A coleção de comportamentos de alteração interruptiva relacionados com a emissão de tokens que estão configurados para a aplicação. Os comportamentos de autenticação não estão definidos por predefinição (null) e têm de estar explicitamente ativados ou desativados. Anulável. Retornado apenas em $select. Para obter mais informações sobre comportamentos de autenticação, veja Gerir autenticação de aplicaçõesBehaviors para evitar a utilização não verificada de afirmações de e-mail para identificação ou autorização de utilizador. |
| 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. Suporta $filter (eq, ne, not, ge, le, in, e eq em null valores) e $orderby. |
| defaultRedirectUri | String | O URI de redirecionamento padrão. Se for especificado e não existir nenhum URI de redirecionamento explícito no pedido de início de sessão para fluxos SAML e OIDC, Microsoft Entra ID envia o token para este URI de redirecionamento. Microsoft Entra ID também envia o token para este URI predefinido no início de sessão único iniciado pelo IdP de SAML. O valor deve corresponder a um dos URIs de redirecionamento configurados para o aplicativo. |
| 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 1024 carateres. Devolvido por padrão. 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), NotDisabled e DisabledDueToViolationOfServicesAgreement (os motivos podem incluir atividades suspeitas, abusivas ou maliciosas ou uma violação do Contrato de Serviços Microsoft). Suporta $filter (eq, ne, not). |
| displayName | String | O nome de exibição do aplicativo. O comprimento máximo é de 256 caracteres. 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 este atributo, utilize um dos seguintes valores de cadeia de carateres: None, SecurityGroup (para grupos de segurança e funções de Microsoft Entra), All (obtém todos os grupos de segurança, grupos de distribuição e Microsoft Entra funções de diretório das quais o utilizador com sessão iniciada é membro). |
| id | Cadeia de caracteres | Identificador exclusivo para o objeto de aplicativo. Esta propriedade é referida como ID de 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 dos âmbitos que referencia no código da API e tem de ser globalmente exclusivo. Você pode usar o valor padrão fornecido, que está no formato api://<appId>, 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 melhores práticas, veja Microsoft Entra melhores práticas de segurança de registo de aplicações. Não anulável. Suporta $filter (eq, ne, ge, le, startsWith). |
| informações | informationalUrl | Informações básicas de perfil do aplicativo, como marketing, suporte, termos de serviço e URLs de política de privacidade do aplicativo. 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, veja How to: Add Terms of service and privacy statement for registered Microsoft Entra apps (Como: Adicionar Termos de serviço e declaração de privacidade para aplicações Microsoft Entra registadas). 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 predefinido é false, o que significa que o tipo de aplicação de contingência é um cliente confidencial, como uma aplicação Web. Existem determinados cenários em que Microsoft Entra ID não consegue determinar o tipo de aplicação cliente. Por exemplo, o fluxo ROPC onde o aplicativo está configurado sem especificar um URI de redirecionamento. Nesses casos, Microsoft Entra ID interpreta 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. Suporta $filter (eq, not, ge, le). |
| logo | Stream | O principal logotipo do aplicativo. Não anulável. |
| nativeAuthenticationApisEnabled | nativeAuthenticationApisEnabled | Especifica se as APIs de Autenticação Nativa estão ativadas para a aplicação. Os valores possíveis são: nonee all. O padrão é none. Para obter mais informações, veja Autenticação Nativa. |
| notes | String | Anotações relevantes para o gerenciamento do aplicativo. |
| oauth2RequiredPostResponse | Booliano | Especifica se, como parte dos pedidos de tokens OAuth 2.0, Microsoft Entra ID permite pedidos POST, em oposição aos pedidos GET. O padrão é false, que especifica que somente as solicitações GET são permitidas. |
| onPremisesPublishing | onPremisesPublishing | Representa o conjunto de propriedades necessário para configurar o Proxy de Aplicativo para este aplicativo. Configurar essas propriedades permite que você publique seu aplicativo local para acesso remoto seguro. |
| optionalClaims | optionalClaims | Os programadores de aplicações podem configurar afirmações opcionais nas respetivas aplicações Microsoft Entra para especificar as afirmações que são enviadas para a respetiva aplicação pelo serviço de tokens 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. Suporta $filter (eq, ne, ge, le, startsWith). |
| requestSignatureVerification | requestSignatureVerification | Especifica se esta aplicação requer Microsoft Entra ID para verificar os pedidos de autenticação assinados. |
| 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, veja Limites das permissões pedidas por aplicação. 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. |
| signInAudience | Cadeia de caracteres | Especifique quais contas Microsoft têm suporte para o aplicativo atual. Os valores possíveis são: AzureADMyOrg (predefinição), AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccounte PersonalMicrosoftAccount. Veja mais na tabela. O valor deste objeto também limita o número de permissões que uma aplicação pode pedir. Para obter mais informações, veja Limites das permissões pedidas por aplicaçã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). Suporta $filter (eq, ne, not). |
| servicePrincipalLockConfiguration | servicePrincipalLockConfiguration | Especifica se as propriedades confidenciais de uma aplicação multi-inquilino devem ser bloqueadas para edição depois de a aplicação ser aprovisionada num inquilino. Anulável.
null por predefinição. |
| 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 adicionadas aqui também aparecem na propriedade tags de quaisquer principais de serviço associados.$filter Suporta (eq, not, ge, le, startsWith) e $search. |
| tokenEncryptionKeyId | Guid | Especifica a keyId de uma chave pública da coleção keyCredentials. Quando configurado, Microsoft Entra ID encripta todos os tokens que emite com a 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. 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. |
| windows | windowsApplication | Especifica as configurações dos aplicativos que executam o Microsoft Windows e publicados no Microsoft Store ou no armazenamento de jogos do Xbox. |
signInAudience values
| Valor | Descrição |
|---|---|
| AzureADMyOrg | Utilizadores com uma conta escolar ou profissional da Microsoft no inquilino Microsoft Entra da minha organização (inquilino único). Este é o valor padrão para a propriedade signInAudience. |
| AzureADMultipleOrgs | Utilizadores com uma conta escolar ou profissional da Microsoft no inquilino Microsoft Entra de qualquer organização (multi-inquilino). |
| AzureADandPersonalMicrosoftAccount | Utilizadores com uma conta Microsoft pessoal ou uma conta escolar ou profissional no inquilino 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 pedidas e consentidas por uma aplicação cliente. Estes limites dependem do signInAudience valor de uma aplicação, mostrado no manifesto da aplicação.
| 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 | Utilizadores 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 | Utilizadores e utilizadores consumidores de qualquer organização Microsoft Entra | 30 | 30 | 30 |
Relações
Importante
A utilização específica do $filter parâmetro de consulta só é suportada quando utiliza o cabeçalho ConsistencyLevel definido como eventual e $count. Para obter mais informações, veja Capacidades avançadas de consulta em objetos de diretório.
| Relação | Tipo | Descrição |
|---|---|---|
| appManagementPolicies | appManagementPolicy collection | O appManagementPolicy aplicado a este aplicativo. |
| calls | Coleção call | Somente leitura. Anulável. |
| connectorGroup | connectorGroup | O connectorGroup que a aplicação está a utilizar com Microsoft Entra proxy de aplicações. Anulável. |
| createdOnBehalfOf | directoryObject | Suporta $filter (/$count eq 0, /$count ne 0). Somente leitura. |
| extensionProperties | Coleção extensionProperty | Somente leitura. Anulável.
$expand Suporta e $filter (/$count eq 0, /$count ne 0). |
| federatedIdentityCredentials | Coleção federatedIdentityCredential | Identidades federadas para aplicativos.
$expand Suporta e $filter (startsWith, /$count eq 0, /$count ne 0). |
| onlineMeetings | Coleção onlineMeeting | Somente leitura. Anulável. |
| owners | Coleção directoryObject | Objetos de diretório que são proprietários do aplicativo. Somente leitura. Anulável.
$expandSuporta , $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1) e $select aninhado em $expand. |
| sincronização | sincronização | Representa a capacidade de sincronização de identidades Microsoft Entra através do Microsoft API do Graph. |
| tokenLifetimePolicies | Coleção tokenLifetimePolicy | O tokenLifetimePolicies atribuído a esse aplicativo. Suporta $expand. |
Representação JSON
A representação JSON seguinte 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"}],
"authenticationBehaviors": {"@odata.type": "microsoft.graph.authenticationBehaviors"},
"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",
"nativeAuthenticationApisEnabled": "String",
"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"},
"windows": {"@odata.type": "microsoft.graph.windowsApplication"}
}