Benutzer aktualisieren
Namespace: microsoft.graph
Wichtig
APIs unter der /beta Version in Microsoft Graph können geändert werden. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in Version 1.0 verfügbar ist, verwenden Sie die Versionsauswahl .
Aktualisieren der Eigenschaften eines user-Objekts. Nicht alle Eigenschaften können von Mitglieds- oder Gastbenutzern mit ihren Standardberechtigungen ohne Administratorrollen aktualisiert werden. Vergleichen Sie die Standardberechtigungen von Mitgliedern und Gästen, um zu sehen, welche Eigenschaften sie verwalten können.
Berechtigungen
Eine der folgenden Pefrmissions ist erforderlich, um diese API aufzurufen. Weitere Informationen, unter anderem zur Auswahl von Berechtigungen, finden Sie unter Berechtigungen.
| Berechtigungstyp | Berechtigungen (von der Berechtigung mit den wenigsten Rechten zu der mit den meisten Rechten) |
|---|---|
| Delegiert (Geschäfts-, Schul- oder Unikonto) | User.ReadWrite, User.ReadWrite.All, User.ManageIdentities.All, Directory.ReadWrite.All |
| Delegiert (persönliches Microsoft-Konto) | User.ReadWrite |
| Anwendung | User.ReadWrite.All, User.ManageIdentities.All, Directory.ReadWrite.All |
Hinweis
- Das Aktualisieren der businessPhones-, mobilePhone- oder otherMails-Eigenschaft eines anderen Benutzers ist nur für Benutzer zulässig, die keine Administratoren sind oder einer denen eine der folgenden Rollen zugewiesen wurde: Verzeichnis lesen, Gasteinladender, Nachrichtencenter-Leser und Berichts-Leser. Weitere Details finden Sie unter „Helpdeskadministrator (Kennwort) in In Azure AD integrierte Rollen. Dies gilt für Apps, denen die delegierten oder Anwendungsberechtigungen „User.ReadWrite.All“ oder „Directory.ReadWrite.All“ erteilt wurden. Nur ein globaler Administrator, dem die Berechtigung Directory.AccessAsUser.All zugewiesen ist, kann diese Eigenschaften für Administratoren mit höheren Rechten aktualisieren.
- Ihr persönliches Microsoft-Konto muss an einen AAD-Mandanten gebunden sein, damit Sie Ihr Profil mit der delegierten Berechtigung „User.ReadWrite“ auf einem persönlichen Microsoft-Konto aktualisieren können.
- Für die Aktualisierung der Eigenschaft identities ist die Berechtigung "User.ManageIdentities.All" erforderlich. Das Hinzufügen eines lokalen B2C-Kontos zu einem bestehenden user-Objekt ist ebenfalls nicht zulässig, es sei denn, das user-Objekt enthält bereits eine lokale Kontoidentität.
HTTP-Anforderung
PATCH /users/{id | userPrincipalName}
Anforderungsheader
| Kopfzeile | Wert |
|---|---|
| Authorization | Bearer {token}. Erforderlich. |
| Content-Type | application/json |
Anforderungstext
Geben Sie im Anforderungstext die Werte für die relevanten Felder an, die aktualisiert werden sollen. Vorhandene Eigenschaften, die nicht im Anforderungstext enthalten sind, behalten ihre vorherigen Werte oder werden basierend auf Änderungen an anderen Eigenschaftswerten neu berechnet. Aus Gründen der Leistung sollten Sie vorhandene Werte, die nicht geändert wurden, nicht angeben.
| Eigenschaft | Typ | Beschreibung |
|---|---|---|
| aboutMe | String | Ein Freihandform-Texteingabefeld, in dem der Benutzer sich selbst beschreiben kann. |
| accountEnabled | Boolesch | true, wenn das Konto aktiviert ist; andernfalls false. Diese Eigenschaft ist erforderlich, wenn ein Benutzer erstellt wird. Ein globaler Administrator, dem die delegierte Berechtigung Directory.AccessAsUser.All zugewiesen ist, kann den Status accountEnabled aller Administratoren im Mandanten aktualisieren. |
| ageGroup | ageGroup | Legt die Altersgruppe des Benutzers fest. Zulässige Werte: null, Minor, NotAdult und Adult. Weitere Informationen finden Sie in den gesetzlichen Eigenschaftsdefinitionen für Altersgruppen. |
| assignedLicenses | assignedLicense collection | Die Lizenzen, die dem Benutzer zugewiesen sind. Lässt keine NULL-Werte zu. |
| birthday | DateTimeOffset | Der Geburtstag des Benutzers. Der Timestamp-Typ stellt die Datums- und Uhrzeitinformationen mithilfe des ISO 8601-Formats dar und wird immer in UTC-Zeit angegeben. Mitternacht UTC-Zeit des 1. Januar 2014 sieht z. B. wie folgt aus: 2014-01-01T00:00:00Z |
| businessPhones | String-Sammlung | Die Telefonnummern für den Benutzer. HINWEIS: Obwohl dies eine Zeichenfolgenauflistung ist, kann für diese Eigenschaft nur eine Zahl festgelegt werden. |
| Ort | String | Die Stadt, in der sich der Benutzer befindet. |
| CompanyName | String | Der Unternehmensname, dem der Benutzer zugewiesen ist. Diese Eigenschaft kann nützlich sein, um die Firma zu beschreiben, aus der ein externer Benutzer kommt. Die Höchstlänge beträgt 64 Zeichen. |
| consentProvidedForMinor | consentProvidedForMinor | Legt fest, ob die Einverständniserklärung für Minderjährige eingeholt wurde. Zulässige Werte: null, Granted, Denied und NotRequired. Weitere Informationen finden Sie in den gesetzlichen Eigenschaftsdefinitionen für Altersgruppen. |
| Land/Region | ||
| Zeichenfolge | Land/Region, in dem/der sich der Benutzer befindet, z. B. US oder UK. |
|
| customSecurityAttributes | customSecurityAttributeValue | Ein offener komplexer Typ, der den Wert eines benutzerdefinierten Sicherheitsattributs enthält, das einem Verzeichnisobjekt zugewiesen ist. Um diese Eigenschaft zu aktualisieren, muss dem aufrufenden Prinzipal die Rolle "Attributzuweisungsadministrator" zugewiesen sein, und ihm muss die Berechtigung CustomSecAttributeAssignment.ReadWrite.All erteilt werden. |
| department | String | Der Name der Abteilung, in der der Benutzer arbeitet. |
| displayName | Zeichenfolge | Der Name, der im Adressbuch für den Benutzer angezeigt wird. Dies ist normalerweise eine Kombination aus dem Vornamen, der Initiale des weiteren Vornamens und dem Nachnamen. Diese Eigenschaft ist beim Erstellen eines Benutzers erforderlich und kann bei Updates nicht gelöscht werden. |
| employeeId | String | Die Mitarbeiter-ID, die dem Benutzer von der Organisation zugewiesen wurde. 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 Vorname des Benutzers. |
| employeeHireDate | DateTimeOffset | Der Einstellungsdatum des Benutzers. Der Timestamp-Typ stellt die Datums- und Uhrzeitinformationen mithilfe des ISO 8601-Formats dar und wird immer in UTC-Zeit angegeben. Mitternacht UTC-Zeit des 1. Januar 2014 sieht z. B. wie folgt aus: 2014-01-01T00:00:00Z. |
| identities | objectIdentity-Sammlung | Stellt die Identitäten dar, mit denen Sie sich bei diesem Benutzerkonto anmelden können. Eine Identität kann von Microsoft, von Organisationen oder von Social Media-Identitäsanbietern wie Facebook, Google und Microsoft bereitgestellt und an ein Benutzerkonto gebunden werden. Jede Aktualisierung von Identitäten ersetzt die gesamte Auflistung, und Sie müssen die userPrincipalName signInType-Identität in der Auflistung angeben. |
| interests | String collection | Eine Liste für den Benutzer, um dessen Interessen zu beschreiben. |
| jobTitle | String | Die Position des Benutzers. |
| Zeichenfolge | SMTP-Adresse für den Benutzer, z. B. jeff@contoso.onmicrosoft.com. Bei Azure AD B2C-Konten kann diese Eigenschaft nur bis zu zehn Mal mit eindeutigen SMTP-Adressen aktualisiert werden. Durch Änderungen an dieser Eigenschaft wird auch die proxyAddresses-Sammlung des Benutzers aktualisiert, um den Wert als SMTP-Adresse aufzunehmen. |
|
| mailNickname | Zeichenfolge | Der E-Mail-Alias für den Benutzer. Diese Eigenschaft muss beim Erstellen eines Benutzers angegeben werden. |
| mobilePhone | String | Die Nummer des primären Mobiltelefons für den Benutzer. |
| mySite | String | Die URL für die persönliche Website des Benutzers. |
| officeLocation | String | Der Bürostandort der Firma des Benutzers |
| onPremisesExtensionAttributes | onPremisesExtensionAttributes | Enthält die Erweiterungsattribute 1 bis 15 für den Benutzer. Beachten Sie, dass die einzelnen Erweiterungsattribute weder ausgewählt noch gefiltert werden können. Für einen onPremisesSyncEnabled-Benutzer ist die Autoritätsquelle für diese Gruppe von Eigenschaften lokal und schreibgeschützt. Diese Erweiterungsattribute werden auch als benutzerdefinierte Exchange-Attribute 1-15 bezeichnet. |
| onPremisesImmutableId | String | Diese Eigenschaft wird verwendet, um ein lokales Active Directory-Benutzerkonto dem Azure AD-Benutzerobjekt zuzuordnen. Diese Eigenschaft muss angegeben werden, wenn ein neues Benutzerkonto in Graph erstellt wird, falls Sie eine Verbunddomäne für die userPrincipalName-Eigenschaft (UPN) des Benutzers verwenden. WICHTIG: Die Zeichen $ und _ können beim Angeben dieser Eigenschaft nicht verwendet werden. |
| otherMails | Zeichenfolgensammlung | Eine Liste zusätzlicher E-Mail-Adressen für den Benutzer; z. B.: ["bob@contoso.com", "Robert@fabrikam.com"]. |
| passwordPolicies | String | Gibt die Kennwortrichtlinien für den Benutzer an. Dieser Wert ist eine Enumeration, deren einziger möglicher Wert DisableStrongPassword lautet. Damit können schwächere Kennwörter als in der Standardrichtlinie angegeben festgelegt werden. Auch DisablePasswordExpiration kann angegeben werden. Beide können zusammen angegeben werden, z. B.: DisablePasswordExpiration, DisableStrongPassword. |
| passwordProfile | PasswordProfile | Gibt das Kennwortprofil für den Benutzer an. Das Profil enthält das Kennwort des Benutzers. Diese Eigenschaft ist erforderlich, wenn ein Benutzer erstellt wird. Das Kennwort im Profil muss den Mindestanforderungen entsprechen, wie von der passwordPolicies-Eigenschaft angegeben. Standardmäßig ist ein sicheres Kennwort erforderlich. Im delegierten Zugriff muss der aufrufenden App im Namen des angemeldeten Benutzers die delegierte Berechtigung Directory.AccessAsUser.All zugewiesen werden. Im reinen Anwendungszugriff muss der aufrufenden App die Anwendungsberechtigung "User.ReadWrite.All" und mindestens die Azure AD-Rolle des Benutzeradministrators zugewiesen sein. |
| pastProjects | String collection | Eine Liste zur Aufzählung der erledigten Projekte eines Benutzers. |
| postalCode | String | Die Postleitzahl für die Postanschrift des Benutzers. Die Postleitzahl ist für das Land/die Region des Benutzers spezifisch. In den USA enthält dieses Attribut den ZIP Code. |
| preferredLanguage | Zeichenfolge | Die bevorzugte Sprache für den Benutzer. Muss im ISO 639-1-Code angegeben werden. Beispiel: en-US. |
| responsibilities | String collection | Eine Liste zur Aufzählung der Verantwortlichkeiten eines Benutzers. |
| schools | String collection | Eine Liste zur Aufzählung der vom Benutzer besuchten Schulen. |
| skills | String collection | Eine Liste zur Aufzählung der Qualifikationen eines Benutzers. |
| state | Zeichenfolge | Bundesland oder Kanton in der Adresse des Benutzers. |
| streetAddress | String | Die Straße der Firma des Benutzers. |
| surname | String | Der Nachname des Benutzers. |
| usageLocation | Zeichenfolge | Ein aus zwei Buchstaben bestehender Ländercode (ISO-Standard 3166). Erforderlich für Benutzer, denen Lizenzen zugewiesen werden aufgrund der gesetzlichen Vorschrift, dass die Verfügbarkeit von Diensten in einzelnen Ländern geprüft werden muss. Beispiele sind: US, JP und GB. Nullwerte zulassend. |
| userPrincipalName | Zeichenfolge | Der Benutzerprinzipalname (User Principal Name, UPN) des Benutzers. Der UPN ist ein Anmeldename des Benutzers im Internetformat, der auf dem Internetstandard RFC 822 basiert. Gemäß der Konvention sollte er dem E-Mail-Namen des Benutzers zugeordnet sein. 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. |
| userType | Zeichenfolge | Ein Zeichenfolgenwert kann zum Klassifizieren der Benutzertypen in Ihrem Verzeichnis verwendet werden, z. B. Member und Guest. |
Da die Benutzerressource Erweiterungen unterstützt, können Sie den PATCH Vorgang verwenden, um Eigene App-spezifische Daten in benutzerdefinierten Eigenschaften einer Erweiterung in einer vorhandenen Benutzerinstanz hinzuzufügen, zu aktualisieren oder zu löschen.
Hinweis
- Die folgenden Eigenschaften können nicht von einer App mit nur Anwendungsberechtigungen aktualisiert werden: aboutMe, geburtstag, employeeHireDate, interests, mySite, pastProjects, responsibilities, schools, and skills.
- Um die folgenden Eigenschaften zu aktualisieren, müssen Sie sie in ihrer eigenen PATCH-Anforderung angeben, ohne die anderen in der obigen Tabelle aufgeführten Eigenschaften anzugeben: aboutMe, Geburtstag, Interessen, meineWebsite, pastProjects, Zuständigkeiten, Schulen und Fähigkeiten.
Erweiterungen und zugehörige Daten verwalten
Verwenden Sie diese API, um Verzeichnis-, Schema- und offene Erweiterungen und deren Daten für Benutzer wie folgt zu verwalten:
- Daten in den Erweiterungen für einen vorhandenen Benutzer hinzufügen, aktualisieren und speichern
- Entfernen Sie für Verzeichnis- und Schemaerweiterungen alle gespeicherten Daten, indem Sie den Wert der benutzerdefinierten Erweiterungseigenschaft auf
nullfestlegen. Für offene Erweiterungen die API zum Löschen offener Erweiterungen verwenden.
Antwort
Wenn die Methode erfolgreich verläuft, wird der Antwortcode 204 No Content zurückgegeben.
Beispiel
Beispiel 1: Aktualisieren der Eigenschaften des angemeldeten Benutzers
Anfrage
Das folgende Beispiel zeigt eine Anfrage.
PATCH https://graph.microsoft.com/beta/me
Content-type: application/json
{
"businessPhones": [
"+1 425 555 0109"
],
"officeLocation": "18/2111"
}
Antwort
Das folgende Beispiel zeigt die Antwort.
HTTP/1.1 204 No Content
Beispiel 2: Aktualisieren der Eigenschaften des angegebenen Benutzers
Anfrage
Das folgende Beispiel zeigt eine Anfrage.
PATCH https://graph.microsoft.com/beta/users/{id}
Content-type: application/json
{
"businessPhones": [
"+1 425 555 0109"
],
"officeLocation": "18/2111"
}
Antwort
Das folgende Beispiel zeigt die Antwort.
HTTP/1.1 204 No Content
Beispiel 3: Aktualisieren des passwordProfile eines Benutzers zum Zurücksetzen des Kennworts
Das folgende Beispiel zeigt eine Anforderung, die das Kennwort eines anderen Benutzers zurücksetzt.
Anforderung
PATCH https://graph.microsoft.com/beta/users/{id}
Content-type: application/json
{
"passwordProfile": {
"forceChangePasswordNextSignIn": false,
"password": "xWwvJ]6NMw+bWH-d"
}
}
Antwort
HTTP/1.1 204 No Content
Beispiel 4: Zuweisen eines benutzerdefinierten Sicherheitsattributs mit einem Zeichenfolgenwert zu einem Benutzer
Das folgende Beispiel zeigt, wie Sie einem Benutzer ein benutzerdefiniertes Sicherheitsattribut mit einem Zeichenfolgenwert zuweisen.
- Attributsatz:
Engineering - Attribut:
ProjectDate - Attributdatentyp: Zeichenfolge
- Attributwert:
"2022-10-01"
Um benutzerdefinierte Sicherheitsattribute zuzuweisen, muss dem aufrufenden Prinzipal die Rolle "Attributzuweisungsadministrator" zugewiesen werden, und dem aufrufenden Prinzipal muss die Berechtigung CustomSecAttributeAssignment.ReadWrite.All erteilt werden.
Weitere Beispiele für Benutzer finden Sie unter Zuweisen, Aktualisieren oder Entfernen von benutzerdefinierten Sicherheitsattributen mithilfe der Microsoft Graph-API.
Anforderung
PATCH https://graph.microsoft.com/beta/users/{id}
Content-type: application/json
{
"customSecurityAttributes":
{
"Engineering":
{
"@odata.type":"#Microsoft.DirectoryServices.CustomSecurityAttributeValue",
"ProjectDate":"2022-10-01"
}
}
}
Antwort
HTTP/1.1 204 No Content
Beispiel 5: Hinzufügen oder Aktualisieren der Werte einer Schemaerweiterung für einen Benutzer
Sie können einen Wert einer einzelnen Eigenschaft oder allen Eigenschaften in der Erweiterung aktualisieren oder zuweisen.
Anforderung
PATCH https://graph.microsoft.com/beta/users/4562bcc8-c436-4f95-b7c0-4f8ce89dca5e
Content-type: application/json
{
"ext55gb1l09_msLearnCourses": {
"courseType": "Admin"
}
}
Antwort
HTTP/1.1 204 No Content
Hinweis: Um den Wert der Schemaerweiterung aus dem Benutzerobjekt zu entfernen, setzen Sie die Eigenschaft auf
null. Zum Beispiel:PATCH https://graph.microsoft.com/v1.0/users/4562bcc8-c436-4f95-b7c0-4f8ce89dca5e Content-type: application/json { "ext55gb1l09_msLearnCourses": null }
Siehe auch
Feedback
Feedback senden und anzeigen für