Freigeben über

Agent erstellenBenutzer

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Erstellen Sie ein neues agentUser-Objekt . Sie können auch einen Agent-Benutzer erstellen, indem Sie den ENDPUNKT POST /users verwenden und den microsoft.graph.agentUser Typ im Anforderungstext angeben.

Sie müssen mindestens die erforderlichen Eigenschaften angeben. Optional können Sie weitere schreibbare Eigenschaften festlegen.

Dieser Vorgang gibt standardmäßig nur eine Teilmenge der Eigenschaften für jeden agentUser zurück. Diese Standardeigenschaften werden im Abschnitt Eigenschaften aufgeführt. Um Eigenschaften abzurufen, die nicht standardmäßig zurückgegeben werden, führen Sie eine GET-Operation aus, und geben Sie die Eigenschaften in einer $select OData-Abfrageoption an.

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Weltweiter Service US Government L4 US Government L5 (DOD) China, betrieben von 21Vianet
✅ ✅ ✅ ✅

Berechtigungen

Wählen Sie die Berechtigungen aus, die für diese API als am wenigsten privilegiert markiert sind. Verwenden Sie eine höhere Berechtigung oder Berechtigungen nur, wenn Ihre App dies erfordert. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp Berechtigung mit den geringsten Rechten Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto) AgentIdUser.ReadWrite.IdentityParentedBy AgentIdUser.ReadWrite.All, User.ReadWrite.All
Delegiert (persönliches Microsoft-Konto) Nicht unterstützt Nicht unterstützt
Application AgentIdUser.ReadWrite.IdentityParentedBy AgentIdUser.ReadWrite.All, User.ReadWrite.All

Wichtig

Die AgentIdentity*-Berechtigungen sind derzeit nicht für die Zustimmung über die API-Berechtigungsoberfläche auf dem Microsoft Entra Admin Center verfügbar. Um diese Berechtigungen zu verwenden, können Sie ihnen über Microsoft Graph-API-Aufrufe zustimmen, wie unter Programmgesteuertes Gewähren oder Widerrufen von API-Berechtigungen beschrieben. Weitere Informationen zu diesen Berechtigungen finden Sie unter Berechtigungen zum Verwalten von Agent-Identitäten .

In delegierten Szenarien mit Geschäfts-, Schul- oder Unikonten muss dem Administrator eine unterstützte Microsoft Entra Rolle oder eine benutzerdefinierte Rolle mit einer unterstützten Rollenberechtigung zugewiesen werden. Die folgenden Rollen mit den geringsten Berechtigungen werden für diesen Vorgang unterstützt.

  • Agent-ID-Administrator

HTTP-Anforderung

POST /users/microsoft.graph.agentUser

Tipp

Sie können auch Agent-Benutzer über post /users erstellen, ohne den microsoft.graph.agentUser Typ anzugeben. Allerdings "@odata.type": "microsoft.graph.agentUser" muss im Anforderungstext zusammen mit anderen erforderlichen Eigenschaften für die Benutzererstellung angegeben werden.

Anforderungsheader

Kopfzeile Wert
Authorization Bearer {token}. Erforderlich. Erfahren Sie mehr über Authentifizierung und Autorisierung.
Content-Type application/json

Anforderungstext

Geben Sie im Anforderungstext eine JSON-Darstellung des agentUser-Objekts an.

In der folgenden Tabelle sind die Eigenschaften aufgeführt, die erforderlich sind, wenn Sie einen agentUser erstellen.

Parameter Typ Beschreibung
accountEnabled Boolesch true, wenn das Konto aktiviert ist; andernfalls false.
displayName Zeichenfolge Der Name, der im Adressbuch für den Agent-Benutzer angezeigt werden soll.
mailNickname Zeichenfolge Der E-Mail-Alias für den Agent-Benutzer.
userPrincipalName Zeichenfolge Der Benutzerprinzipalname (someagent@contoso.com). Es handelt sich um einen Anmeldenamen im Internetformat für den Agent-Benutzer, der auf dem Internetstandard RFC 822 basiert. Standardmäßig sollte dies dem E-Mail-Namen des Agent-Benutzers zugeordnet werden. Das allgemeine Format lautet „alias@domäne“, wobei „domäne“ in der Sammlung der verifizierten Domänen des Mandanten vorhanden sein muss. Auf die verifizierten Domänen für den Mandanten kann über die verifiedDomains -Eigenschaft von organization zugegriffen werden.
HINWEIS: Diese Eigenschaft darf keine Akzentuierungszeichen enthalten. Nur die folgenden Zeichen sind zulässig: A - Z, a - z, 0 - 9, ' . - _ ! # ^ ~. Eine vollständige Liste der zulässigen Zeichen finden Sie unter Richtlinien für Benutzernamen.
identityParentId Zeichenfolge Die Objekt-ID der zugeordneten Agentidentität. Erforderlich.

Da diese Ressource Erweiterungen unterstützt, können Sie den POST -Vorgang verwenden und dem Agent-Benutzer instance beim Erstellen benutzerdefinierte Eigenschaften mit Ihren eigenen Daten hinzufügen.

Antwort

Bei erfolgreicher Ausführung gibt die Methode den 201 Created Antwortcode und ein agentUser-Objekt im Antworttext zurück.

Beim Versuch, einen agentUser mit einer identityParentId zu erstellen, die bereits mit einem anderen agentUser verknüpft ist, wird ein 400 Bad Request Fehler zurückgegeben.

Beispiele

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

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"
}

Antwort

Das folgende Beispiel zeigt die Antwort.

Das hier gezeigte Antwortobjekt wird möglicherweise zur besseren Lesbarkeit verkürzt.

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"
}

Verwandte Inhalte

  • Last updated on