Freigeben über

Agent aktualisierenBenutzer

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.

Aktualisieren sie die Eigenschaften eines agentUser-Objekts .

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

Berechtigungen für bestimmte Szenarien

  • Ihr persönliches Microsoft-Konto muss an einen Microsoft Entra Mandanten gebunden sein, um Ihr Profil mit der delegierten Berechtigung User.ReadWrite für ein persönliches Microsoft-Konto zu aktualisieren.
  • So aktualisieren Sie die EmployeeLeaveDateTime-Eigenschaft :
    • In delegierten Szenarien benötigt der Administrator die Rolle "Globaler Administrator ". Der App müssen die delegierten Berechtigungen User.Read.All und User-LifeCycleInfo.ReadWrite.All gewährt werden.
    • In reinen App-Szenarien mit Microsoft Graph-Berechtigungen muss der App die Berechtigungen User.Read.All und User-LifeCycleInfo.ReadWrite.All gewährt werden.
  • So aktualisieren Sie die customSecurityAttributes-Eigenschaft :
    • In delegierten Szenarien muss dem Administrator die Rolle Attributzuweisungsadministrator zugewiesen werden, und der App muss die Berechtigung CustomSecAttributeAssignment.ReadWrite.All gewährt werden.
    • In reinen App-Szenarien mit Microsoft Graph-Berechtigungen muss der App die Berechtigung CustomSecAttributeAssignment.ReadWrite.All erteilt werden.
  • User-Mail.ReadWrite.All ist die Berechtigung mit den geringsten Berechtigungen zum Aktualisieren der otherMails-Eigenschaft .
  • User-PasswordProfile.ReadWrite.All ist die Berechtigung mit den geringsten Berechtigungen zum Aktualisieren der passwordProfile-Eigenschaft .
  • User-Phone.ReadWrite.All ist die Berechtigung mit den geringsten Berechtigungen zum Aktualisieren der Eigenschaften businessPhones und mobilePhone .
  • User.EnableDisableAccount.All + User.Read.All ist die Am wenigsten privilegierte Kombination von Berechtigungen zum Aktualisieren der accountEnabled-Eigenschaft .
  • User.ManageIdentities.All ist erforderlich , um die Identitätseigenschaft zu aktualisieren.

HTTP-Anforderung

PATCH /users/microsoft.graph.agentUser/{userId}

Tipp

Sie können Agent-Benutzer auch über den PATCH /users/{id}- Endpunkt aktualisieren, ohne den microsoft.graph.agentUser Typ anzugeben.

Anforderungsheader

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

Anforderungstext

Geben Sie im Anforderungstext nur die Werte für zu aktualisierende Eigenschaften an. Vorhandene Eigenschaften, die nicht im Anforderungstext enthalten sind, behalten ihre vorherigen Werte bei oder werden basierend auf Änderungen an anderen Eigenschaftswerten neu berechnet.

In der folgenden Tabelle sind die Eigenschaften angegeben, die aktualisiert werden können.

Sie müssen die @odata.type als #microsoft.graph.agentUser im Anforderungstext angeben, wenn Sie einen agentUser aktualisieren.

Eigenschaft Typ Beschreibung
accountEnabled Boolesch true, wenn das Konto aktiviert ist; andernfalls false. Diese Eigenschaft ist erforderlich, wenn ein Agent-Benutzer erstellt wird.
assignedLicenses assignedLicense collection Die Lizenzen, die dem Agent-Benutzer zugewiesen sind. Lässt keine NULL-Werte zu.
businessPhones String collection Die Telefonnummern für den Agent-Benutzer. ANMERKUNG: Obwohl dies eine Zeichenfolgenauflistung ist, kann für diese Eigenschaft nur eine Zahl festgelegt werden.
Ort Zeichenfolge Die Stadt, in der sich der Agent-Benutzer befindet.
CompanyName String Der Name des Unternehmens, dem der Agent-Benutzer zugeordnet ist. Diese Eigenschaft kann nützlich sein, um das Unternehmen zu beschreiben, aus dem ein externer Agent-Benutzer stammt. Die Höchstlänge beträgt 64 Zeichen.
Land/Region Zeichenfolge Das Land/die Region, in dem sich der Agent-Benutzer befindet; z. B US . oder UK.
department Zeichenfolge Der Name für die Abteilung, in der der Agent-Benutzer arbeitet.
displayName Zeichenfolge Der Name, der im Adressbuch für den Agent-Benutzer angezeigt wird. Diese Eigenschaft ist erforderlich, wenn ein Agent-Benutzer erstellt wird, und sie kann während Updates nicht gelöscht werden.
employeeId String Die Mitarbeiter-ID, die dem Agent-Benutzer vom organization zugewiesen ist. Die maximale Länge beträgt 16 Zeichen.
employeeType Zeichenfolge Erfasst den Arbeitnehmertyp des Unternehmens. Zum Beispiel Employee, Contractor, Consultant oder Vendor.
givenName Zeichenfolge Der angegebene Name (Vorname) des Agent-Benutzers.
employeeHireDate DateTimeOffset Das Einstellungsdatum des Agent-Benutzers. Der Timestamp-Typ stellt die Datums- und Uhrzeitinformationen mithilfe des ISO 8601-Formats dar und wird immer in UTC-Zeit angegeben. Zum Beispiel, Mitternacht UTC am 1. Januar 2014 ist 2014-01-01T00:00:00Z.
employeeLeaveDateTime DateTimeOffset Das Datum und die Uhrzeit, zu dem der Agent-Benutzer den organization verlassen hat oder verlässt. Der Zeitstempeltyp stellt Datums- und Uhrzeitinformationen im ISO 8601-Format dar und ist immer in UTC-Zeit angegeben. Zum Beispiel, Mitternacht UTC am 1. Januar 2014 ist 2014-01-01T00:00:00Z.
employeeOrgData employeeOrgData Stellt organization Daten (z. B. division und costCenter) dar, die dem Agent-Benutzer zugeordnet sind. Schließen Sie beim Aktualisieren von employeeOrgData beide Eigenschaftswerte ein. Wenn Sie keine auslassen, legt das System sie auf fest null.
jobTitle Zeichenfolge Die Position des Agent-Benutzers.
mail Zeichenfolge Die SMTP-Adresse für den Agent-Benutzer, z. B salesagent@contoso.com. . Änderungen an dieser Eigenschaft aktualisiert auch die proxyAddresses-Auflistung des Agent-Benutzers, um den Wert als SMTP-Adresse einzuschließen. Kann nicht auf nullaktualisiert werden.
mailNickname Zeichenfolge Der E-Mail-Alias für den Agent-Benutzer. Diese Eigenschaft muss angegeben werden, wenn ein Agent-Benutzer erstellt wird.
mobilePhone String Die primäre Mobiltelefonnummer für den Agent-Benutzer.
officeLocation String Der Bürostandort am Geschäftssitz des Agentenbenutzers.
otherMails Zeichenfolgensammlung Eine Liste zusätzlicher E-Mail-Adressen für den Agent-Benutzer; Beispiel: ["salesagent@contoso.com", "agentsales@fabrikam.com"]. Um diese Eigenschaft zu aktualisieren, übergeben Sie alle E-Mail-Adressen, über die der Agent-Benutzer verfügen soll. Andernfalls werden vorhandene Werte durch die von Ihnen angegebenen Werte überschrieben. Kann bis zu 250 Werte mit jeweils maximal 250 Zeichen speichern.
postalCode Zeichenfolge Die Postleitzahl für die Postanschrift des Agentenbenutzers. Die Postleitzahl ist spezifisch für das Land/die Region des Agentenbenutzers. In den USA enthält dieses Attribut den ZIP Code.
preferredLanguage Zeichenfolge Die bevorzugte Sprache für den Agent-Benutzer. Muss im ISO 639-1-Code angegeben werden, z. B. en-US.
state Zeichenfolge Das Bundesland oder die Provinz in der Adresse des Agentenbenutzers.
streetAddress String Die Adresse des Geschäftsorts des Agentenbenutzers.
surname Zeichenfolge Der Nachname des Agent-Benutzers (Nachname oder Nachname).
usageLocation Zeichenfolge Ein aus zwei Buchstaben bestehender Ländercode (ISO-Standard 3166). Erforderlich für Agent-Benutzer, denen Aufgrund der gesetzlichen Anforderung lizenzen zugewiesen werden, um die Verfügbarkeit von Diensten in Ländern/Regionen zu überprüfen. Beispiele sind US, JP und GB. Lässt keine NULL-Werte zu.
userPrincipalName Zeichenfolge Der Benutzerprinzipalname (UPN) des Agent-Benutzers. Der UPN ist ein Anmeldename 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 Akzentzeichen 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.
userType Zeichenfolge Ein Zeichenfolgenwert kann zum Klassifizieren der Benutzertypen in Ihrem Verzeichnis verwendet werden, z. B. Member und Guest.

Da die agentUser-RessourceErweiterungen unterstützt, können Sie den PATCH Vorgang verwenden, um Eigene App-spezifische Daten in benutzerdefinierten Eigenschaften einer Erweiterung in einem vorhandenen agentUser-instance hinzuzufügen, zu aktualisieren oder zu löschen.

Erweiterungen und zugehörige Daten verwalten

Verwenden Sie diese API, um das Verzeichnis, das Schema und die geöffneten Erweiterungen sowie deren Daten für Agent-Benutzer wie folgt zu verwalten:

  • Hinzufügen, Aktualisieren und Speichern von Daten in den Erweiterungen für einen vorhandenen Agent-Benutzer
  • Entfernen Sie für Verzeichnis- und Schemaerweiterungen alle gespeicherten Daten, indem Sie den Wert der benutzerdefinierten Erweiterungseigenschaft auf null festlegen. Für offene Erweiterungen die API zum Löschen offener Erweiterungen verwenden.

Antwort

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

Beispiele

Anforderung

Das folgende Beispiel zeigt eine Anfrage.

PATCH https://graph.microsoft.com/beta/users/microsoft.graph.agentUser/{userId}
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.agentUser",
  "accountEnabled": true,
  "assignedLicenses": [
    {
      "@odata.type": "microsoft.graph.assignedLicense"
    }
  ],
  "businessPhones": [
    "+1 425 555 0109"
  ],
  "city": "Seattle",
  "companyName": "Contoso",
  "country": "United States",
  "department": "Sales",
  "displayName": "Sales Agent",
  "employeeId": "12345",
  "employeeType": "Agent",
  "givenName": "Sales",
  "employeeHireDate": "2024-01-15T00:00:00Z",
  "employeeLeaveDateTime": null,
  "employeeOrgData": {
    "@odata.type": "microsoft.graph.employeeOrgData",
    "division": "Sales Division",
    "costCenter": "1234"
  },
  "jobTitle": "Sales Agent",
  "mail": "salesagent@contoso.com",
  "mailNickname": "SalesAgent",
  "mobilePhone": "+1 425 555 0110",
  "officeLocation": "18/2111",
  "otherMails": [
    "salesagent@contoso.com"
  ],
  "postalCode": "98052",
  "preferredLanguage": "en-US",
  "state": "WA",
  "streetAddress": "9256 Towne Center Dr., Suite 400",
  "surname": "Agent",
  "usageLocation": "US",
  "userPrincipalName": "salesagent@contoso.com",
  "userType": "Member"
}

Antwort

Das folgende Beispiel zeigt die Antwort.

Hinweis: Das hier gezeigte Antwortobjekt kann zur besseren Lesbarkeit gekürzt werden.

HTTP/1.1 200 OK
Content-Type: application/json

{
  "@odata.type": "#microsoft.graph.agentUser",
  "id": "929393ae-1e1d-159f-0d83-29f7df42e7b9",
  "signInActivity": {
    "@odata.type": "microsoft.graph.signInActivity"
  },
 "cloudLicensing": {
      "@odata.type": "microsoft.graph.cloudLicensing.userCloudLicensing"
    },
    "accountEnabled": "Boolean",
    "ageGroup": null,
    "assignedLicenses": [
      {
        "@odata.type": "microsoft.graph.assignedLicense"
      }
    ],
    "assignedPlans": [
      {
        "@odata.type": "microsoft.graph.assignedPlan"
      }
    ],
    "authorizationInfo": null,
    "businessPhones": [
      "String"
    ],
    "city": "String",
    "cloudRealtimeCommunicationInfo": {
      "@odata.type": "microsoft.graph.cloudRealtimeCommunicationInfo"
    },
    "companyName": "String",
    "consentProvidedForMinor": null,
    "country": "String",
    "createdDateTime": "String (timestamp)",
    "creationType": "String",
    "department": "String",
    "displayName": "String",
    "employeeHireDate": "String (timestamp)",
    "employeeId": "String",
    "employeeOrgData": {
      "@odata.type": "microsoft.graph.employeeOrgData"
    },
    "employeeType": "String",
    "employeeLeaveDateTime": "String (timestamp)",
    "faxNumber": "String",
    "givenName": "String",
    "identities": [
      {
        "@odata.type": "microsoft.graph.objectIdentity"
      }
    ],
    "imAddresses": [
      "String"
    ],
    "infoCatalogs": [
      "String"
    ],
    "isLicenseReconciliationNeeded": "Boolean",
    "isManagementRestricted": "Boolean",
    "isResourceAccount": "Boolean",
    "jobTitle": "String",
    "lastPasswordChangeDateTime": null,
    "legalAgeGroupClassification": null,
    "licenseAssignmentStates": [
      {
        "@odata.type": "microsoft.graph.licenseAssignmentState"
      }
    ],
    "mail": "String",
    "mailNickname": "String",
    "mobilePhone": "String",
    "onPremisesDistinguishedName": null,
    "onPremisesExtensionAttributes": null,
    "onPremisesImmutableId": null,
    "onPremisesLastSyncDateTime": null,
    "onPremisesProvisioningErrors": null,
    "onPremisesSecurityIdentifier": null,
    "onPremisesSipInfo": null,
    "onPremisesSyncEnabled": null,
    "onPremisesDomainName": null,
    "onPremisesSamAccountName": null,
    "onPremisesUserPrincipalName": null,
    "otherMails": [
      "String"
    ],
    "passwordPolicies": null,
    "passwordProfile": null,
    "officeLocation": "String",
    "postalCode": "String",
    "preferredDataLocation": "String",
    "preferredLanguage": "String",
    "provisionedPlans": [
      {
        "@odata.type": "microsoft.graph.provisionedPlan"
      }
    ],
    "proxyAddresses": [
      "String"
    ],
    "refreshTokensValidFromDateTime": "String (timestamp)",
    "securityIdentifier": "String",
    "serviceProvisioningErrors": [
      {
        "@odata.type": "microsoft.graph.serviceProvisioningXmlError"
      }
    ],
    "showInAddressList": "Boolean",
    "signInSessionsValidFromDateTime": "String (timestamp)",
    "state": "String",
    "streetAddress": "String",
    "surname": "String",
    "usageLocation": "String",
    "userPrincipalName": "String",
    "externalUserState": null,
    "externalUserStateChangeDateTime": null,
    "userType": "String",
    "identityParentId": "String",
    "mailboxSettings": {
      "@odata.type": "microsoft.graph.mailboxSettings"
    },
    "aboutMe": "String",
    "birthday": "String (timestamp)",
    "interests": [
      "String"
    ],
    "mySite": "String",
    "pastProjects": [
      "String"
    ],
    "preferredName": "String",
    "responsibilities": [
      "String"
    ],
    "schools": [
      "String"
    ],
    "skills": [
      "String"
    ]
  }
  • Last updated on