tipo de recurso do aplicativo
Namespace: microsoft.graph
Representa um aplicativo. Qualquer aplicativo que terceirize a autenticação no Azure Active Directory (Azure AD) deve estar registrado em um diretório. O registro do aplicativo envolve informar o Azure AD sobre seu aplicativo, incluindo a URL onde ele está localizado, a URL para enviar respostas após a autenticação, o URI para identificar seu aplicativo e muito mais. Para saber mais, confira Noções básicas de como registrar um aplicativo no Azure AD. 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.
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. |
| 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 pertencem a um usuário. |
| Obter o aplicativo excluído | directoryObject | Recuperar as propriedades de um aplicativo excluído recentemente. |
| Excluir aplicativo permanentemente | Nenhum | Excluir 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. |
| Extensões | ||
| Listar extensionProperties | Coleção extensionProperty | Listar propriedades de extensão em um objeto de aplicativo. |
| Criar extensionProperties | extensionProperty | Criar uma propriedade de extensão em um objeto de aplicativo. |
| Obter extensionProperty | Nenhum | Obter uma propriedade de extensão de um objeto de aplicativo. |
| Excluir extensionProperty | Nenhum | Excluir uma propriedade de extensão de um objeto de aplicativo. |
| Obtenha as propriedades de extensão disponíveis | Coleção extensionProperty | Obtenha todas as listas ou uma lista filtrada das propriedades de extensão do diretório que foram registradas em um diretório. |
| Credenciais de identidade federada | ||
| Lista federatedIdentityCredential | Coleção federatedIdentityCredential | Listar credenciais de identidade federada em um objeto de aplicativo. |
| Criar federatedIdentityCredential | federatedIdentityCredential | Crie uma credencial de identidade federada em um objeto de aplicativo. |
| Obter federatedIdentityCredential | federatedIdentityCredential | Recupere as propriedades de uma credencial de identidade federada. |
| Atualizar federatedIdentityCredential | Nenhum | Atualize uma credencial de identidade federada de um objeto de aplicativo. |
| Excluir federatedIdentityCredential | Nenhum | Exclua uma credencial de identidade federada de um objeto de 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. |
| Políticas | ||
| Atribuir tokenIssuancePolicy | coleção tokenIssuancePolicy | Atribuir um tokenIssuancePolicy a este objeto. |
| Listar TokenIssuancePolicies | coleção tokenIssuancePolicy | Obter todos os tokenIssuancePolicies atribuídos a este objeto. |
| Remover tokenIssuancePolicy | coleção tokenIssuancePolicy | Remover um tokenIssuancePolicy deste objeto. |
| Atribiur tokenLifetimePolicy | Conjunto tokenLifetimePolicy | Atribuir um tokenLifetimePolicy a este objeto. |
| Listar tokenLifetimePolicies | Conjunto tokenLifetimePolicy | Obter todos os tokenLifetimePolicies atribuídos a este objeto. |
| Remover tokenLifetimePolicy | Conjunto tokenLifetimePolicy | Remover um tokenLifetimePolicy deste objeto. |
| 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 Funcionalidades avançadas de consulta nos objetos de diretório do Microsoft Azure AD.
| 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 arquivo podem definir a propriedade addIns para a funcionalidade "FileHandler". Isso permitirá que serviços como o Office 365 chamem o aplicativo no contexto de um documento em que o usuário esteja trabalhando. |
| api | apiApplication | Especifica configurações para um aplicativo que implementa uma API Web. |
| appId | String | O identificador exclusivo para o aplicativo que está atribuído a um aplicativo pelo Azure AD. Não anulável. Somente leitura. Suporta $filter (eq). |
| applicationTemplateId | String | Identificador exclusivo do applicationTemplate. Suporta $filter (eq, not, ne). |
| 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), 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. 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 do Azure Active Directory),All (isso obtém todos os grupos de segurança, grupos de distribuição e funções de diretório do Azure Active Directory que o usuário conectado é um membro de). |
| id | Cadeia de caracteres | Identificador exclusivo para o objeto de aplicativo. Essa propriedade é conhecida como ID do objeto no portal do Azure. 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 age 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 e práticas recomendadas de identificadorUris válidos, consulte Práticas recomendadas de segurança de registro de aplicativos do Azure AD. 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, confira Como adicionar termos de serviço e política de privacidade a aplicativos do Azure AD 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 é cliente confidencial, como um aplicativo web. No entanto, há situações em que o Azure AD não consegue determinar o tipo de aplicativo cliente. Por exemplo, o fluxo ROPC onde o aplicativo está configurado sem especificar um URI de redirecionamento. Nesses casos, o Azure AD 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. 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 | Boolean | Especifica se, como parte das solicitações de token OAuth 2.0, o Azure AD permite solicitações POST, em vez de solicitações GET. O padrão é false, que especifica que somente as solicitações GET são permitidas. |
| optionalClaims | optionalClaims | Desenvolvedores de aplicativos podem configurar declarações opcionais em aplicativos do Azure AD para especificar quais declarações serão 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). |
| 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. |
| signInAudience | Cadeia de caracteres | Especifique quais contas Microsoft têm suporte para o aplicativo atual. Os valores possíveis são: AzureADMyOrg, AzureADMultipleOrgs, AzureADandPersonalMicrosoftAccount (padrão) e 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. Suporta $filter (eq, not, ge, le, startsWith). |
| tokenEncryptionKeyId | Cadeia de caracteres | Especifica a keyId de uma chave pública da coleção keyCredentials. Quando configurado, o Azure AD criptografa todos os tokens emitidos 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. |
| 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 de corporativa ou estudante da Microsoft no locatário do Azure Active Directory da minha organização (locatário único). |
| AzureADMultipleOrgs | Usuários com uma conta de trabalho ou escola da Microsoft em qualquer locatário do Azure Active Directory (multilocatário) da organização. |
| AzureADandPersonalMicrosoftAccount | : Usuários com uma conta Microsoft pessoal, corporativa ou de estudante no locatário do Azure Active Directory 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. Este é o valor padrão para a propriedade signInAudience. |
| PersonalMicrosoftAccount | Usuários com uma conta Microsoft pessoal apenas. |
Limites de permissões solicitadas por aplicativo
O Azure AD 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 do Azure AD | 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 do Azure AD | 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 Funcionalidades avançadas de consulta nos objetos de diretório do Microsoft Azure AD.
| Relação | Tipo | Descrição |
|---|---|---|
| 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. $expand Dá suporte e $filter (/$count eq 0, , /$count ne 0, /$count ne 1/$count eq 1). |
Representação JSON
Veja a seguir uma representação JSON do 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",
"requiredResourceAccess": [{"@odata.type": "microsoft.graph.requiredResourceAccess"}],
"serviceManagementReference": "String",
"signInAudience": "String",
"spa": {"@odata.type": "microsoft.graph.spaApplication"},
"tags": ["String"],
"tokenEncryptionKeyId": "String",
"verifiedPublisher": {"@odata.type": "microsoft.graph.verifiedPublisher"},
"web": {"@odata.type": "microsoft.graph.webApplication"}
}