Tipo de recurso servicePrincipal

Namespace: microsoft.graph

Representa uma instância de um aplicativo em um diretório. Herda de directoryObject.

O recurso agentIdentityBlueprintPrincipal herda desse objeto.

Esse recurso tem suporte para o uso da consulta delta para controlar adições, exclusões e atualizações incrementais oferecendo uma função delta. Esse recurso é um tipo aberto que permite propriedades adicionais além daquelas documentadas aqui.

Métodos

Método Tipo de retorno Descrição
List servicePrincipal collection Recupere uma lista de objetos servicePrincipal.
Create servicePrincipal Cria um novo objeto servicePrincipal.
Get servicePrincipal Leia as propriedades e as relações do objeto servicePrincipal.
Update servicePrincipal Atualize o objeto servicePrincipal.
Executar upsert servicePrincipal Crie um novo servicePrincipal se ele não existir ou atualize as propriedades de um servicePrincipal existente.
Delete Nenhum Exclua o objeto servicePrincipal.
Obter delta servicePrincipal collection Obtenha alterações incrementais para entidades de serviço.
Listar objetos criados directoryObject collection Obtenha uma coleção de objeto createdObject.
Listar objetos de propriedade Coleção directoryObject Obtenha uma coleção de objeto ownedObject.
Itens excluídos
List Coleção directoryObject Recupere uma lista de objetos servicePrincipal excluídos recentemente.
Get directoryObject Recupere as propriedades de um objeto servicePrincipal excluído recentemente.
Restaurar directoryObject Restaure um objeto servicePrincipal excluído recentemente.
Excluir permanentemente Nenhum Exclua permanentemente um objeto servicePrincipal.
Atribuição de funções do aplicativo
List appRoleAssignments appRoleAssignment collection Obtenha as funções de aplicativo atribuídas a essa entidade de serviço.
Adicionar uma atribuição de função do aplicativo appRoleAssignment Atribuir uma função de aplicativo a essa entidade de serviço.
Remover uma atribuição de função do aplicativo Nenhum(a) Remover uma atribuição de função de aplicativo dessa entidade de serviço.
Listar appRoleAssignedTo coleção appRoleAssignment Obtenha os usuários, grupos e funções de aplicativo atribuídos a essa entidade de serviço.
Adicionar appRoleAssignedTo appRoleAssignment Atribuir uma função de aplicativo dessa entidade de serviço a um usuário, grupo ou entidade de serviço.
Remover appRoleAssignedTo Nenhum(a) Remova uma atribuição de função de aplicativo dessa entidade de serviço de um usuário, grupo ou entidade de serviço.
Certificados e segredos
Adicionar senha passwordCredential Adicione uma senha ou segredo forte a um servicePrincipal.
Remover senha passwordCredential Remova uma senha ou segredo de um servicePrincipal.
Adicionar chave keyCredential Adicione uma credencial de chave a uma servicePrincipal.
Remover chave Nenhum(a) Remova uma credencial de chave de uma servicePrincipal.
Adicionar certificado de assinatura de token selfSignedCertificate Adicione um certificado auto-assinado à entidade de serviço. Usado principalmente para configurar aplicativos de SSO baseados em SAML da galeria do Microsoft Entra.
Classificações de permissão delegada
List Coleção delegatedPermissionClassification Obtenha as classificações de permissão para permissões delegadas expostas por essa entidade de serviço.
Add delegatedPermissionClassification Adicione uma classificação de permissão para uma permissão delegada exposta por essa entidade de serviço.
Remove Nenhum Remova uma classificação de permissão para uma permissão delegada exposta por essa entidade de serviço.
Concessões de permissão delegada (OAuth2)
List oAuth2PermissionGrant collection Obtenha as concessões de permissão delegadas que autorizam essa entidade de serviço a acessar uma API em nome de um usuário conectado.
Associação
Listar memberOf directoryObject collection Obtenha grupos dos quais essa entidade de serviço é membro direto da propriedade de navegação memberOf.
Listar membro transitivo de directoryObject collection Liste os grupos dos quais essa entidade de serviço é membro. Essa operação é transitiva e inclui os grupos dos quais essa entidade de serviço é um membro aninhado.
Verificar grupos de membros Coleção de cadeias de caracteres Verifique se há associação em uma lista de grupos específica.
Verificar objetos de membro Coleção de cadeias de caracteres Verifique se há associação em uma lista de grupo específica, função de diretório ou objetos de unidade administrativa.
Obter grupos de membros Coleção de cadeias de caracteres Obtenha a lista de grupos dos quais essa entidade de serviço é membro.
Obter objetos de membros String collection Obtenha a lista de grupos e funções de diretório dos quais essa entidade de serviço é membro.
Owners
List Coleção directoryObject Obtenha os proprietários de uma entidade de serviço.
Add directoryObject Atribuir um proprietário a uma entidade de serviço. Os proprietários da entidade de serviço podem ser usuários ou outras entidades de serviço.
Remove Nenhum Remova um proprietário de uma entidade de serviço. Como prática recomendada, as entidades de serviço devem ter pelo menos dois proprietários.

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
accountEnabled Booliano true se a conta da entidade de serviço estiver habilitada; caso contrário, false. Se definido como false, nenhum usuário poderá entrar neste aplicativo, mesmo que esteja atribuído a ele. Suporta $filter (eq, ne, not, in).
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 permite que serviços como o Microsoft 365 chamem o aplicativo no contexto de um documento no qual o usuário está trabalhando.
alternativeNames Coleção de cadeias de caracteres Usado para recuperar entidades de serviço por assinatura, identificar IDs de recursos completas e de grupo de recursos para identidades gerenciadas. Suporta $filter (eq, not, ge, le, startsWith).
appDescription String A descrição exposta pelo aplicativo associado.
appDisplayName String O nome de exibição exposto pelo aplicativo associado. O comprimento máximo é de 256 caracteres.
appId String O identificador exclusivo do aplicativo associado (sua propriedade appId). Chave alternativa. Suporta $filter (eq, ne, not, in, startsWith).
applicationTemplateId Cadeia de caracteres Identificador exclusivo do applicationTemplate. Suporta $filter (eq, not, ne). Somente leitura. null Se a entidade de serviço não tiver sido criada a partir de um modelo de aplicativo.
appOwnerOrganizationId Guid Contém a ID do locatário em que o aplicativo está registrado. Isso é aplicável apenas a entidades de serviço respaldadas por aplicativos. Suporta $filter (eq, ne, NOT, ge, le).
appRoleAssignmentRequired Booliano Especifica se os usuários ou outras entidade de serviço precisam receber uma atribuição de função de aplicativo para essa entidade de serviço antes que os usuários possam entrar ou os aplicativos possam obter tokens. O valor padrão é false. Não anulável.

Suporta $filter (eq, ne, NOT).
appRoles Coleção appRole As funções expostas pelo aplicativo vinculado a essa entidade de serviço. Para obter mais informações, consulte a definição de propriedade appRoles na entidade de aplicativo . Não anulável.
createdByAppId Cadeia de caracteres O appId do aplicativo que criou essa entidade de serviço. Definido internamente pelo Microsoft Entra ID. Somente leitura.
customSecurityAttributes customSecurityAttributeValue Um tipo complexo aberto que contém o valor de um atributo de segurança personalizado atribuído a um objeto do diretório. Anulável.

Requer $select recuperação. Suporta $filter (eq, ne, not, startsWith). O valor do filtro diferencia maiúsculas de minúsculas.
  • Para ler essa propriedade, o aplicativo de chamada deve receber a permissão CustomSecAttributeAssignment.Read.All . Para gravar essa propriedade, o aplicativo de chamada deve receber as permissões CustomSecAttributeAssignment.ReadWrite.All .
  • Para ler ou gravar essa propriedade em cenários delegados, o administrador deve receber a função de Administrador de Atribuição de Atributos .
    		•
    deletedDateTime DateTimeOffset A data e a hora em que a entidade de serviço foi excluída. Somente leitura.
    description String Campo de texto disponível para fornecer uma descrição voltada para o usuário final interno da entidade de serviço. Portais de usuário final, como MyApps , exibem a descrição do aplicativo neste campo. 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 atividades suspeitas, abusivas ou mal-intencionadas ou uma violação do Contrato de Serviços Microsoft).

    Suporta $filter (eq, ne, not).
    displayName String O nome de exibição da entidade de serviço. Suporte $filter (eq, ne, not, ge, le, in, startsWith, e eq em null valores), $searche $orderby.
    homepage Cadeia de caracteres Página inicial ou página de aterrissagem do aplicativo.
    id Cadeia de caracteres O identificador exclusivo da entidade de serviço. Herdado de directoryObject. Chave. Não anulável. Somente leitura. Suporta $filter (eq, ne, not, in).
    informações informationalUrl Informações básicas de perfil do aplicativo adquirido, 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, consulte Como adicionar os Termos de serviço e a política de privacidade para aplicativos registrados do Microsoft Entra.

    Suporta $filter (eq, ne, not, ge, lee eq em null valores).
    keyCredentials keyCredential collection A coleção de credenciais principais associada à entidade de serviço. Não anulável. Suporta $filter (eq, not, ge, le).
    loginUrl Cadeia de caracteres Especifica a URL na qual o provedor de serviços redireciona o usuário para o Microsoft Entra ID para autenticação. Microsoft Entra ID usa a URL para iniciar o aplicativo do Microsoft 365 ou do Microsoft Entra Meus Aplicativos. Quando em branco, o Microsoft Entra ID executa o logon iniciado pelo IdP para aplicativos configurados com logon único baseado em SAML. O usuário inicia o aplicativo do Microsoft 365, o Microsoft Entra Meus Aplicativos ou a URL de SSO do Microsoft Entra.
    logoutUrl Cadeia de caracteres Especifica a URL que o serviço de autorização da Microsoft usa para desconectar um usuário usando os protocolos de desconexão do canal frontal, do canal traseiro ou do SAML do OpenID Connect.
    notes String Campo de texto disponível para capturar informações sobre o principal do serviço, normalmente usado para fins operacionais. O tamanho máximo permitido é de 1.024 caracteres.
    NotificationEmailAddresses Coleção de cadeias de caracteres Especifica a lista de endereços de email para os quais o Microsoft Entra ID envia uma notificação quando o certificado ativo está próximo da data de vencimento. Isso é apenas para os certificados usados para assinar o token SAML emitido para aplicativos da Galeria do Microsoft Entra.
    oauth2PermissionScopes coleção permissionScope As permissões delegadas expostas pelo aplicativo. Para obter mais informações, consulte a propriedade oauth2PermissionScopes na propriedade api da entidade de aplicativo. Não anulável.
    passwordCredentials Coleção passwordCredential A coleção de credenciais de senha associada ao aplicativo. Não anulável.
    preferredSingleSignOnMode cadeia de caracteres Especifica o modo de logon único configurado para este aplicativo. O Microsoft Entra ID usa o modo de logon único preferencial para iniciar o aplicativo no Microsoft 365 ou no portal Meus Aplicativos. Os valores com suporte são: password, saml, notSupported, e oidc. Observação: Esse campo pode ser null para aplicativos SAML mais antigos e para aplicativos OIDC em que ele não é definido automaticamente.
    preferredTokenSigningKeyThumbprint String Essa propriedade pode ser usada em aplicativos SAML (aplicativos que têm preferredSingleSignOnMode definido como saml) para controlar qual certificado é usado para assinar as respostas SAML. Para aplicativos que não são SAML, não grave nem confie nessa propriedade.
    replyUrls String collection As URLs às quais os tokens de usuário são enviados para entrar com aplicativo associado ou os URIs de redirecionamento aos quais os códigos de autorização do OAuth 2.0 e tokens de acesso são enviados para o aplicativo associado. Não anulável.
    resourceSpecificApplicationPermissions Coleção resourceSpecificPermission As permissões de aplicativo específicas do recurso expostas por este aplicativo. Atualmente, as permissões específicas de recursos só têm suporte para aplicativos Teams que acessam chats e equipes específicos usando Microsoft Graph. Somente leitura.
    samlSingleSignOnSettings samlSingleSignOnSettings A coleção das configurações relacionadas ao logon único do SAML.
    servicePrincipalNames Coleção de cadeias de caracteres Contém a lista de identificadoresUris, copiados do aplicativo associado. É possível adicionar valores adicionais aos aplicativos híbridos. Esses valores podem ser usados para identificar as permissões expostas por esse aplicativo no Microsoft Entra ID. Por exemplo,
    • Os aplicativos cliente podem especificar um URI de recurso baseado nos valores dessa propriedade para adquirir um token de acesso, que é o URI retornado na declaração "aud".

    O operador any é obrigatório para expressões de filtro em propriedades de vários valores. Não anulável.

    Suporta $filter (eq, not, ge, le, startsWith).
    servicePrincipalType Cadeia de caracteres Identifica se a entidade de serviço representa um aplicativo, uma identidade gerenciada ou um aplicativo herdado. Essa propriedade é definida internamente pelo Microsoft Entra ID. A propriedade servicePrincipalType pode ser definida para três valores diferentes:
    • Application - Uma entidade de serviço que representa um aplicativo ou serviço. A propriedade appId identifica o registro do aplicativo associado e corresponde a appId de um aplicativo, possivelmente de um locatário diferente. Se o registro do aplicativo associado estiver ausente, os tokens não serão emitidos para a entidade de serviço.
    • ManagedIdentity - Uma entidade de serviço que representa uma identidade gerenciada. As entidades de serviço que representam identidades gerenciadas podem receber acesso e permissões, mas não podem ser atualizadas ou modificadas diretamente.
    • Legacy - Uma entidade de serviço que representa um aplicativo criado antes dos registros do aplicativo ou por meio de experiências herdadas. Uma entidade de serviço herdada pode ter credenciais, nomes de entidades de serviço, URLs de resposta e outras propriedades que podem ser editadas por um usuário autorizado, mas não tem um registro de aplicativo associado. O valor appId não associa a entidade de serviço a um registro de aplicativo. A entidade de serviço só pode ser usada no locatário em que foi criada.
    • ServiceIdentity - Uma entidade de serviço que representa uma identidade de agente.
  • SocialIdp - Para uso interno.
    • signInAudience Cadeia de caracteres Especifique quais contas Microsoft têm suporte para o aplicativo atual. Somente leitura.

    Os valores com suporte são:
    • AzureADMyOrg: usuários com uma conta corporativa ou de estudante da Microsoft no locatário do Microsoft Entra da minha organização (locatário único).
    • AzureADMultipleOrgs: usuários com uma conta corporativa ou de estudante da Microsoft no locatário do Microsoft Entra de qualquer organização (multilocatário).
    • AzureADandPersonalMicrosoftAccount: usuários com uma conta Microsoft pessoal ou uma conta corporativa ou de estudante no locatário do Microsoft Entra de qualquer organização.
    • PersonalMicrosoftAccount: Somente os usuários com uma conta Microsoft pessoal.
    tags Coleção de cadeias de caracteres Cadeias de caracteres personalizadas que podem ser usadas para categorizar e identificar a entidade de serviço. Não anulável. O valor é a união de cadeias de caracteres definidas aqui e na propriedade tags da entidade de aplicativo associada.

    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 Microsoft Entra ID emite tokens para esse aplicativo criptografado usando a chave especificada por essa propriedade. 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 do aplicativo vinculado a essa entidade de serviço.

    Relações

    Importante

    O uso específico do parâmetro de $filter consulta só tem suporte 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.
    appRoleAssignedTo appRoleAssignment Atribuições de função de aplicativo ou serviço, concedidas a usuários, grupos e outras entidades de serviços. Suporta $expand.
    appRoleAssignments appRoleAssignment collection Atribuição de função de aplicativo para outro aplicativo ou serviço, concedida a essa entidade de serviço. Suporta $expand.
    claimsMappingPolicies Conjunto claimsMappingPolicy O claimsMappingPolicies atribuído a essa entidade de serviço. Suporta $expand.
    createdObjects directoryObject collection Objetos de diretório criados pela entidade de serviço. Somente leitura. Anulável.
    federatedIdentityCredentials Coleção federatedIdentityCredential Identidades federadas para um tipo específico de entidade de serviço: identidade gerenciada. Supports $expand and $filter (/$count eq 0, /$count ne 0).
    homeRealmDiscoveryPolicies Conjunto homeRealmDiscoveryPolicy O homeRealmDiscoveryPolicies atribuído a essa entidade de serviço. Suporta o $expand.
    memberOf directoryObject collection Funções das quais essa entidade de serviço é membro. Métodos HTTP: GET somente leitura. Anulável. Suporta o $expand.
    oauth2PermissionGrants oAuth2PermissionGrant collection Concessões de permissão delegadas que autorizam essa entidade de serviço a acessar uma API em nome de um usuário conectado. Somente leitura. Anulável.
    ownedObjects Coleção directoryObject Directory que essa entidade de serviço possui. Somente leitura. Anulável. Dá suporte $expanda , $select aninhado em $expande $filter (/$count eq 0, /$count ne 0, /$count eq 1, /$count ne 1).
    owners Coleção directoryObject Objetos de diretório que são proprietários dessa servicePrincipal. Os proprietários são um conjunto de usuários não administradores ou servicePrincipals que têm permissão para modificar esse objeto. Dá suporte $expanda , $filter (/$count eq 0, /$count ne 0, /$count ne 1/$count eq 1, ) e $select aninhado em $expand.
    remoteDesktopSecurityConfiguration remoteDesktopSecurityConfiguration O objeto remoteDesktopSecurityConfiguration aplicado a essa entidade de serviço. Suporta $filter (eq) para a propriedade isRemoteDesktopProtocolEnabled .
    automatizada com escopo sincronização Representa a funcionalidade de sincronização de identidade do Microsoft Entra por meio da API do Graph.
    tokenIssuancePolicies coleção tokenIssuancePolicy As tokenIssuancePolicies atribuídas a essa entidade de serviço.
    tokenLifetimePolicies Conjunto tokenLifetimePolicy O tokenLifetimePolicies atribuído a essa entidade de serviço.

    Representação JSON

    A representação JSON a seguir mostra o tipo de recurso.

    {
  "accountEnabled": true,
  "addIns": [{"@odata.type": "microsoft.graph.addIn"}],
  "alternativeNames": ["String"] ,
  "appDisplayName": "String",
  "appId": "String",
  "appOwnerOrganizationId": "Guid",
  "appRoleAssignmentRequired": true,
  "appRoles": [{"@odata.type": "microsoft.graph.appRole"}],
  "createdByAppId": "String",
  "customSecurityAttributes": {
    "@odata.type": "microsoft.graph.customSecurityAttributeValue"
  },
  "disabledByMicrosoftStatus": "String",
  "displayName": "String",
  "homepage": "String",
  "id": "String (identifier)",
  "info": {"@odata.type": "microsoft.graph.informationalUrl"},
  "keyCredentials": [{"@odata.type": "microsoft.graph.keyCredential"}],
  "logoutUrl": "String",
  "notes": "String",
  "oauth2PermissionScopes": [{"@odata.type": "microsoft.graph.permissionScope"}],
  "passwordCredentials": [{"@odata.type": "microsoft.graph.passwordCredential"}],
  "preferredTokenSigningKeyThumbprint": "String",
  "replyUrls": ["String"],
  "resourceSpecificApplicationPermissions": [{"@odata.type": "microsoft.graph.resourceSpecificPermission"}],
  "servicePrincipalNames": ["String"],
  "servicePrincipalType": "String",
  "tags": ["String"],
  "tokenEncryptionKeyId": "String",
  "verifiedPublisher": {"@odata.type": "microsoft.graph.verifiedPublisher"}
}
    • Last updated on