Partilhar via

Criar agentUser

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.

Crie um novo objeto agentUser . Também pode criar um utilizador de agente com o ponto final POST /users e especificar o microsoft.graph.agentUser tipo no corpo do pedido.

No mínimo, tem de especificar as propriedades necessárias. Opcionalmente, você pode especificar outras propriedades graváveis.

Esta operação devolve, por predefinição, apenas um subconjunto das propriedades de cada agenteUtilizador. Essas propriedades padrão estão listadas na seção Propriedades. Para obter propriedades não retornadas por padrão, execute uma operação GET e especifique as propriedades em uma opção de consulta $select do OData.

Esta API está disponível nas seguintes implementações de cloud nacionais.

Serviço global US Government L4 US Government L5 (DOD) China operada pela 21Vianet
✅ ✅ ✅ ✅

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Tipo de permissão Permissão com menos privilégios Permissões com privilégios superiores
Delegado (conta corporativa ou de estudante) AgentIdUser.ReadWrite.IdentityParentedBy AgentIdUser.ReadWrite.All, User.ReadWrite.All
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application AgentIdUser.ReadWrite.IdentityParentedBy AgentIdUser.ReadWrite.All, User.ReadWrite.All

Importante

As permissões AgentIdentity* estão atualmente indisponíveis para consentimento através da experiência de permissões da API no centro de administração do Microsoft Entra. Para utilizar estas permissões, pode dar-lhes consentimento através do Microsoft API do Graph chamadas conforme descrito em Conceder ou revogar permissões de API programaticamente. Veja Permissões para gerir identidades de agentes para obter mais informações sobre estas permissões.

Em cenários delegados com contas escolares ou profissionais, tem de ser atribuída ao administrador uma função de Microsoft Entra suportada ou uma função personalizada com uma permissão de função suportada. As seguintes funções com menos privilégios são suportadas para esta operação.

  • Administrador de ID do Agente

Solicitação HTTP

POST /users/microsoft.graph.agentUser

Dica

Também pode criar utilizadores de agente através do POST /users sem especificar o microsoft.graph.agentUser tipo. No entanto, "@odata.type": "microsoft.graph.agentUser" tem de ser especificado no corpo do pedido juntamente com outras propriedades necessárias para a criação do utilizador.

Cabeçalhos de solicitação

Cabeçalho Valor
Autorização {token} de portador. Obrigatório. Saiba mais sobre autenticação e autorização.
Content-Type application/json

Corpo da solicitação

No corpo do pedido, forneça uma representação JSON do objeto agentUser .

A tabela seguinte lista as propriedades necessárias quando cria um agentUser.

Parâmetro Tipo Descrição
accountEnabled Booliano true se a conta estiver habilitada; caso contrário, false.
displayName Cadeia de caracteres O nome a apresentar no livro de endereços do utilizador do agente.
mailNickname String O alias de correio do utilizador do agente.
userPrincipalName Cadeia de caracteres O nome principal de utilizador (someagent@contoso.com). É um nome de início de sessão ao estilo da Internet para o utilizador do agente 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 deve estar presente na coleta de domínios verificados pelo locatário. Os domínios verificados para o locatário podem ser acessados pela propriedade verifiedDomains de organization.
OBSERVAÇÃO: esta propriedade não pode conter caracteres de ênfase. 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.
identityParentId Cadeia de caracteres O ID de objeto da identidade do agente associada. Obrigatório.

Uma vez que este recurso suporta extensões, pode utilizar a POST operação e adicionar propriedades personalizadas com os seus próprios dados à instância de utilizador do agente ao criá-la.

Resposta

Se for bem-sucedido, este método devolve um 201 Created código de resposta e um objeto agentUser no corpo da resposta.

Tentar criar um agentUser com um identityParentId já ligado a outro agentUser devolve um 400 Bad Request erro.

Exemplos

Solicitação

O exemplo a seguir mostra uma solicitação.

POST https://graph.microsoft.com/beta/users/microsoft.graph.agentUser
Content-type: application/json

{
  "accountEnabled": true,
  "displayName": "Sales Agent",
  "mailNickname": "SalesAgent",
  "userPrincipalName": "salesagent@contoso.com",
  "identityParentId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Resposta

O exemplo a seguir mostra a resposta.

O objeto de resposta mostrado aqui pode ser reduzido para facilitar a leitura.

HTTP/1.1 201 Created
Content-type: application/json

{
    "@odata.context": "https://graph.microsoft.com/beta/$metadata#users/$entity",
    "@odata.type": "#microsoft.graph.agentUser",
    "id": "87d349ed-44d7-43e1-9a83-5f2406dee5bd",
    "businessPhones": [],
    "displayName": "Sales Agent",
    "mail": "salesagent@contoso.com",
    "mailNickname": "SalesAgent",
    "userPrincipalName": "salesagent@contoso.com",
    "identityParentId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}

Conteúdo relacionado

  • Last updated on