Nota
O acesso a esta página requer autorização. Podes tentar iniciar sessão ou mudar de diretório.
O acesso a esta página requer autorização. Podes tentar mudar de diretório.
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 Versão.
Representa um subtipo especializado de identidade de utilizador no Microsoft Entra ID concebido para aplicações com tecnologia de IA (agentes) que precisam de funcionar como trabalhadores digitais. Os utilizadores de agente permitem que os agentes acedam a APIs e serviços que exigem especificamente identidades de utilizador, recebendo tokens com idtyp=user afirmações. Os utilizadores de agente são distintos dos utilizadores humanos e apenas são interligados aos utilizadores através de relações como proprietário, patrocinador e gestor.
Cada utilizador do agente mantém uma relação um-para-um com uma identidade do agente principal e é autenticado através das credenciais desse principal. Os utilizadores do agente têm capacidades semelhantes a utilizadores, como a adição a grupos, licenças atribuídas e acesso a funcionalidades de colaboração, como caixas de correio e chat, enquanto operam sob restrições de segurança, incluindo nenhuma autenticação por palavra-passe, nenhuma atribuição de funções de administrador com privilégios e permissões semelhantes aos utilizadores convidados.
Herda do utilizador.
Este recurso é um tipo aberto que permite propriedades adicionais para além das documentadas aqui.
Métodos
| Método | Tipo de retorno | Descrição |
|---|---|---|
| List | agentUser collection | Obtenha uma lista de objetos agentUser . |
| Create | agentUser | Crie um novo objeto agentUser . |
| Get | agentUser | Ler propriedades e relações do objeto agentUser . |
| Atualizar | agentUser | Atualizar o objeto agentUser . |
| Delete | Nenhum | Eliminar o objeto agentUser . |
| Atribuição de funções do aplicativo | ||
| Listar atribuições de funções de aplicações | appRoleAssignment collection | Obtenha as atribuições de funções de aplicação para este utilizador do agente. |
| Criar atribuição de função de aplicação | appRoleAssignment | Crie uma nova atribuição de função de aplicação para este utilizador do agente. |
| Itens excluídos | ||
| List | Coleção directoryObject | Obtenha uma lista de objetos de utilizador do agente eliminados recentemente. |
| Get | directoryObject | Obtenha as propriedades de um utilizador de agente recentemente eliminado. |
| Restaurar | directoryObject | Restaurar um utilizador de agente eliminado recentemente. |
| Excluir permanentemente | Nenhum | Eliminar permanentemente um utilizador do agente. |
| Objetos de diretório | ||
| Listar objetos de propriedade | Coleção directoryObject | Obtenha os objetos de diretório pertencentes ao utilizador do agente. |
| Relações organizacionais | ||
| Listar subordinados diretos | Coleção directoryObject | Obtenha os utilizadores e contactos que reportam ao utilizador do agente. |
| Listar gerente | directoryObject | Obtenha o utilizador ou contacto que é o gestor de utilizador deste agente. |
| Adicionar gestor | Nenhum | Atribua o gestor do utilizador do agente. |
| Remover gestor | Nenhum | Remova o gestor do utilizador do agente. |
| Listar associações diretas | Coleção directoryObject | Obtenha os grupos, funções de diretório e unidades administrativas dos quais o utilizador do agente é membro. |
| Listar associações transitivas | Coleção directoryObject | Obtenha os grupos, funções de diretório e unidades administrativas dos quais o utilizador do agente é membro, incluindo associações a grupos aninhados. |
| Listar relatórios transitivos | Coleção directoryObject | Obtenha os relatórios transitivos para o utilizador do agente. |
| Patrocinadores | ||
| Listar patrocinadores | Coleção directoryObject | Obtenha os utilizadores e grupos responsáveis pelos privilégios deste utilizador do agente. |
| Adicionar patrocinadores | Nenhum | Adicione patrocinadores ao utilizador do agente. |
| Remover patrocinadores | Nenhum | Remova patrocinadores do utilizador do agente. |
Propriedades
Importante
Embora este recurso herda do utilizador, algumas propriedades não são aplicáveis e devolvem null ou são valores predefinidos. Estas propriedades são excluídas da tabela abaixo.
| Propriedade | Tipo | Descrição |
|---|---|---|
| accountEnabled | Booliano |
true se a conta estiver habilitada; caso contrário, false. Esta propriedade é necessária ao criar o objeto. Herdado do utilizador. |
| assignedLicenses | Coleção assignedLicense | As licenças atribuídas ao utilizador do agente, incluindo licenças herdadas (baseadas em grupos). Esta propriedade não diferencia entre licenças atribuídas diretamente e herdadas. Utilize a propriedade licenseAssignmentStates para identificar as licenças diretamente atribuídas e herdadas. Não anulável. Herdado do utilizador. |
| assignedPlans | Coleção assignedPlan | Os planos que são atribuídos ao utilizador do agente. Somente leitura. Não anulável. Herdado do utilizador. |
| businessPhones | String collection | Os números de telefone do utilizador do agente. Somente um número pode ser definido para essa propriedade. Somente leitura para usuários sincronizados do diretório local. Herdado do utilizador. |
| city | Cadeia de caracteres | A cidade onde o utilizador do agente está localizado. O comprimento máximo é de 128 caracteres. Herdado do utilizador. |
| cloudRealtimeCommunicationInfo | cloudRealtimeCommunicationInfo | Informações de comunicação em tempo real da Microsoft relacionadas com o utilizador do agente. Herdado do utilizador. |
| CompanyName | String | O nome da empresa à qual o utilizador do agente está associado. Essa propriedade pode ser útil para descrever a empresa de onde procede um usuário externo. O tamanho máximo é de 64 caracteres. Herdado do utilizador. |
| country | Cadeia de caracteres | O país ou região onde o utilizador do agente está localizado; por exemplo, US ou UK. O comprimento máximo é de 128 caracteres. Herdado do utilizador. |
| createdDateTime | DateTimeOffset | A data e hora em que o utilizador do agente foi criado no formato ISO 8601 e UTC. Não é possível modificar o valor e ele é preenchido automaticamente quando a entidade é criada. Anulável. Para os utilizadores no local, o valor representa quando foram criados pela primeira vez no Microsoft Entra ID. A propriedade destina-se null a alguns utilizadores criados antes de junho de 2018 e os utilizadores no local sincronizados com Microsoft Entra ID antes de junho de 2018. Somente leitura. Herdado do utilizador. |
| creationType | String | Somente leitura. É nulo. Herdado do utilizador. |
| 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. Herdado do utilizador. |
| deletedDateTime | DateTimeOffset | A data e hora que o usuário foi excluído. Herdado de directoryObject. |
| department | String | O nome do departamento onde o utilizador trabalha. O comprimento máximo é de 64 caracteres. Herdado do utilizador. |
| displayName | String | O nome exibido para o usuário no catálogo de endereços. Geralmente o valor é a combinação do nome, da inicial do nome do meio e do sobrenome do usuário. Esta propriedade é necessária quando um utilizador é criado e não pode ser limpa durante as atualizações. O comprimento máximo é de 256 caracteres. Herdado do utilizador. |
| employeeHireDate | DateTimeOffset | A data e hora em que o utilizador foi contratado ou irá começar a trabalhar se existir uma contratação futura. Herdado do utilizador. |
| employeeId | String | O identificador de funcionário atribuído ao usuário pela organização. O comprimento máximo é de 16 caracteres. Herdado do utilizador. |
| employeeLeaveDateTime | DateTimeOffset | A data e hora em que o utilizador saiu ou sairá da organização. Para ler esta propriedade, tem de ser atribuída à aplicação de chamada a permissão User-LifeCycleInfo.Read.All . Para escrever esta propriedade, a aplicação de chamadas tem de ter as permissões User.Read.All e User-LifeCycleInfo.ReadWrite.All . Para ler esta propriedade em cenários delegados, o administrador precisa de, pelo menos, uma das seguintes funções de Microsoft Entra: Administrador de Fluxos de Trabalho do Ciclo de Vida (privilégio mínimo), Leitor Global. Para escrever esta propriedade em cenários delegados, o administrador precisa da função de Administrador Global . Para obter mais informações, veja Configurar a propriedade employeeLeaveDateTime para um utilizador. Herdado do utilizador. |
| employeeOrgData | employeeOrgData | Representa os dados da organização (por exemplo, divisão e costCenter) associados a um utilizador. Herdado do utilizador. |
| employeeType | String | Captura o tipo de trabalhador corporativo. Por exemplo, Employee, Contractor, Consultant ou Vendor. Herdado do utilizador. |
| FaxNumber | String | O número de fax do usuário. Herdado do utilizador. |
| givenName | String | O nome fornecido (nome) do usuário. O comprimento máximo é de 64 caracteres. Herdado do utilizador. |
| id | String | O identificador exclusivo do usuário. Deve ser tratado como um identificador opaco. Herdado de directoryObject. Não anulável. Somente leitura. Herda da entidade |
| identityParentId | Cadeia de caracteres | Referencia o ID de objeto da identidade do agente associada. Esta propriedade é necessária ao criar o objeto e não pode ser limpa durante as atualizações. Herdado do utilizador. |
| imAddresses | String collection | Os endereços SIP (instant message voice-over IP) session initiation protocol (SIP) para o utilizador. Somente leitura. Herdado do utilizador. |
| infoCatalogs | Conjunto de cadeias de caracteres | Identifica os segmentos de informações atribuídos ao usuário. Herdado do utilizador. |
| isLicenseReconciliationNeeded | Booliano | Indica se o utilizador está pendente de uma atribuição de licença de caixa de correio do Exchange. Somente leitura. Herdado do utilizador. |
| isManagementRestricted | Booliano |
true se o utilizador for membro de uma unidade administrativa de gestão restrita. Se não estiver definido, o valor predefinido é null e o comportamento predefinido é falso. Somente leitura. Para gerir um utilizador que seja membro de uma unidade administrativa de gestão restrita, tem de ser atribuída ao administrador ou à aplicação de chamada uma função Microsoft Entra no âmbito da unidade administrativa de gestão restrita. Herdado do utilizador. |
| isResourceAccount | Boolean | Não use – reservado para uso futuro. Herdado do utilizador. |
| jobTitle | String | O cargo do usuário. O comprimento máximo é de 128 caracteres. Herdado do utilizador. |
| licenseAssignmentStates | Coleção licenseAssignmentState | Estado das atribuições de licenças para esse usuário. Também indica licenças atribuídas diretamente e as que o utilizador herdou através de associações a grupos. Somente leitura. Herdado do utilizador. |
| String | O endereço SMTP do usuário, por exemplo, admin@contoso.com. As alterações a esta propriedade também atualizam a coleção proxyAddresses do utilizador para incluir o valor como um endereço SMTP. Esta propriedade não pode conter carateres de destaque. NOTA: não recomendamos que atualize esta propriedade para Azure AD perfis de utilizador B2C. Use em vez da propriedade otherMails. Herdado do utilizador. |
|
| mailNickname | String | O alias de email do usuário. Essa propriedade deve ser especificada quando um usuário é criado. O comprimento máximo é de 64 caracteres. Herdado do utilizador. |
| mobilePhone | String | O número de celular principal do usuário. Só de leitura para utilizadores sincronizados a partir do diretório no local. Herdado do utilizador. |
| officeLocation | String | A localização do escritório no local de trabalho do usuário. O comprimento máximo é de 128 caracteres. Herdado do utilizador. |
| otherMails | Coleção String | Uma lista de endereços de email adicional para o usuário; Por exemplo: ["bob@contoso.com", "Robert@fabrikam.com"]. Pode armazenar até 250 valores, cada um com um limite de 250 carateres. NOTA: esta propriedade não pode conter carateres de destaque. Herdado do utilizador. |
| postalCode | String | O código postal do endereço postal do usuário. O código postal é específico para o país/região do usuário. Nos Estados Unidos, esse atributo contém o CEP. O comprimento máximo é de 40 caracteres. Herdado do utilizador. |
| preferredDataLocation | String | O local de dados preferido para o usuário. Para saber mais, confira OneDrive Online Multi-Geo. Herdado do utilizador. |
| preferredLanguage | String | O idioma preferencial do usuário. O formato de idioma preferencial baseia-se no RFC 4646. O nome combina um código de cultura minúscula ISO 639 de duas letras associado à linguagem e um código de subcultura maiúscula ISO 3166 de duas letras associado ao país ou região. Exemplo: "en-US" ou "es-ES". Herdado do utilizador. |
| provisionedPlans | coleção provisionedPlan | Os planos que estão provisionados para o usuário. Somente leitura. Não anulável. Herdado do utilizador. |
| proxyAddresses | Coleção de cadeias de caracteres | Por exemplo: ["SMTP: bob@contoso.com", "smtp: bob@sales.contoso.com"]. As alterações à propriedade mail também atualizam esta coleção para incluir o valor como um endereço SMTP. Para obter mais informações, consulte propriedades de email e proxyAddresses. O endereço proxy com SMTP prefixo (em maiúsculas) é o endereço proxy principal, enquanto os prefixos smtp com são os endereços proxy secundários. Para Azure AD contas B2C, esta propriedade tem um limite de 10 endereços exclusivos. Somente leitura no Microsoft Graph; você pode atualizar essa propriedade somente por meio do Microsoft 365 de administração. Não anulável. Herdado do utilizador. |
| refreshTokensValidFromDateTime | DateTimeOffset | Todos os tokens de atualização ou tokens de sessões (cookies de sessão) emitidos antes desta hora são inválidos e as aplicações recebem um erro ao utilizar um token de atualização ou sessão inválido para adquirir um token de acesso delegado (para aceder a APIs como o Microsoft Graph). Se tal acontecer, a aplicação tem de adquirir um novo token de atualização ao pedir o ponto final autorizado. Somente leitura. Use invalidateAllRefreshTokens para redefinir. Herdado do utilizador. |
| securityIdentifier | Cadeia de Caracteres | Identificador de segurança (SID) do usuário, usado em cenários do Windows. Somente leitura. Devolvido por padrão. Herdado do utilizador. |
| showInAddressList | Booliano | Não utilize no Microsoft Graph. Em vez disso, faça a gestão desta propriedade através do Centro de administração do Microsoft 365. Representa se o utilizador do agente deve ser incluído na lista de endereços globais do Outlook. Consulte Problema conhecido. Herdado do utilizador. |
| signInSessionsValidFromDateTime | DateTimeOffset | Todos os tokens de atualização ou tokens de sessões (cookies de sessão) emitidos antes desta hora são inválidos e as aplicações recebem um erro ao utilizar um token de atualização ou sessão inválido para adquirir um token de acesso delegado (para aceder a APIs como o Microsoft Graph). Se isto acontecer, a aplicação tem de adquirir um novo token de atualização ao pedir o ponto final autorizado. Somente leitura. Use revokeSignInSessions para redefinir. Herdado do utilizador. |
| state | Cadeia de caracteres | O estado ou província no endereço do utilizador do agente. O comprimento máximo é de 128 caracteres. Herdado do utilizador. |
| streetAddress | String | A morada do local de negócio do utilizador do agente. O comprimento máximo é de 1024 caracteres. Herdado do utilizador. |
| surname | String | O sobrenome do usuário (nome de família ou sobrenome). O comprimento máximo é de 64 caracteres. Herdado do utilizador. |
| usageLocation | Cadeia de caracteres | Um código de país de duas letras (padrão ISO 3166). Necessário para utilizadores de agente a que são atribuídas licenças devido a requisitos legais para marcar para disponibilidade de serviços em países/regiões. Os exemplos incluem:US,JP e GB. Não anulável. Herdado do utilizador. |
| userPrincipalName | Cadeia de caracteres | O nome principal de utilizador (UPN) do utilizador do agente. O UPN é um nome de início de sessão ao estilo da Internet para o utilizador com base no RFC 822 padrão da Internet. Por convenção, deve mapear para o nome de e-mail do utilizador do agente. O formato geral é alias@domain, onde o domínio tem de estar presente na coleção de domínios verificados do inquilino. Essa propriedade é obrigatória quando um usuário é criado. Os domínios verificados para o locatário podem ser acessados pela propriedade verifiedDomains de organization. NOTA: esta propriedade não pode conter carateres de destaque. Somente os seguintes caracteres são permitidos A - Z, a - z, 0 - 9, ' . - _ ! # ^ ~. Para obter a lista completa de caracteres permitidos, consulte as políticas de nome de usuário. Herdado do utilizador. |
| userType | String | Um valor de Cadeia que pode ser utilizado para classificar os tipos de utilizador do agente no diretório. Os valores possíveis são Member e Guest.
NOTA: Para obter mais informações sobre as permissões para utilizadores membros e convidados, consulte Quais são as permissões de utilizador predefinidas no Microsoft Entra ID? Herdado do utilizador. |
Relações
Importante
Embora este tipo de recurso herda todas as relações do tipo de recurso de utilizador , algumas relações não são aplicáveis aos utilizadores do agente e irão sempre devolver null ou predefinir valores. Estas relações são excluídas da tabela abaixo para maior clareza.
| Relação | Tipo | Descrição |
|---|---|---|
| appRoleAssignments | appRoleAssignment collection | Representa as funções de aplicação que foi concedida a um utilizador agente para uma aplicação. Herdado do utilizador |
| directReports | Coleção directoryObject | Os utilizadores e contactos que reportam ao utilizador do agente. (Os utilizadores e contactos com a respetiva propriedade de gestor definida para este utilizador.) Só de leitura. Anulável. Herdado do utilizador |
| manager | directoryObject | O utilizador ou contacto que é o gestor de utilizador deste agente. Somente leitura. Herdado do utilizador |
| memberOf | Coleção directoryObject | Os grupos, funções de diretório e unidades administrativas dos quais o utilizador do agente é membro. Somente leitura. Anulável. Herdado do utilizador |
| ownedObjects | Coleção directoryObject | Objetos de diretório pertencentes ao utilizador do agente. Somente leitura. Anulável. Herdado do utilizador |
| patrocinadores | Coleção directoryObject | Os utilizadores e grupos responsáveis pelos privilégios deste utilizador do agente no inquilino e mantêm as informações e o acesso do utilizador do agente atualizados. (Métodos HTTP: GET, POST, DELETE.). Herdado do utilizador |
| transitiveMemberOf | Coleção directoryObject | Os grupos, incluindo grupos aninhados e funções de diretório dos quais o utilizador do agente é membro. Anulável. Herdado do utilizador |
| transitiveReports | Coleção directoryObject | Os relatórios transitivos de um utilizador do agente. Somente leitura. Herdado do utilizador |
Representação JSON
A representação JSON seguinte mostra o tipo de recurso.
{
"@odata.type": "#microsoft.graph.agentUser",
"id": "String (identifier)",
"deletedDateTime": "String (timestamp)",
"accountEnabled": "Boolean",
"assignedLicenses": [
{
"@odata.type": "microsoft.graph.assignedLicense"
}
],
"assignedPlans": [
{
"@odata.type": "microsoft.graph.assignedPlan"
}
],
"businessPhones": [
"String"
],
"city": "String",
"cloudRealtimeCommunicationInfo": {
"@odata.type": "microsoft.graph.cloudRealtimeCommunicationInfo"
},
"companyName": "String",
"country": "String",
"countryCode": "Integer",
"createdDateTime": "String (timestamp)",
"creationType": "String",
"customSecurityAttributes": {
"@odata.type": "microsoft.graph.customSecurityAttributeValue"
},
"department": "String",
"displayName": "String",
"employeeHireDate": "String (timestamp)",
"employeeId": "String",
"employeeOrgData": {
"@odata.type": "microsoft.graph.employeeOrgData"
},
"employeeType": "String",
"employeeLeaveDateTime": "String (timestamp)",
"faxNumber": "String",
"givenName": "String",
"imAddresses": [
"String"
],
"infoCatalogs": [
"String"
],
"isLicenseReconciliationNeeded": "Boolean",
"isManagementRestricted": "Boolean",
"isResourceAccount": "Boolean",
"jobTitle": "String",
"licenseAssignmentStates": [
{
"@odata.type": "microsoft.graph.licenseAssignmentState"
}
],
"mail": "String",
"mailNickname": "String",
"mobilePhone": "String",
"otherMails": [
"String"
],
"officeLocation": "String",
"postalCode": "String",
"preferredDataLocation": "String",
"preferredLanguage": "String",
"provisionedPlans": [
{
"@odata.type": "microsoft.graph.provisionedPlan"
}
],
"proxyAddresses": [
"String"
],
"refreshTokensValidFromDateTime": "String (timestamp)",
"securityIdentifier": "String",
"showInAddressList": "Boolean",
"signInSessionsValidFromDateTime": "String (timestamp)",
"state": "String",
"streetAddress": "String",
"surname": "String",
"usageLocation": "String",
"userPrincipalName": "String",
"userType": "String",
"identityParentId": "String"
}