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 . Você também pode criar um usuário agente usando o endpoint POST /users e especificando o microsoft.graph.agentUser tipo no corpo da solicitação.

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

Essa operação retorna, por padrão, apenas um subconjunto das propriedades de cada agentUser. 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.

Essa API está disponível nas seguintes implantações de nuvem nacional.

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

Permissões

Escolha a(s) permissão(s) marcada(s) como menos privilegiada(s) para essa API. Use uma permissão ou permissões com privilégios mais altos somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.

Tipo de permissão Permissão com privilégios mínimos Permissões com privilégios mais elevados
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

Para acesso delegado usando contas corporativas ou de estudante, o administrador deve receber uma função do Microsoft Entra com suporte ou uma função personalizada que conceda as permissões necessárias para esta operação. ID do Agente Administrador é a função com menos privilégios com suporte para esta operação.

Solicitação HTTP

POST /users/microsoft.graph.agentUser

Dica

Você também pode criar usuários de agente por meio do POST /users sem especificar o microsoft.graph.agentUser tipo. No entanto, "@odata.type": "microsoft.graph.agentUser" deve ser especificado no corpo da solicitação junto com outras propriedades necessárias para a criação do usuário.

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 da solicitação, forneça uma representação JSON do objeto agentUser .

A tabela a seguir lista as propriedades necessárias ao criar 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 ser exibido no catálogo de endereços do usuário agente.
mailNickname String O alias de email para o usuário agente.
userPrincipalName Cadeia de caracteres O nome UPN (someagent@contoso.com). É um nome de login no estilo da Internet para o usuário do agente com base no padrão da Internet RFC 822. Por convenção, isso deve mapear para o nome de e-mail do usuário 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 A ID do objeto da identidade do agente associado. Obrigatório.

Como esse recurso dá suporte a extensões, você pode usar a POST operação e adicionar propriedades personalizadas com seus próprios dados à instância do usuário do agente ao criá-la.

Resposta

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

A tentativa de criar um agentUser com um identityParentId já vinculado a outro agentUser retorna 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