Tipo de recurso servicePrincipal
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 de versão.
Representa uma instância de um aplicativo em um diretório. Herda de directoryObject.
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 que outras propriedades sejam passadas.
Methods
| Método | Tipo de retorno | Descrição |
|---|---|---|
| Listar servicePrincipals | servicePrincipal collection | Recupere uma lista de objetos servicePrincipal. |
| Criar servicePrincipal | servicePrincipal | Cria um novo objeto servicePrincipal. |
| Get servicePrincipal | servicePrincipal | Leia as propriedades e as relações do objeto servicePrincipal. |
| Atualizar servicePrincipal | servicePrincipal | Atualize o objeto servicePrincipal. |
| Excluir servicePrincipal | Nenhum(a) | Exclua o objeto servicePrincipal. |
| Listar servicePrincipals excluídos | Coleção directoryObject | Recupere uma lista de objetos servicePrincipal excluídos recentemente. |
| Obter servicePrincipal excluído | directoryObject | Recupere as propriedades de um objeto servicePrincipal excluído recentemente. |
| Excluir permanentemente servicePrincipal | Nenhum | Exclua permanentemente um objeto servicePrincipal. |
| Restaurar servicePrincipal excluído | directoryObject | Restaure um objeto servicePrincipal excluído recentemente. |
| Listar createdObjects | directoryObject collection | Obtenha uma coleção de objeto createdObject. |
| Listar ownedObjects | Coleção directoryObject | Obtenha uma coleção de objeto ownedObject. |
| delta | servicePrincipal collection | Obtenha alterações incrementais para entidades de serviço. |
| Atribuição de funções do aplicativo | ||
| List appRoleAssignments | appRoleAssignment collection | Obtenha as funções de aplicativo às quais esta entidade de serviço foi atribuída. |
| 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. |
| Adicionar tokenSigningCertificate | selfSignedCertificate | Adicione um certificado autoassinado ao principal de serviço. Usado principalmente para configurar aplicativos SSO baseados em SAML na galeria do Azure Active Directory. |
| 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. |
| Classificações de permissão delegada | ||
| Lista de classificações de permissão delegada | Coleção delegatedPermissionClassification | Obtenha as classificações de permissão para permissões delegadas expostas por essa entidade de serviço. |
| Adicionar classificações de permissão delegada | delegatedPermissionClassification | Adicione uma classificação de permissão para uma permissão delegada exposta por essa entidade de serviço. |
| Remover classificação de permissão delegada | 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 delegadas | ||
| List oauth2PermissionGrants | 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. |
| List transitive memberOf | 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. |
| checkMemberGroups | Coleção de cadeias de caracteres | Verifique se há associação em uma lista de grupos específica. |
| checkMemberObjects | Coleção de cadeias de caracteres | Verificar se há afiliação em uma lista de grupo específica, funções de diretório ou objetos de unidade administrativa. |
| getMemberGroups | Coleção de cadeias de caracteres | Obtenha a lista de grupos dos quais essa entidade de serviço é membro. |
| getMemberObjects | String collection | Obtenha a lista de grupos e funções de diretório dos quais essa entidade de serviço é membro. |
| Owners | ||
| Listar proprietários | Coleção directoryObject | Obtenha uma coleção de objetos owner. |
| Adicionar proprietário | directoryObject | Crie um novo proprietário postando na coleção owners. |
| Remover proprietário | Nenhum(a) | Remova um proprietário de uma servicePrincipal. |
| Políticas | ||
| Atribuir claimsMappingPolicy | Conjunto claimsMappingPolicy | Atribua um claimsMappingPolicy a este objeto. |
| Listar claimsMappingPolicies | Conjunto claimsMappingPolicy | Obter todos os claimsMappingPolicies atribuídos a este objeto. |
| Remover claimsMappingPolicy | Conjunto claimsMappingPolicy | Remova uma claimsMappingPolicy deste objeto. |
| Atribuir homeRealmDiscoveryPolicy | Conjunto homeRealmDiscoveryPolicy | Atribuir um homeRealmDiscoveryPolicy a este objeto. |
| Listar homeRealmDiscoveryPolicies | Conjunto homeRealmDiscoveryPolicy | Obter todos os homeRealmDiscoveryPolicies atribuídos a este objeto. |
| Remover homeRealmDiscoveryPolicy | Conjunto homeRealmDiscoveryPolicy | Remover um homeRealmDiscoveryPolicy deste objeto. |
| 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. |
| Acesso único | ||
| createPasswordSingleSignOnCredentials | passwordSingleSignOnCredentialSet | Crie uma credencial definida para o usuário ou grupo especificado no corpo. |
| getPasswordSingleSignOnCredentials | passwordSingleSignOnCredentialSet | Obtenha um conjunto de credenciais para o usuário ou grupo especificado no corpo. |
| updatePasswordSingleSignOnCredentials | Nenhum | Atualize um conjunto de credenciais para o usuário ou grupo especificado no corpo. |
| deletePasswordSingleSignOnCredentials | Nenhum | Exclua uma credencial definida para o usuário ou grupo especificado no corpo. |
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 |
|---|---|---|
| accountEnabled | Booliano | true se a conta da entidade de serviço estiver habilitada; caso contrário, false. oferece suporte $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 permitirá que os serviços como o Microsoft 365 chamem o aplicativo no contexto de um documento no qual o usuário esteja trabalhando. |
| alternativeNames | Coleção de cadeias de caracteres | Usado para recuperar entidades de serviço por assinatura, identificar grupo de recursos e IDs de recursos completos de identidades gerenciadas. oferece suporte $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. |
| appId | Cadeia de caracteres | O identificador exclusivo do aplicativo associado (seu appId propriedade). Oferece suporte $filter (eq, ne, not, in, startsWith). |
| applicationTemplateId | String | Identificador exclusivo do applicationTemplate do qual o servicePrincipal foi criado. Somente leitura. Oferece suporte $filter (eq, ne, NOT, startsWith). |
| appOwnerOrganizationId | Guid | Contém a ID de locatário onde o aplicativo está registrado. Isso se aplica apenas a entidades de serviço apoiadas 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 que 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 que essa entidade de serviço representa. Para obter mais informações, confira definição da propriedade appRoles na entidade aplicativo. Não anulável. |
| 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. Retornado apenas em $select. Suporta $filter (eq, ne, not, startsWith). |
| deletedDateTime | DateTimeOffset | A data e a hora em que a entidade de serviço foi excluída. Somente leitura. |
| descrição | String | Campo de texto disponível para fornecer uma descrição voltada para o usuário final interno da entidade de serviço. Os portais do usuário final, como MyApps, exibirão 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), NotDisabled e (os motivos podem incluir atividades suspeitas, abusivas ou mal-intencionadas ou uma violação do DisabledDueToViolationOfServicesAgreement 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 no null valores), $search, e $orderBy. |
| errorUrl | Cadeia de caracteres | Depreciado. Não usar. |
| homepage | String | Página inicial ou página de aterrissagem do aplicativo. |
| id | String | O identificador exclusivo da entidade de serviço. Herdado de directoryObject. Chave. Não anulável. Somente leitura. Oferece suporte $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, confira Como adicionar termos de serviço e política de privacidade a aplicativos do Azure AD registrados. Suporta $filter (eq, ne, not, ge, lee eq em null valores). |
| keyCredentials | keyCredential collection | A coleção de credenciais de chave associadas ao aplicativo. Não anulável. Oferece suporte $filter(eq, not, ge, le). |
| loginUrl | String | Especifica a URL na qual o provedor de serviços redireciona o usuário para a autenticação do Azure AD. O Azure AD usa a URL para iniciar o aplicativo do Microsoft 365 ou o Azure AD My Apps. Quando em branco, o Azure AD executa o logon iniciado pelo IdP de aplicativos configurados com o logon único baseado em SAML. O usuário inicia o aplicativo do Microsoft 365, o Azure AD My Apps ou a URL de SSO do Azure AD. |
| logoutUrl | Cadeia de caracteres | Especifica a URL que será usada pela autorização do serviço da Microsoft para fazer logoff de um usuário usando protocolos de logoff OpenId Connect front-channel, back-channel ou SAML. |
| notes | String | Campo de texto disponível para capturar informações sobre a entidade de 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 Azure AD envia uma notificação quando o certificado ativo está próximo da data de validade. Isso é apenas para os certificados usados para assinar o token SAML emitido para aplicativos da Galeria do Azure AD. |
| passwordCredentials | passwordCredential collection | A coleta de credenciais de senha associadas a entidade do serviço. Não anulável. |
| passwordSingleSignOnSettings | passwordSingleSignOnSettings | A coleção para configurações relacionadas a senha de acesso único. Utilize $select=passwordSingleSignOnSettings para fazer a çeitura da propriedade.. Somente leitura para applicationTemplates com exceção para ApplicationTemplates personalizados. |
| preferredSingleSignOnMode | cadeia de caracteres | Especifica o modo de logon único configurado para este aplicativo. O Azure AD usa o modo de logon único preferido para iniciar o aplicativo do Microsoft 365 ou o Azure AD My Apps. Os valores com suporte são: password, saml, notSupported, e oidc. |
| preferredTokenSigningKeyEndDateTime | DateTimeOffset | Especifica a data da expiração do keyCredential usado para a assinatura do token, marcado por preferredTokenSigningKeyThumbprint. |
| preferredTokenSigningKeyThumbprint | String | Reservado apenas para uso interno. Não escreva ou dependa de alguma forma dessa propriedade. Pode ser removida em versões futuras. |
| publishedPermissionScopes | coleção permissionScope | As permissões delegadas expostas pelo aplicativo. Para obter mais informações, confira a propriedade oauth2PermissionScopes na propriedade api da entidade aplicativo. Não anulável. Observação: Essa propriedade é chamada oauth2PermissionScopes em v1.0. |
| replyUrls | String collection | URLs para as quais os tokens de usuário são enviados para se conectar com a aplicação associada, ou as URIs redirecionadas para as quais os códigos de autorização OAuth 2.0 e os tokens de acesso são enviados para a aplicação associada. Não pode ser anulado. |
| samlMetadataUrl | Cadeia de caracteres | O url em que o serviço expõe os metadados SAML para federação. |
| 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 apresentadas por esse aplicativo no Azure AD. Por exemplo,
O operador é necessário para filtrar expressões nas propriedades multivalorizadas. Não pode ser anulado. Suporta $filter (eq, not, ge, le, startsWith). |
| servicePrincipalType | Cadeia de caracteres | Identifica se a entidade de serviço representa um aplicativo ou uma identidade gerenciada. Isso é definido pelo Azure AD internamente. Para uma entidade de serviço que representa um aplicativo, isso é definido como Aplicativo. Para obter uma entidade de serviço que represente uma identidade gerenciada, essa configuração é definida como ManagedIdentity. O tipo SocialIdp é para uso interno. |
| signInAudience | String | Especifique as contas da Microsoft que têm suporte para o aplicativo atual. Somente leitura. Os valores com suporte são:
|
| 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. 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 emite tokens para este 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 distribuidor verificado do aplicativo que essa entidade de serviço representa. |
Relações
| Relação | Tipo | Descrição |
|---|---|---|
| appManagementPolicies | appManagementPolicy collection | O appManagementPolicy aplicado a este principal de serviço. |
| appRoleAssignedTo | appRoleAssignment | Atribuições de função de aplicativo para este aplicativo ou serviço, concedidas a usuários, grupos e outras entidades de serviço. Suporta $expand. |
| appRoleAssignments | appRoleAssignment collection | Atribuição da função do aplicativo para outro aplicativo ou serviço, concedida a essa entidade de serviço. Oferece suporte $expand. |
| claimsMappingPolicies | Conjunto claimsMappingPolicy | O claimsMappingPolicies atribuído a essa entidade de serviço. Oferece suporte $expand. |
| createdObjects | Coleção directoryObject | Objetos de diretório criados por esta entidade de serviços. Somente leitura. Anulável. |
| delegatedPermissionClassifications | Conjunto de delegatedPermissionClassification | As classificações de permissão das permissões delegadas expostas pelo aplicativo que essa entidade de serviço representa. Oferece suporte $expand. |
| pontos de extremidade | coleção ponto de extremidade | Pontos de extremidade disponíveis para descoberta. Serviços como o Sharepoint preenchem essa propriedade com pontos de extremidade do SharePoint específicos de locatário que outros aplicativos podem descobrir e usar em suas experiências. |
| homeRealmDiscoveryPolicies | Conjunto homeRealmDiscoveryPolicy | O homeRealmDiscoveryPolicies atribuído a essa entidade de serviço. Oferece suporte $expand. |
| memberOf | directoryObject collection | Funções das quais essa entidade de serviço é membro. Métodos HTTP: OBTER Somente leitura. Anulável. Oferece suporte $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 | directoryObject collection | Objetos de diretório que pertencem a essa entidade de serviço. Somente leitura. Anulável. Oferece suporte $expand. |
| 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 servicePrincipal que têm permissão para modificar esse objeto. Somente leitura. Anulável. Suporta o $expand. |
| tokenIssuancePolicies | coleção tokenIssuancePolicy | As tokenIssuancePolicies atribuídas a essa entidade de serviço. Oferece suporte $expand. |
| tokenLifetimePolicies | Conjunto tokenLifetimePolicy | O tokenLifetimePolicies atribuído a essa entidade de serviço. Oferece suporte $expand. |
Representação JSON
{
"accountEnabled": true,
"addIns": [{"@odata.type": "microsoft.graph.addIn"}],
"alternativeNames": "String",
"appDisplayName": "String",
"appId": "String",
"appOwnerOrganizationId": "Guid",
"applicationTemplateId": "String",
"appRoleAssignmentRequired": true,
"appRoles": [{"@odata.type": "microsoft.graph.appRole"}],
"customSecurityAttributes": {
"@odata.type": "microsoft.graph.customSecurityAttributeValue"
},
"disabledByMicrosoftStatus": "String",
"displayName": "String",
"errorUrl": "String",
"homepage": "String",
"id": "String (identifier)",
"info": {"@odata.type": "microsoft.graph.informationalUrl"},
"keyCredentials": [{"@odata.type": "microsoft.graph.keyCredential"}],
"loginUrl": "String",
"logoutUrl": "String",
"notes": "String",
"notificationEmailAddresses": ["String"],
"publishedPermissionScopes": [{"@odata.type": "microsoft.graph.permissionScope"}],
"passwordCredentials": [{"@odata.type": "microsoft.graph.passwordCredential"}],
"passwordSingleSignOnSettings": {"@odata.type": "microsoft.graph.passwordSingleSignOnSettings"},
"preferredSingleSignOnMode": "String",
"preferredTokenSigningKeyEndDateTime": "DateTime",
"preferredTokenSigningKeyThumbprint": "String",
"replyUrls": ["String"],
"samlMetadataUrl": "String",
"samlSingleSignOnSettings": "microsoft.DirectoryServices.SamlSingleSignOnSettings",
"servicePrincipalNames": ["String"],
"servicePrincipalType": "String",
"signInAudience": "String",
"tags": ["String"],
"tokenEncryptionKeyId": "String",
"useCustomTokenSigningKey": false,
"verifiedPublisher": {"@odata.type": "microsoft.graph.verifiedPublisher"}
}
Comentários
Enviar e exibir comentários de