Tipo de recurso servicePrincipalservicePrincipal resource type

Namespace: microsoft.graphNamespace: microsoft.graph

Represents an instance of an application in a directory. Inherits from directoryObject.Represents an instance of an application in a directory. Inherits from 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.This resource supports using delta query to track incremental additions, deletions, and updates, by providing a delta function.

MétodosMethods

MétodoMethod Tipo de retornoReturn Type DescriçãoDescription
Listar servicePrincipalsList servicePrincipals servicePrincipal collectionservicePrincipal collection Recupere uma lista de objetos servicePrincipal.Retrieve a list of servicePrincipal objects.
Criar servicePrincipalCreate servicePrincipal servicePrincipalservicePrincipal Cria um novo objeto servicePrincipal.Creates a new servicePrincipal object.
Get servicePrincipalGet servicePrincipal servicePrincipalservicePrincipal Leia as propriedades e as relações do objeto servicePrincipal.Read properties and relationships of servicePrincipal object.
Atualizar servicePrincipalUpdate servicePrincipal servicePrincipalservicePrincipal Atualize o objeto servicePrincipal.Update servicePrincipal object.
Excluir servicePrincipalDelete servicePrincipal Nenhum(a)None Exclua o objeto servicePrincipal.Delete servicePrincipal object.
Listar createdObjectsList createdObjects directoryObject collectiondirectoryObject collection Obtenha uma coleção de objeto createdObject.Get a createdObject object collection.
Listar ownedObjectsList ownedObjects directoryObject collectiondirectoryObject collection Obtenha uma coleção de objeto ownedObject.Get a ownedObject object collection.
Obter deltaGet delta servicePrincipal collectionservicePrincipal collection Obtenha alterações incrementais para entidades de serviço.Get incremental changes for service principals.
Atribuição de funções do aplicativoApp role assignments
List appRoleAssignmentsList appRoleAssignments appRoleAssignment collectionappRoleAssignment collection Obtenha as funções de aplicativo às quais esta entidade de serviço foi atribuída.Get the app roles which this service principal has been assigned.
Adicionar uma atribuição de função do aplicativoAdd appRoleAssignment appRoleAssignmentappRoleAssignment Atribuir uma função de aplicativo a essa entidade de serviço.Assign an app role to this service principal.
Remover uma atribuição de função do aplicativoRemove appRoleAssignment Nenhum(a)None Remover uma atribuição de função de aplicativo dessa entidade de serviço.Remove an app role assignment from this service principal.
Listar appRoleAssignedToList appRoleAssignedTo coleção appRoleAssignmentappRoleAssignment collection Obtenha os usuários, grupos e funções de aplicativo atribuídos a essa entidade de serviço.Get the users, groups, and service principals assigned app roles for this service principal.
Adicionar appRoleAssignedToAdd appRoleAssignedTo appRoleAssignmentappRoleAssignment Atribuir uma função de aplicativo dessa entidade de serviço a um usuário, grupo ou entidade de serviço.Assign an app role for this service principal to a user, group, or service principal.
Remover appRoleAssignedToRemove appRoleAssignedTo Nenhum(a)None Remova uma atribuição de função de aplicativo dessa entidade de serviço de um usuário, grupo ou entidade de serviço.Remove an app role assignment for this service principal from a user, group, or service principal.
Certificados e segredosCertificates and secrets
Adicionar senhaAdd password passwordCredentialpasswordCredential Adicione uma senha forte a uma servicePrincipal.Add a strong password to a servicePrincipal.
Remover senhaRemove password passwordCredentialpasswordCredential Remova uma senha de uma servicePrincipal.Remove a password from a servicePrincipal.
Adicionar chaveAdd key keyCredentialkeyCredential Adicione uma credencial de chave a uma servicePrincipal.Add a key credential to a servicePrincipal.
Remover chaveRemove key Nenhum(a)None Remova uma credencial de chave de uma servicePrincipal.Remove a key credential from a servicePrincipal.
Concessões de permissão delegadasDelegated permission grants
List oauth2PermissionGrantsList oauth2PermissionGrants oAuth2PermissionGrant collectionoAuth2PermissionGrant 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.Get the delegated permission grants authorizing this service principal to access an API on behalf of a signed-in user.
AssociaçãoMembership
Listar memberOfList memberOf directoryObject collectiondirectoryObject collection Obtenha grupos dos quais essa entidade de serviço é membro direto da propriedade de navegação memberOf.Get the groups that this service principal is a direct member of from the memberOf navigation property.
List transitive memberOfList transitive memberOf directoryObject collectiondirectoryObject collection Liste os grupos dos quais essa entidade de serviço é membro.List the groups that this service principal is a member of. Essa operação é transitiva e inclui os grupos dos quais essa entidade de serviço é um membro aninhado.This operation is transitive and includes the groups that this service principal is a nested member of.
checkMemberGroupscheckMemberGroups Coleção de cadeias de caracteresString collection Verifique se há associação em uma lista de grupos específica.Check for membership in a specified list of groups.
checkMemberObjectscheckMemberObjects Coleção de cadeias de caracteresString collection Verifique se há associação em uma lista de grupo específica, função de diretório ou objetos de unidade administrativa.Check for membership in a specified list of group, directory role, or administrative unit objects.
getMemberGroupsgetMemberGroups Coleção de cadeias de caracteresString collection Obtenha a lista de grupos dos quais essa entidade de serviço é membro.Get the list of groups that this service principal is a member of.
getMemberObjectsgetMemberObjects Coleção de cadeias de caracteresString collection Obtenha a lista de grupos e funções de diretório dos quais essa entidade de serviço é membro.Get the list of groups and directory roles that this service principal is a member of.
OwnersOwners
Listar proprietáriosList owners directoryObject collectiondirectoryObject collection Obtenha uma coleção de objeto owner.Get a owner object collection.
Adicionar proprietárioAdd owner directoryObjectdirectoryObject Crie um novo proprietário postando na coleção owners.Create a new owner by posting to the owners collection.
Remover proprietárioRemove owner Nenhum(a)None Remova um proprietário de uma servicePrincipal.Remove an owner from a serviceprincipal.
PolíticasPolicies
Atribuir claimsMappingPolicyAssign claimsMappingPolicy Conjunto claimsMappingPolicyclaimsMappingPolicy collection Atribua um claimsMappingPolicy a este objeto.Assign a claimsMappingPolicy to this object.
Listar claimsMappingPoliciesList claimsMappingPolicies Conjunto claimsMappingPolicyclaimsMappingPolicy collection Obter todos os claimsMappingPolicies atribuídos a este objeto.Get all claimsMappingPolicies assigned to this object.
Remover claimsMappingPolicyRemove claimsMappingPolicy Conjunto claimsMappingPolicyclaimsMappingPolicy collection Remova uma claimsMappingPolicy deste objeto.Remove a claimsMappingPolicy from this object.
Atribuir homeRealmDiscoveryPolicyAssign homeRealmDiscoveryPolicy Conjunto homeRealmDiscoveryPolicyhomeRealmDiscoveryPolicy collection Atribuir um homeRealmDiscoveryPolicy a este objeto.Assign a homeRealmDiscoveryPolicy to this object.
Listar homeRealmDiscoveryPoliciesList homeRealmDiscoveryPolicies Conjunto homeRealmDiscoveryPolicyhomeRealmDiscoveryPolicy collection Obter todos os homeRealmDiscoveryPolicies atribuídos a este objeto.Get all homeRealmDiscoveryPolicies assigned to this object.
Remover homeRealmDiscoveryPolicyRemove homeRealmDiscoveryPolicy Conjunto homeRealmDiscoveryPolicyhomeRealmDiscoveryPolicy collection Remover um homeRealmDiscoveryPolicy deste objeto.Remove a homeRealmDiscoveryPolicy from this object.
Atribuir tokenIssuancePolicyAssign tokenIssuancePolicy coleção tokenIssuancePolicytokenIssuancePolicy collection Atribuir um tokenIssuancePolicy a este objeto.Assign a tokenIssuancePolicy to this object.
Listar TokenIssuancePoliciesList tokenIssuancePolicies coleção tokenIssuancePolicytokenIssuancePolicy collection Obter todos os tokenIssuancePolicies atribuídos a este objeto.Get all tokenIssuancePolicies assigned to this object.
Remover tokenIssuancePolicyRemove tokenIssuancePolicy coleção tokenIssuancePolicytokenIssuancePolicy collection Remover um tokenIssuancePolicy deste objeto.Remove a tokenIssuancePolicy from this object.
Atribiur tokenLifetimePolicyAssign tokenLifetimePolicy Coleção tokenLifetimePolicytokenLifetimePolicy collection Atribuir um tokenLifetimePolicy a este objeto.Assign a tokenLifetimePolicy to this object.
Listar tokenLifetimePoliciesList tokenLifetimePolicies Coleção tokenLifetimePolicytokenLifetimePolicy collection Obter todos os tokenLifetimePolicies atribuídos a este objeto.Get all tokenLifetimePolicies assigned to this object.
Remover tokenLifetimePolicyRemove tokenLifetimePolicy Coleção tokenLifetimePolicytokenLifetimePolicy collection Remover um tokenLifetimePolicy deste objeto.Remove a tokenLifetimePolicy from this object.

PropriedadesProperties

PropriedadeProperty TipoType DescriçãoDescription
accountEnabledaccountEnabled BooleanBoolean True se a entidade de serviço estiver habilitada; caso contrário, false.true if the service principal account is enabled; otherwise, false.
addInsaddIns Coleção addInaddIn collection Define o comportamento personalizado que um serviço de consumo pode usar para chamar um aplicativo em contextos específicos.Defines custom behavior that a consuming service can use to call an app in specific contexts. Por exemplo, aplicativos que podem renderizar fluxos de arquivo podem definir a propriedade addIns para a funcionalidade "FileHandler".For example, applications that can render file streams may set the addIns property for its "FileHandler" functionality. 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.This will let services like Microsoft 365 call the application in the context of a document the user is working on.
alternativeNamesalternativeNames Coleção de cadeias de caracteresString collection Usado para recuperar entidades de serviço por assinatura, identificar grupo de recursos e IDs de recursos completos de identidades gerenciadas.Used to retrieve service principals by subscription, identify resource group and full resource ids for managed identities.
appDisplayNameappDisplayName StringString O nome de exibição exposto pelo aplicativo associado.The display name exposed by the associated application.
appIdappId StringString O identificador exclusivo do aplicativo associado (sua propriedade appId).The unique identifier for the associated application (its appId property).
applicationTemplateIdapplicationTemplateId Cadeia de caracteresString Identificador exclusivo do applicationTemplate do qual a servicePrincipal foi criada.Unique identifier of the applicationTemplate that the servicePrincipal was created from. Somente leitura.Read-only.
appOwnerOrganizationIdappOwnerOrganizationId Cadeia de caracteresString Contém a ID de locatário onde o aplicativo está registrado.Contains the tenant id where the application is registered. Isso é aplicável apenas a entidades de serviço respaldadas por aplicativos.This is applicable only to service principals backed by applications.
appRoleAssignmentRequiredappRoleAssignmentRequired BoolianoBoolean 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.Specifies whether users or other service principals need to be granted an app role assignment for this service principal before users can sign in or apps can get tokens. O valor padrão é falso.The default value is false. Não anulável.Not nullable.
appRolesappRoles Coleção appRoleappRole collection As funções expostas pelo aplicativo que essa entidade de serviço representa.The roles exposed by the application which this service principal represents. Para obter mais informações, confira definição da propriedade appRoles na entidade aplicativo.For more information see the appRoles property definition on the application entity. Não anulável.Not nullable.
deletedDateTimedeletedDateTime DateTimeOffsetDateTimeOffset A data e a hora em que a entidade de serviço foi excluída.The date and time the service principal was deleted. Somente leitura.Read-only.
displayNamedisplayName StringString O nome de exibição da entidade de serviço.The display name for the service principal.
homepagehomepage Cadeia de caracteresString Página inicial ou página de aterrissagem do aplicativo.Home page or landing page of the application.
idid StringString O identificador exclusivo da entidade de serviço.The unique identifier for the service principal. Herdado de directoryObject.Inherited from directoryObject. Chave.Key. Não anulável.Not nullable. Somente leitura.Read-only.
informações info informationalUrlinformationalUrl 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.Basic profile information of the acquired application such as app's marketing, support, terms of service and privacy statement URLs. 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.The terms of service and privacy statement are surfaced to users through the user consent experience. Para obter mais informações, confira Como adicionar termos de serviço e política de privacidade a aplicativos do Azure AD registrados.For more info, see How to: Add Terms of service and privacy statement for registered Azure AD apps.
keyCredentialskeyCredentials keyCredential collectionkeyCredential collection A coleção de credenciais principais associada à entidade de serviço.The collection of key credentials associated with the service principal. Não anulável.Not nullable.
loginUrlloginUrl Cadeia de caracteresString Especifica a URL na qual o provedor de serviços redireciona o usuário para a autenticação do Azure AD.Specifies the URL where the service provider redirects the user to Azure AD to authenticate. O Azure AD usa a URL para iniciar o aplicativo do Microsoft 365 ou o Azure AD My Apps.Azure AD uses the URL to launch the application from Microsoft 365 or the 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.When blank, Azure AD performs IdP-initiated sign-on for applications configured with SAML-based single sign-on. O usuário inicia o aplicativo do Microsoft 365, o Azure AD My Apps ou a URL de SSO do Azure AD.The user launches the application from Microsoft 365, the Azure AD My Apps, or the Azure AD SSO URL.
logoutUrllogoutUrl Cadeia de caracteresString 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.Specifies the URL that will be used by Microsoft's authorization service to logout an user using OpenId Connect front-channel, back-channel or SAML logout protocols.
oauth2PermissionScopesoauth2PermissionScopes coleção permissionScopepermissionScope collection As permissões delegadas expostas pelo aplicativo.The delegated permissions exposed by the application. Para obter mais informações, confira a propriedade oauth2PermissionScopes na propriedade api da entidade aplicativo.For more information see the oauth2PermissionScopes property on the application entity's api property. Não anulável.Not nullable.
NotificationEmailAddressesnotificationEmailAddresses Coleção de cadeias de caracteresString collection 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.Specifies the list of email addresses where Azure AD sends a notification when the active certificate is near the expiration date. Isso é apenas para os certificados usados ​​para assinar o token SAML emitido para aplicativos da Galeria do Azure AD.This is only for the certificates used to sign the SAML token issued for Azure AD Gallery applications.
passwordCredentialspasswordCredentials passwordCredential collectionpasswordCredential collection A coleção de credenciais de senha associada à entidade de serviço.The collection of password credentials associated with the service principal. Não anulável.Not nullable.
preferredSingleSignOnModepreferredSingleSignOnMode cadeia de caracteresstring Especifica o modo de logon único configurado para este aplicativo.Specifies the single sign-on mode configured for this application. O Azure AD usa o modo de logon único preferido para iniciar o aplicativo do Microsoft 365 ou o Azure AD My Apps.Azure AD uses the preferred single sign-on mode to launch the application from Microsoft 365 or the Azure AD My Apps. Os valores com suporte são password, saml, external e oidc.The supported values are password, saml, external, and oidc.
replyUrlsreplyUrls String collectionString 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.The URLs that user tokens are sent to for sign in with the associated application, or the redirect URIs that OAuth 2.0 authorization codes and access tokens are sent to for the associated application. Não anulável.Not nullable.
samlSingleSignOnSettingssamlSingleSignOnSettings samlSingleSignOnSettingssamlSingleSignOnSettings A coleção das configurações relacionadas ao logon único do SAML.The collection for settings related to saml single sign-on.
servicePrincipalNamesservicePrincipalNames Coleção de cadeias de caracteresString collection Contém a lista de identificadoresUris, copiados do aplicativo associado.Contains the list of identifiersUris, copied over from the associated application. É possível adicionar valores adicionais aos aplicativos híbridos.Additional values can be added to hybrid applications. Esses valores podem ser usados ​​para identificar as permissões apresentadas por esse aplicativo no Azure AD.These values can be used to identify the permissions exposed by this app within Azure AD. Por exemplo,For example,
  • Os aplicativos cliente podem especificar um URI de recurso com base nos valores dessa propriedade para adquirir um token de acesso, que é o URI retornado na declaração "aud".Client apps can specify a resource URI which is based on the values of this property to acquire an access token, which is the URI returned in the “aud” claim.

O operador any é obrigatório para expressões de filtro em propriedades de vários valores.The any operator is required for filter expressions on multi-valued properties. Não anulável.Not nullable.
servicePrincipalTypeservicePrincipalType Cadeia de caracteresString Identifica se a entidade de serviço representa um aplicativo ou uma identidade gerenciada.Identifies if the service principal represents an application or a managed identity. Isso é definido pelo Azure AD internamente.This is set by Azure AD internally. Para uma entidade de serviço que representa um aplicativo, isso é definido como Aplicativo.For a service principal that represents an application this is set as Application. Para obter uma entidade de serviço que represente uma identidade gerenciada, essa configuração é definida como ManagedIdentity.For a service principal that represent a managed identity this is set as ManagedIdentity.
tagstags Coleção de cadeias de caracteresString collection Cadeias de caracteres personalizadas que podem ser usadas para categorizar e identificar a entidade de serviço.Custom strings that can be used to categorize and identify the service principal. Não anulável.Not nullable.
tokenEncryptionKeyIdtokenEncryptionKeyId Cadeia de caracteresString Especifica a keyId de uma chave pública da coleção keyCredentials.Specifies the keyId of a public key from the keyCredentials collection. Quando configurado, o Azure AD emite tokens para este aplicativo criptografado usando a chave especificada por essa propriedade.When configured, Azure AD issues tokens for this application encrypted using the key specified by this property. 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.The application code that receives the encrypted token must use the matching private key to decrypt the token before it can be used for the signed-in user.
verifiedPublisherverifiedPublisher verifiedPublisherverifiedPublisher Especifica o distribuidor verificado do aplicativo que essa entidade de serviço representa.Specifies the verified publisher of the application which this service principal represents.

RelaçõesRelationships

RelaçãoRelationship TipoType DescriçãoDescription
appRoleAssignedToappRoleAssignedTo appRoleAssignmentappRoleAssignment Entidades (usuários, grupos e entidades de serviço) que são atribuídas a essa entidade de serviço.Principals (users, groups, and service principals) that are assigned to this service principal. Somente leitura.Read-only.
appRoleAssignmentsappRoleAssignments appRoleAssignment collectionappRoleAssignment collection Aplicativos aos quais essa entidade de serviço é atribuída.Applications that this service principal is assigned to. Somente leitura.Read-only. Anulável.Nullable.
claimsMappingPoliciesclaimsMappingPolicies Conjunto claimsMappingPolicyclaimsMappingPolicy collection O claimsMappingPolicies atribuído a essa entidade de serviço.The claimsMappingPolicies assigned to this service principal.
createdObjectscreatedObjects directoryObject collectiondirectoryObject collection Objetos de diretório criados pela entidade de serviço.Directory objects created by this service principal. Somente leitura.Read-only. Anulável.Nullable.
pontos de extremidadeendpoints coleção ponto de extremidade endpoint collection Pontos de extremidade disponíveis para descoberta.Endpoints available for discovery. Serviços como o Sharepoint preenchem essa propriedade com pontos de extremidade do SharePoint específicos de locatários que outros aplicativos podem descobrir e usar em suas experiências.Services like Sharepoint populate this property with a tenant specific SharePoint endpoints that other applications can discover and use in their experiences.
homeRealmDiscoveryPolicieshomeRealmDiscoveryPolicies Conjunto homeRealmDiscoveryPolicyhomeRealmDiscoveryPolicy collection O homeRealmDiscoveryPolicies atribuído a essa entidade de serviço.The homeRealmDiscoveryPolicies assigned to this service principal.
memberOfmemberOf directoryObject collectiondirectoryObject collection Funções das quais essa entidade de serviço é membro.Roles that this service principal is a member of. Métodos HTTP: GET somente leitura.HTTP Methods: GET Read-only. Anulável.Nullable.
oauth2PermissionGrantsoauth2PermissionGrants oAuth2PermissionGrant collectionoAuth2PermissionGrant 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.Delegated permission grants authorizing this service principal to access an API on behalf of a signed-in user. Somente leitura.Read-only. Anulável.Nullable.
ownedObjectsownedObjects directoryObject collectiondirectoryObject collection Objetos de diretório que pertencem a essa entidade de serviço.Directory objects that are owned by this service principal. Somente leitura.Read-only. Anulável.Nullable.
ownersowners Coleção directoryObjectdirectoryObject collection Objetos de diretório que são proprietários dessa servicePrincipal.Directory objects that are owners of this 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.The owners are a set of non-admin users or servicePrincipals who are allowed to modify this object. Somente leitura.Read-only. Anulável.Nullable.
tokenIssuancePoliciestokenIssuancePolicies coleção tokenIssuancePolicytokenIssuancePolicy collection As tokenIssuancePolicies atribuídas a essa entidade de serviço.The tokenIssuancePolicies assigned to this service principal.
tokenLifetimePoliciestokenLifetimePolicies Conjunto tokenLifetimePolicytokenLifetimePolicy collection O tokenLifetimePolicies atribuído a essa entidade de serviço.The tokenLifetimePolicies assigned to this service principal.

Representação JSONJSON representation

Veja a seguir uma representação JSON do recursoHere is a JSON representation of the resource

{
  "accountEnabled": true,
  "addIns": [{"@odata.type": "microsoft.graph.addIn"}],
  "alternativeNames": ["string"] ,
  "appDisplayName": "string",
  "appId": "string",
  "appOwnerOrganizationId": "guid",
  "appRoleAssignmentRequired": true,
  "appRoles": [{"@odata.type": "microsoft.graph.appRole"}],
  "displayName": "string",
  "homepage": "string",
  "id": "string (identifier)",
  "info": {"@odata.type": "microsoft.graph.informationalUrl"},
  "keyCredentials": [{"@odata.type": "microsoft.graph.keyCredential"}],
  "logoutUrl": "string",
  "oauth2PermissionScopes": [{"@odata.type": "microsoft.graph.permissionScope"}],
  "passwordCredentials": [{"@odata.type": "microsoft.graph.passwordCredential"}],
  "replyUrls": ["string"],
  "servicePrincipalNames": ["string"],
  "servicePrincipalType": "string",
  "tags": ["string"],
  "tokenEncryptionKeyId": "String",
  "verifiedPublisher": {"@odata.type": "microsoft.graph.verifiedPublisher"}
}