Tipo de recurso servicePrincipalservicePrincipal resource type

Importante

As /beta APIs na versão do Microsoft Graph estão sujeitas a alterações.APIs under the /beta version in Microsoft Graph are subject to change. Não há suporte para o uso dessas APIs em aplicativos de produção.Use of these APIs in production applications is not supported.

Representa uma instância de um aplicativo em um diretório.Represents an instance of an application in a directory. Herda do directoryObject.Inherits from directoryObject.

Esse recurso permite:This resource supports:

  • Usar a consulta delta para controlar adições, exclusões e atualizações incrementais oferecendo uma função delta.Using delta query to track incremental additions, deletions, and updates, by providing a delta function.

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"}],
  "appDisplayName": "string",
  "appId": "string",
  "appOwnerOrganizationId": "guid",
  "appRoleAssignmentRequired": true,
  "displayName": "string",
  "errorUrl": "string",
  "homepage": "string",
  "id": "string (identifier)",
  "keyCredentials": [{"@odata.type": "microsoft.graph.keyCredential"}],
  "logoutUrl": "string",
  "oauth2Permissions": [{"@odata.type": "microsoft.graph.oAuth2Permission"}],
  "passwordCredentials": [{"@odata.type": "microsoft.graph.passwordCredential"}],
  "preferredTokenSigningKeyThumbprint": "string",
  "publisherName": "string",
  "replyUrls": ["string"],
  "samlMetadataUrl": "string",
  "servicePrincipalNames": ["string"],
  "tags": ["string"],
  "appRoles": [{"@odata.type": "microsoft.graph.appRole"}]
}

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.
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).
appRoleAssignmentRequiredappRoleAssignmentRequired BooleanBoolean Especifica se um appRoleAssignment de um usuário ou grupo é necessário antes que o Azure AD emita um token de usuário ou de acesso ao aplicativo.Specifies whether an appRoleAssignment to a user or group is required before Azure AD will issue a user or access token to the application. Não anulável.Not nullable.
appRolesappRoles appRole collectionappRole collection As funções do aplicativo expostas pelo aplicativo associado.The application roles exposed by the associated application. 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.
displayNamedisplayName StringString O nome de exibição da entidade de serviço.The display name for the service principal.
errorUrlerrorUrl StringString
homepagehomepage StringString A URL da home page do aplicativo associado.The URL to the homepage of the associated application.
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.
logoutUrllogoutUrl StringString 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 front-channel, back-channel ou SAML.Specifies the URL that will be used by Microsoft's authorization service to logout an user using front-channel, back-channel or SAML logout protocols.
oauth2Permissionsoauth2Permissions oAuth2Permission collectionoAuth2Permission collection As permissões OAuth 2.0 expostas pelo aplicativo associado.The OAuth 2.0 permissions exposed by the associated application. Para obter mais informações, confira a definição da propriedade oauth2Permissions na entidade aplicativo.For more information see the oauth2Permissions property definition on the application entity. Não anulável.Not nullable.
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.
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.
preferredTokenSigningKeyThumbprintpreferredTokenSigningKeyThumbprint StringString Reservado apenas para uso interno.Reserved for internal use only. Não escreva ou dependa de alguma forma dessa propriedade.Do not write or otherwise rely on this property. Pode ser removida em versões futuras.May be removed in future versions.
publisherNamepublisherName StringString O nome de exibição do locatário no qual o aplicativo associado está especificado.The display name of the tenant in which the associated application is specified.
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.
samlMetadataUrlsamlMetadataUrl StringString
servicePrincipalNamesservicePrincipalNames String collectionString collection Os URIs que identificam o aplicativo associado.The URIs that identify the associated application. Para obter mais informações, confira Objetos do aplicativo e da entidade de serviço. O operador any é necessário para expressões de filtro em propriedades de vários valores.For more information see, Application Objects and Service Principal Objects.The any operator is required for filter expressions on multi-valued properties. Não anulável.Not nullable.
tagstags String collectionString collection Não anulável.Not nullable.

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 a entidade de serviço é atribuída.Applications that the service principal is assigned to. Somente leitura.Read-only. Anulável.Nullable.
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.
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 da representação de usuário associadas a essa entidade de serviço.User impersonation grants associated with this service principal. 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 directoryObject collectiondirectoryObject collection Objetos de diretório que são proprietários dessa entidade de serviço.Directory objects that are owners of this service principal. Os proprietários são um conjunto de usuários não administradores com permissão para modificar esse objeto.The owners are a set of non-admin users who are allowed to modify this object. Somente leitura.Read-only. Anulável.Nullable.
políticapolicy policy collectionpolicy collection As políticas atribuídas a essa entidade de serviço.The policies assigned to this service principal.

MétodosMethods

MétodoMethod Tipo de retornoReturn Type DescriçãoDescription
Get servicePrincipalGet servicePrincipal servicePrincipalservicePrincipal Leia as propriedades e as relações do objeto servicePrincipal.Read properties and relationships of servicePrincipal object.
List servicePrincipalsList servicePrincipals servicePrincipal collectionservicePrincipal collection Recupere uma lista de objetos servicePrincipal.Retrieve a list of servicePrincipal objects.
Create appRoleAssignmentCreate appRoleAssignment appRoleAssignmentappRoleAssignment Crie um novo appRoleAssignment postando-o na coleção appRoleAssignments.Create a new appRoleAssignment by posting to the appRoleAssignments collection.
List appRoleAssignmentsList appRoleAssignments appRoleAssignment collectionappRoleAssignment collection Obtenha uma coleção de objeto appRoleAssignment.Get a appRoleAssignment object collection.
List createdObjectsList createdObjects directoryObject collectiondirectoryObject collection Obtenha uma coleção de objeto createdObject.Get a createdObject object collection.
List 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.
List assigned policiesList assigned policies Coleção policypolicy collection Obtenha todas as políticas atribuídas a esse objeto.Get all policies assigned to this object.
List oauth2PermissionGrantsList oauth2PermissionGrants oAuth2PermissionGrant collectionoAuth2PermissionGrant collection Obtenha uma coleção de objeto oAuth2PermissionGrant.Get a oAuth2PermissionGrant object collection.
List ownedObjectsList ownedObjects directoryObject collectiondirectoryObject collection Obtenha uma coleção de objeto ownedObject.Get a ownedObject object collection.
Add ownerAdd owner directoryObjectdirectoryObject Crie um novo proprietário postando na coleção owners.Create a new owner by posting to the owners collection.
Listar proprietáriosList owners directoryObject collectiondirectoryObject collection Obtenha uma coleção de objeto owner.Get a owner object collection.
UpdateUpdate servicePrincipalservicePrincipal Atualize o objeto servicePrincipal.Update servicePrincipal object.
DeleteDelete NenhumNone Exclua o objeto servicePrincipal.Delete servicePrincipal object.
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 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.List the 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.
deltadelta servicePrincipal collectionservicePrincipal collection Obtenha alterações incrementais para entidades de serviço.Get incremental changes for service principals.