Benutzerprofile – REST-API-Referenz
Erfahren Sie mehr über PeopleManager, ProfileLoader, UserProfile und andere listenbezogenen Ressourcen und Endpunkten in der REST-API.
Letzte Änderung: Montag, 9. März 2015
Gilt für: apps for SharePoint | SharePoint Online | SharePoint Server 2013
Informationen zu den Anforderungsbeispielen in diesem Artikel
In den Beispielen in diesem Artikel werden jQuery AJAX-Anforderungen. Führen Sie folgende Aktionen aus, bevor Sie die Beispiele verwenden::
Ändern Sie die <Website-URL> und sonstige Platzhalterdaten wie z. B. IDs, Namen oder Pfade von SharePoint-Entitäten.
Wenn Sie OAuth verwenden, fügen Sie eine Authorization-Kopfzeile ("Authorization": "Bearer " + <access token>) hinzu, um das OAuth-Zugriffstoken zu senden.
Entfernen Sie die Zeilenumbrüche aus der url und den data-Eigenschaftswerten in den Anforderungsbeispielen. Zu den Beispielen werden Zeilenumbrüche hinzugefügt, damit sie leichter gelesen werden können.
Wenn der Server die Antworten im Atomformat zurückgeben soll, müssen Sie die "accept": "application/json;odata=verbose"-Kopfzeile entfernen.
Weitere Informationen zum Ändern von Anforderungen finden Sie unter So unterscheiden sich REST-Anforderungen je nach Umgebung. Links zu weiteren Informationen über die Verwendung der domänenübergreifenden Bibliothek, OAuth und dem SharePoint-REST-Dienst finden Sie unter Zusätzliche Ressourcen.
Tipp
Der SharePoint Online-REST-Dienst unterstützt die Kombination mehrerer Anforderungen in einem einzelnen Dienstaufruf mithilfe der OData-Abfrageoption $batch. Einzelheiten und Links zu Codebeispielen finden Sie unter Erstellen von Batchanforderungen mit den REST-APIs. Diese Option wird für lokales SharePoint noch nicht unterstützt.
PeopleManager-Ressource
Endpunkt-URI | Eigenschaften | Methoden | OData-Darstellung
Stellt Methoden für Vorgänge bereit, die sich auf Personen beziehen.
Die SocialRestFollowingManager-API empfiehlt sich für Aufgaben für das Folgen von Personen oder Inhalten, PeopleManager hingegen bietet Funktionen, die SocialRestFollowingManager nicht bereitstellt.
Endpunkt-URI
http://<Website-URL>/_api/sp.userprofiles.peoplemanager
Unterstützte HTTP-Methoden
GET | POST
Anforderungsbeispiel
GET-Anforderungsbeispiel: Abrufen der aktuellen PeopleManager-Instanz
$.ajax({
url: "http://<site url>/_api/sp.userprofiles.peoplemanager",
type: "GET",
headers: { "accept": "application/json;odata=verbose" },
success: successHandler,
error: errorHandler
});
PeopleManager-Eigenschaften
Senden Sie zum Abrufen einer Eigenschaft eine GET-Anforderung an den Eigenschaftsendpunkt wie im folgenden Beispiel.
$.ajax({
url: "http://<site url>/_api/sp.userprofiles.peoplemanager/<property name>",
type: "GET",
headers: { "accept": "application/json;odata=verbose" },
success: successHandler,
error: errorHandler
});
Eigenschaft |
Typ |
R/W |
Beschreibung |
|
---|---|---|---|---|
EditProfileLink |
String |
R |
Ja |
Die URL der Seite für das Bearbeiten des Profils des aktuellen Benutzers. |
IsMyPeopleListPublic |
Boolean |
R |
Ja |
Ein Boolean-Wert, der angibt, ob die aktuelle Liste Personen, denen ich folge des Benutzers öffentlich ist. |
PeopleManager-Methoden
AmIFollowedBy
AmIFollowing
Follow
FollowTag
GetFollowedTags
GetFollowersFor
GetMyFollowers
GetMyProperties
GetMySuggestions
GetPeopleFollowedBy
GetPeopleFollowedByMe
GetPropertiesFor
GetTrendingTags
GetUserProfilePropertyFor
HideSuggestion
IsFollowing
SetMyProfilePicture
StopFollowing
StopFollowingTag
AmIFollowedBy-Methode
Überprüft, ob der angegebene Benutzer dem aktuellen Benutzer folgt.
Endpunkt |
/amifollowedby(@v)?@v='<Kontoname>' |
Parameter |
Typ: String |
HTTP method |
GET |
Antwort |
Typ: Boolean |
Anforderungsbeispiel
$.ajax({
url: "http://<site url>/_api/sp.userprofiles.peoplemanager
/amifollowedby(@v)?@v='i%3A0%23.f%7Cmembership%7Cuser%40domain.onmicrosoft.com'",
type: "GET",
headers: { "accept": "application/json;odata=verbose" },
success: successHandler,
error: errorHandler
});
AmIFollowing-Methode
Überprüft, ob der aktuelle Benutzer dem angegebenen Benutzer folgt.
Endpunkt |
/amifollowing(@v)?@v='<Kontoname>' |
Parameter |
Typ: String |
HTTP method |
GET |
Antwort |
Typ: Boolean |
Anforderungsbeispiel
$.ajax({
url: "http://<site url>/_api/sp.userprofiles.peoplemanager
/amifollowing(@v)?@v='i%3A0%23.f%7Cmembership%7Cuser%40domain.onmicrosoft.com'",
type: "GET",
headers: { "accept": "application/json;odata=verbose" },
success: successHandler,
error: errorHandler
});
Follow-Methode
Fügt den angegebenen Benutzer zur Liste der gefolgten Benutzer des aktuellen Benutzers hinzu.
Die für diese Aufgabe empfohlene API lautet social.following/follow.
Endpunkt |
/follow(@v)?@v='<Kontoname>' |
Parameter |
Typ: String |
HTTP method |
POST |
Antwort |
Keine |
Anforderungsbeispiel
$.ajax({
url: "http://<site url>/_api/sp.userprofiles.peoplemanager
/follow(@v)?@v='i%3A0%23.f%7Cmembership%7Cuser%40domain.onmicrosoft.com'",
type: "POST",
headers: { "X-RequestDigest": <form digest value> },
success: successHandler,
error: errorHandler
});
FollowTag-Methode
Fügt das angegebene Tag zur Liste der gefolgten Tags des aktuellen Benutzers hinzu.
Die für diese Aufgabe empfohlene API lautet social.following/follow.
Endpunkt |
/followtag('<Tag-ID>') |
Parameter |
Typ: GUID |
HTTP method |
POST |
Antwort |
Keine |
Anforderungsbeispiel
$.ajax({
url: "http://<site url>/_api/sp.userprofiles.peoplemanager
/followtag('3e324ad0-de47-4c0a-b9c6-59fda8419430')",
type: "POST",
headers: { "X-RequestDigest": <form digest value> },
success: successHandler,
error: errorHandler
});
GetFollowedTags-Methode
Ruft Tags ab, denen der Benutzer folgt.
Endpunkt |
/getfollowedtags(<Max. Anzahl>) |
Parameter |
Typ: Int32 |
HTTP method |
GET |
Antwort |
Typ: Collection(String) |
Anforderungsbeispiel
$.ajax({
url: "http://<site url>/_api/sp.userprofiles.peoplemanager
/getfollowedtags(5)",
type: "GET",
headers: { "accept": "application/json;odata=verbose" },
success: successHandler,
error: errorHandler
});
GetFollowersFor-Methode
Ruft die Personen ab, die dem angegebenen Benutzer folgen.
Endpunkt |
/getfollowersfor(@v)?@v='<Kontoname>' |
Parameter |
Typ: String |
HTTP method |
GET |
Antwort |
Typ: Collection(SP.UserProfiles.PersonProperties) |
Anforderungsbeispiel
$.ajax({
url: "http://<site url>/_api/sp.userprofiles.peoplemanager
/getfollowersfor(@v)?@v='i%3A0%23.f%7Cmembership%7Cuser%40domain.onmicrosoft.com'",
type: "GET",
headers: { "accept": "application/json;odata=verbose" },
success: successHandler,
error: errorHandler
});
GetMyFollowers-Methode
Ruft die Personen ab, die dem aktuellen Benutzer folgen.
Die für diese Aufgabe empfohlene API lautet social.following/getfollowers.
Endpunkt |
/getmyfollowers |
Parameter |
Keine |
HTTP method |
GET |
Antwort |
Typ: Collection(SP.UserProfiles.PersonProperties) |
Anforderungsbeispiel
$.ajax({
url: "http://<site url>/_api/sp.userprofiles.peoplemanager
/getmyfollowers",
type: "GET",
headers: { "accept": "application/json;odata=verbose" },
success: successHandler,
error: errorHandler
});
GetMyProperties-Methode
Ruft Benutzereigenschaften für den aktuellen Benutzer ab.
Endpunkt |
/getmyproperties |
Parameter |
Keine |
HTTP method |
GET |
Antwort |
Typ: SP.UserProfiles.PersonProperties |
Anforderungsbeispiel
$.ajax({
url: "http://<site url>/_api/sp.userprofiles.peoplemanager
/getmyproperties",
type: "GET",
headers: { "accept": "application/json;odata=verbose" },
success: successHandler,
error: errorHandler
});
GetMySuggestions-Methode
Ruft Vorschläge für Personen ab, denen der aktuelle Benutzer möglicherweise folgen möchte.
Die für diese Aufgabe empfohlene API lautet social.following/getsuggestions.
Endpunkt |
/getmysuggestions |
Parameter |
Keine |
HTTP method |
GET |
Antwort |
Typ: Collection(SP.UserProfiles.PersonProperties) |
Anforderungsbeispiel
$.ajax({
url: "http://<site url>/_api/sp.userprofiles.peoplemanager
/getmysuggestions",
type: "GET",
headers: { "accept": "application/json;odata=verbose" },
success: successHandler,
error: errorHandler
});
GetPeopleFollowedBy-Methode
Ruft die Personen ab, denen der angegebene Benutzer folgt.
Endpunkt |
/getpeoplefollowedby(@v)?@v='<Kontoname>' |
Parameter |
Typ: String |
HTTP method |
GET |
Antwort |
Typ: Collection(SP.UserProfiles.PersonProperties) |
Anforderungsbeispiel
$.ajax({
url: "http://<site url>/_api/sp.userprofiles.peoplemanager
/getpeoplefollowedby(@v)?@v='i%3A0%23.f%7Cmembership%7Cuser%40domain.onmicrosoft.com'",
type: "GET",
headers: { "accept": "application/json;odata=verbose" },
success: successHandler,
error: errorHandler
});
GetPeopleFollowedByMe-Methode
Ruft die Personen ab, denen der aktuelle Benutzer folgt.
Die für diese Aufgabe empfohlene API lautet social.following/getfollowed.
Endpunkt |
/getpeoplefollowedbyme |
Parameter |
Keine |
HTTP method |
GET |
Antwort |
Typ: Collection(SP.UserProfiles.PersonProperties) |
Anforderungsbeispiel
$.ajax({
url: "http://<site url>/_api/sp.userprofiles.peoplemanager
/getpeoplefollowedbyme",
type: "GET",
headers: { "accept": "application/json;odata=verbose" },
success: successHandler,
error: errorHandler
});
GetPropertiesFor-Methode
Ruft Benutzereigenschaften für den angegebenen Benutzer ab.
Endpunkt |
/getpropertiesfor(@v)?@v='<Kontoname>' |
Parameter |
Typ: String |
HTTP method |
GET |
Antwort |
Typ: SP.UserProfiles.PersonProperties |
Anforderungsbeispiel
$.ajax({
url: "http://<site url>/_api/sp.userprofiles.peoplemanager
/getpropertiesfor(@v)?@v='i%3A0%23.f%7Cmembership%7Cuser%40domain.onmicrosoft.com'",
type: "GET",
headers: { "accept": "application/json;odata=verbose" },
success: successHandler,
error: errorHandler
});
GetTrendingTags-Methode
Ruft die beliebtesten Tags ab. Statische Methode.
Endpunkt |
/sp.userprofiles.peoplemanager.gettrendingtags |
Parameter |
Keine |
HTTP method |
GET |
Antwort |
Typ: SP.UserProfiles.HashTagCollection |
Anforderungsbeispiel
$.ajax({
url: "http://<site url>/_api/
/sp.userprofiles.peoplemanager.gettrendingtags,
type: "GET",
headers: { "accept": "application/json;odata=verbose" },
success: successHandler,
error: errorHandler
});
GetUserProfilePropertyFor-Methode
Ruft die Profileigenschaften für den angegebenen Benutzer ab.
Die GetUserProfilePropertiesFor-Methode ist nicht in der REST-API implementiert. Um alle Benutzerprofileigenschaften abzurufen, rufen Sie die GetPropertiesFor-Methode auf und rufen dann die Benutzerprofileigenschaften aus der UserProfileProperties-Eigenschaft des zurückgegebenen PersonProperties-Objekts ab.
Endpunkt |
/getuserprofilepropertyfor(accountname=@v, propertyname='<Eigenschaftsname>')?@v='<Kontoname>' |
Parameter |
|
HTTP method |
GET |
Antwort |
Typ: String |
Anforderungsbeispiel
$.ajax({
url: "http://<site url>/_api/sp.userprofiles.peoplemanager
/getuserprofilepropertyfor(accountame=@v, propertyname='PictureURL')
?@v='i%3A0%23.f%7Cmembership%7Cuser%domain.onmicrosoft.com'",
type: "GET",
headers: { "accept": "application/json;odata=verbose" },
success: successHandler,
error: errorHandler
});
HideSuggestion-Methode
Entfernt den angegebenen Benutzer aus der Vorschlagsliste des Benutzers der zu folgenden Personen.
Endpunkt |
/hidesuggestion(@v)?@v='<Kontoname>' |
Parameter |
Typ: String |
HTTP method |
POST |
Antwort |
Keine |
Anforderungsbeispiel
$.ajax({
url: "http://<site url>/_api/sp.userprofiles.peoplemanager
/hidesuggestion(@v)?@v='i%3A0%23.f%7Cmembership%7Cuser%domain.onmicrosoft.com'",
type: "POST",
headers: { "X-RequestDigest": <form digest value> },
success: successHandler,
error: errorHandler
});
IsFollowing-Methode
Prüft, ob der erste Benutzer dem zweiten Benutzer folgt. Statische Methode.
Endpunkt |
/sp.userprofiles.peoplemanager.isfollowing( |
Parameter |
|
HTTP method |
GET |
Antwort |
Typ: Boolean |
Anforderungsbeispiel
$.ajax({
url: "http://<site url>/_api
/sp.userprofiles.peoplemanager.isfollowing(possiblefolloweraccountname=@v,possiblefolloweeaccountname=@y)
?@v='i%3A0%23.f%7Cmembership%7Cuser1%40domain.onmicrosoft.com'
&@y='i%3A0%23.f%7Cmembership%7Cuser2%40domain.onmicrosoft.com'",
type: "GET",
headers: { "accept": "application/json;odata=verbose" },
success: successHandler,
error: errorHandler
});
SetMyProfilePicture-Methode
Lädt das Benutzerprofilbild hoch und richtet es ein. Benutzer können nur in ihr eigenes Profil ein Bild hochladen.
Endpunkt |
/setmyprofilepicture |
Parameter |
Typ: Stream |
HTTP method |
POST |
Antwort |
Keine |
Anforderungsbeispiel
$.ajax({
url: "http://<site url>/_api/sp.userprofiles.peoplemanager
/setmyprofilepicture",
type: "POST",
data: arrayBuffer,
processData: false,
headers: {
"accept": "application/json;odata=verbose",
"X-RequestDigest": $("#__REQUESTDIGEST").val(),
"content-length": arrayBuffer.byteLength
},
success: successHandler,
error: errorHandler
});
Die folgenden JavaScript- und jQuery-Codebeispiele stellen den Inhalt der App.js in einer SharePoint-gehosteten App dar. Sie gehen von der Hypothese aus, dass der Benutzer auf der Seite "Default.aspx" eine lokale Datei in einer Dateieingabesteuerung ausgewählt hat.
'use strict';
$(document).ready(function () {
// Check to see if the browser supports the HTML5 FileReader API.
if (!window.FileReader) {
alert('This browser does not support the FileReader API.');
}
});
function setProfilePicture() {
// First get the file buffer and then send the request.
var call = getFileBuffer();
call.done(function (arrayBuffer) {
setMyProfilePicture(arrayBuffer);
});
call.fail(function (error) {
alert(error);
});
// Get the ArrayBuffer for the picture file.
function getFileBuffer() {
// Get the file from the file input control on the page.
// Pictures can be BMP, JPG, or PNG format and up to 5 million bytes.
var file = $('#profilePic')[0].files[0];
var deferred = $.Deferred();
var reader = new FileReader();
reader.onloadend = function (e) {
deferred.resolve(e.target.result);
}
reader.onerror = function (e) {
deferred.reject(e.target.error);
}
reader.readAsArrayBuffer(file);
return deferred.promise();
}
// Send the POST request.
function setMyProfilePicture(arrayBuffer) {
// Get the site URL and construct the endpoint URI for the rest post.
var absoluteUrl = _spPageContextInfo.webAbsoluteUrl;
var setPictureEndpoint = absoluteUrl +
"/_api/sp.userprofiles.peoplemanager/setmyprofilepicture";
$.ajax({
url: setPictureEndpoint,
type: "POST",
data: arrayBuffer,
processData: false,
headers: {
"accept": "application/json;odata=verbose",
"X-RequestDigest": $("#__REQUESTDIGEST").val(),
"content-length": arrayBuffer.byteLength
},
success: function (data) {
alert('SetMyProfilePicture succeeded.');
},
error: function (error) {
alert(error.responseText);
}
});
}
}
StopFollowing-Methode
Entfernt den angegebenen Benutzer aus der Liste derjenigen Benutzer, denen gefolgt wird, wobei es sich um die Liste des aktuellen Benutzers handelt.
Die für diese Aufgabe empfohlene API lautet social.following/stopfollowing.
Endpunkt |
/stopfollowing(@v)?@v='<Kontoname>' |
Parameter |
Typ: String |
HTTP method |
POST |
Antwort |
Keine |
Anforderungsbeispiel
$.ajax({
url: "http://<site url>/_api/sp.userprofiles.peoplemanager
/stopfollowing(@v)?@v='i%3A0%23.f%7Cmembership%7Cuser%domain.onmicrosoft.com'",
type: "POST",
headers: { "X-RequestDigest": <form digest value> },
success: successHandler,
error: errorHandler
});
StopFollowingTag-Methode
Entfernt das angegebene Tag aus der Liste der gefolgten Tags des aktuellen Benutzers.
Die für diese Aufgabe empfohlene API lautet social.following/stopfollowing.
Endpunkt |
/stopfollowingtag('<Tag-ID>') |
Parameter |
Typ: GUID |
HTTP method |
POST |
Antwort |
Keine |
Anforderungsbeispiel
$.ajax({
url: "http://<site url>/_api/sp.userprofiles.peoplemanager
/stopfollowingtag('3e324ad0-de47-4c0a-b9c6-59fda8419430')",
type: "POST",
headers: { "X-RequestDigest": <form digest value> },
success: successHandler,
error: errorHandler
});
OData-Darstellung
Das folgende Beispiel stellt eine PeopleManager-Ressource im JSON-Format dar.
{"d":{
"__metadata":{,
"id":"sp.userprofiles.peoplemanager",
"uri":"http://<site url>/_api/sp.userprofiles.peoplemanager",
"type":"SP.UserProfiles.PeopleManager"
},
"EditProfileLink":"https://domain-my.sharepoint.com:443/_layouts/15/EditProfile.aspx?UserSettingsProvider=dfb95e82%2D8132%2D404b%2Db693%2D25418fdac9b6&ReturnUrl=https%3A%2F%2Fdomain%2Esharepoint%2Ecom%2F%5Fapi%2Fsp%2Euserprofiles%2Epeoplemanager",
"IsMyPeopleListPublic":false
}}
ProfileLoader-Ressource
Stellt einen alternativen Einstiegspunkt zu Benutzerprofilen beriet, anstatt die Methoden direkt aufzurufen.
Endpunkt-URI
POST http://<Website-URL>/_api/sp.userprofiles.profileloader.getprofileloader
Unterstützte HTTP-Methoden
POST
ProfileLoader-Methoden
CreatePersonalSiteEnqueueBulk
GetOwnerUserProfile
GetProfileLoader
GetUserProfile
CreatePersonalSiteEnqueueBulk-Methode
Stellt mindestens eine persönliche Website des Benutzers bereit. (Meine Website-Administrator nur bei SharePoint Online)
Endpunkt |
/createpersonalsiteenqueuebulk Diese Anforderung muss von einem Meine Website-Administrator an die Website "Verwaltungskonsole" von SharePoint Online gesendet werden, wie es das Anforderungsbeispiel zeigt. |
Parameter |
|
HTTP method |
POST |
Antwort |
Keine |
Anforderungsbeispiel
$.ajax({
url: "https://<domain>-admin.sharepoint.com/_api/sp.userprofiles.profileloader.getprofileloader
/createpersonalsiteenqueuebulk",
type: "POST",
data: "{ 'emailIDs': ['usera@domain.onmicrosoft.com', 'userb@domain.onmicrosoft.com'] }",
headers: {
"X-RequestDigest": <form digest value>,
"accept": "application/json;odata=verbose"
},
success: successHandler,
error: errorHandler
});
GetOwnerUserProfile-Methode
Ruft das Benutzerprofil des Websitebesitzers ab. Statische Methode.
Endpunkt |
/sp.userprofiles.profileloader.getowneruserprofile |
Parameter |
Keine |
HTTP method |
POST |
Antwort |
Typ: SP.UserProfiles.UserProfile |
Anforderungsbeispiel
$.ajax({
url: "http://<site url>/_api
/sp.userprofiles.profileloader.getowneruserprofile",
type: "POST",
headers: {
"X-RequestDigest": <form digest value>,
"accept": "application/json;odata=verbose"
},
success: successHandler,
error: errorHandler
});
GetProfileLoader-Methode
Ruft ein ProfileLoader-Objekt aus dem Kontextcache ab. Statische Methode.
Verwenden Sie diesen Endpunkt zum Zugriff auf die CreatePersonalSiteEnqueueBulk- und GetUserProfile-Methoden.
Endpunkt |
/sp.userprofiles.profileloader.getprofileloader |
Parameter |
Keine |
HTTP method |
POST |
Antwort |
Typ: SP.UserProfiles.ProfileLoader |
Anforderungsbeispiel
$.ajax({
url: "http://<site url>/_api
/sp.userprofiles.profileloader.getprofileloader",
type: "POST",
headers: {
"X-RequestDigest": <form digest value>,
"accept": "application/json;odata=verbose"
},
success: successHandler,
error: errorHandler
});
GetUserProfile-Methode
Ruft das Benutzerprofil ab, das dem aktuellen Benutzer entspricht. Statische Methode.
Endpunkt |
/getuserprofile |
Parameter |
Keine |
HTTP method |
POST |
Antwort |
Typ: SP.UserProfiles.UserProfile |
Anforderungsbeispiel
$.ajax({
url: "http://<site url>/_api/sp.userprofiles.profileloader.getprofileloader
/getuserprofile
type: "POST",
headers: {
"X-RequestDigest": <form digest value>,
"accept": "application/json;odata=verbose"
},
success: successHandler,
error: errorHandler
});
UserProfile-Ressource
Endpunkt-URI | Eigenschaften | Methoden | OData-Darstellung
Stellt das clientseitige Benutzerprofil für eine Person dar.
Endpunkt-URI
POST http://<Website-URL>/_api/sp.userprofiles.profileloader.getprofileloader/getuserprofile
Unterstützte HTTP-Methoden
POST
Anforderungsbeispiele
Abrufen des Benutzerprofils des aktuellen Benutzers
$.ajax({
url: "http://<site url/_api/sp.userprofiles.profileloader.getprofileloader
/getuserprofile",
type: "POST",
headers: {
"X-RequestDigest": <form digest value>,
"accept": "application/json;odata=verbose"
},
success: successHandler,
error: errorHandler
});
UserProfile-Eigenschaften
Wenn Sie eine Eigenschaft abrufen möchten, senden Sie eine POST-Anforderung an den Eigenschaftsendpunkt.
$.ajax({
url: "http://<site url/_api/sp.userprofiles.profileloader.getprofileloader
/getuserprofile/<property name>",
type: "POST",
headers: {
"X-RequestDigest": <form digest value>,
"accept": "application/json;odata=verbose"
},
success: successHandler,
error: errorHandler
});
Alle an die UserProfile-Ressource gerichteten Anforderungen müssen als POST-Anforderung gesendet werden, da ein Benutzerprofil mithilfe der ProfileLoader-Ressource abgerufen wird.
Eigenschaft |
Typ |
R/W |
Beschreibung |
|
---|---|---|---|---|
FollowedContent |
FollowedContent |
R |
Nein |
Ein Objekt mit der FollowedDocumentsUrl und der FollowedSitesUrl des Benutzers. |
AccountName |
String |
R |
Ja |
Der Kontoname des Benutzers (nur SharePoint Online). |
DisplayName |
String |
R |
Ja |
Der Anzeigename des Benutzers (nur SharePoint Online). |
O15FirstRunExperience |
Int32 |
R |
Ja |
Das FirstRun-Flag des Benutzers (nur SharePoint Online). |
PersonalSite |
SP.Site |
R |
Nein |
Die persönliche Website des Benutzers. |
PersonalSiteCapabilities |
Int32 |
R |
Ja |
Die Funktionen der persönlichen Website des Benutzers. Stellt einen bitweisen PersonalSiteCapabilities-Wert dar: None = 0; Profile Value = 1; Social Value = 2; Storage Value = 4; MyTasksDashboard Value = 8; Education Value = 16; Guest Value = 32. |
PersonalSiteFirstCreationError |
String |
R |
Ja |
Der Fehler, der bei der Ersterstellung der persönlichen Website des Benutzers ausgegeben wird, falls einen gibt (nur SharePoint Online) |
PersonalSiteFirstCreationTime |
DateTime |
R |
Ja |
Datum und Uhrzeit der Ersterstellung der persönlichen Website des Benutzers (nur SharePoint Online). |
PersonalSiteInstantiationState |
Int32 |
R |
Ja |
Der Status für den Initialisierungsstatus der persönlichen Website PersonalSiteInstantiationState in der .NET-Clientobjektmodellreferenz für eine Liste der Initialisierungsstatutswerte. |
PersonalSiteLastCreationTime |
DateTime |
R |
Ja |
Datum und Uhrzeit der letzten Erstellung der persönlichen Website des Benutzers (nur SharePoint Online). |
PersonalSiteNumberOfRetries |
Int32 |
R |
Ja |
Anzahle der Erstellungsversuche einer persönlichen Website des Benutzers (nur SharePoint Online). |
PictureImportEnabled |
Boolean |
R |
Ja |
Ein Boolean-Wert, der angibt, ob das Benutzerbild aus Exchange importiert wurde. |
PublicUrl |
String |
R |
Ja |
Die öffentliche URL der persönlichen Website des aktuellen Benutzers (nur SharePoint Online). |
UrlToCreatePersonalSite |
String |
R |
Ja |
Die URL für das Erstellen der persönlichen Website des Benutzers. |
UserProfile-Methoden
CreatePersonalSiteEnque
ShareAllSocialData
CreatePersonalSiteEnque-Methoden
Reiht die Erstellung einer persönlichen Website für diesen Benutzer in die Warteschlange ein. Kann verwendet werden, um Dokumente, Webseiten und andere Dateien freizugeben.
Für eine SharePoint Online-Erstellung können Websitehost-Administratoren auch die CreatePersonalSiteEnqueueBulk-Methode verwenden, um persönliche Websites für mindestens einen Benutzer zu erstellen.
Endpunkt |
/createpersonalsiteenque |
Parameter |
Typ: Boolean |
HTTP method |
POST |
Antwort |
Keine |
Anforderungsbeispiel
$.ajax({
url: "http://<site url/_api/sp.userprofiles.profileloader.getprofileloader
/getuserprofile/createpersonalsiteenque(true)",
type: "POST",
headers: { "X-RequestDigest": <form digest value> },
success: successHandler,
error: errorHandler
});
ShareAllSocialData-Methode
Legt die Datenschutzeinstellungen für dieses Profil fest.
Endpunkt |
/createpersonalsiteenque |
Parameter |
Typ: Boolean |
HTTP method |
POST |
Antwort |
Keine |
Anforderungsbeispiel
$.ajax({
url: "http://<site url/_api/sp.userprofiles.profileloader.getprofileloader
/getuserprofile/shareallsocialdata(true)",
type: "POST",
headers: { "X-RequestDigest": <form digest value> },
success: successHandler,
error: errorHandler
});
OData-Darstellung
Das folgende Beispiel stellt eine UserProfile-Ressource im JSON-Format dar.
{"d":{
"__metadata":{,
"id":"https://<site url>/_api/sp.userprofiles.profileloader.getprofileloader/getuserprofile",
"uri":"https://<site url>/_api/sp.userprofiles.profileloader.getprofileloader/getuserprofile",
"type":"SP.UserProfiles.UserProfile"
},
"FollowedContent":{"__deferred":{"uri":"https://<site url>/_api/sp.userprofiles.profileloader.getprofileloader/getuserprofile/FollowedContent"}},
"PersonalSite":{"__deferred":{"uri":"https://<site url>/_api/sp.userprofiles.profileloader.getprofileloader/getuserprofile/PersonalSite"}},
"AccountName":"i:0#.f|membership|user@domain.onmicrosoft.com",
"DisplayName":"User Name",
"O15FirstRunExperience":16,
"PersonalSiteCapabilities":14,
"PersonalSiteFirstCreationError":"Personal Site already exists.",
"PersonalSiteFirstCreationTime":"2014-03-23T17:37:48",
"PersonalSiteInstantiationState":2,
"PersonalSiteLastCreationTime":"2014-03-23T17:38:34",
"PersonalSiteNumberOfRetries":2,
"PictureImportEnabled":true,
"PublicUrl":"https://domain-my.sharepoint.com:443/Person.aspx?accountname=i%3A0%23%2Ef%7Cmembership%7Cuser%40domain%2Eonmicrosoft%2Ecom",
"UrlToCreatePersonalSite":"https://domain-my.sharepoint.com/personal/user_domain_onmicrosoft_com/"
}}
Rückgabe von SP.UserProfiles-Ressourcen in benutzerprofilbezogenen REST-Antworten
Die folgenden REST-Ressourcen aus dem SP.UserProfiles-Namespace werden in Serverantworten für benutzerprofilbezogene REST-Anforderungen zurückgegeben.
HashTag
Stellt einen Hash-Tag in der Trend-Tag-Sammlung dar.
Eigenschaft |
Typ |
Beschreibung |
---|---|---|
Name |
String |
Der interne Name des Hash-Tags. Der Name besteht aus folgenden Komponenten: Präfix L0|#0 + Tag-ID + Zeichen | + Tagname. |
UseCount |
Int64 |
Male, die der Hash-Tag verwendet wird. |
HashTagCollection
Steht für eine Sammlung Hash-Tags in Mikroblog-Einträgen. Die Sammlung wird von der GetTrendingTags-Methode zurückgegeben.
Eigenschaft |
Typ |
Beschreibung |
---|---|---|
Items |
Collection(SP.UserProfiles.HashTag) |
Die Hash-Tags in der Sammlung. |
PersonProperties
Steht für die Benutzereigenschaften.
Eigenschaft |
Typ |
Beschreibung |
---|---|---|
AccountName |
String |
Der Kontoname des Benutzers. |
DirectReports |
Collection(String) |
Die Kontonamen der direkten Mitarbeiter des Benutzers. |
DisplayName |
String |
Der Anzeigename des Benutzers. |
String |
Die E-Mail-Adresse des Benutzers. |
|
ExtendedManagers |
Collection(String) |
Die Kontonamen der Manager-Hierarchie des Benutzers. |
ExtendedReports |
Collection(String) |
Die Kontonamen erweiterten Mitarbeiter des Benutzers. |
IsFollowed |
Boolean |
Ein Boolean-Wert, der angibt, ob der aktuelle Benutzer dem Benutzer folgt. |
LatestPost |
String |
Der letzte Mikroblog-Eintrag des Benutzers. |
Peers |
Collection(String) |
Die Kontonamen der Kollegen des Benutzers. |
PersonalUrl |
String |
Die absolute URL der persönlichen Website des Benutzers. |
PictureUrl |
String |
Die URL des Profilbilds des Benutzers. |
Title |
String |
Der Titel des Benutzers. |
UserProfileProperties |
Collection(SP.KeyValue) |
Die Benutzerprofileigenschaften für den Benutzer. |
UserUrl |
String |
Die URL der Profilseite des Benutzers. |
Hinweise zur Implementierung
Das Format des Kontonamens für Benutzer hängt von der SharePoint-Umgebung ab, wie in Tabelle 1 beschrieben:
Tabelle 2. Formate von Kontonamen
SharePoint -Umgebung |
Beispiel für ein Kontonamensformat |
Übergabe des Kontonamens mithilfe eines Alias in der Abfragezeichenfolge |
---|---|---|
SharePoint Online oder |
i:0#.f|membership|user@domain.com |
…/<method>(@v)?@v='i%3A0%23.f%7Cmembership%7Cuser%40domain.onmicrosoft.com' |
Lokales SharePoint 2013 unter Verwendung von Windows-Forderungen |
i:0#.w|domain\user |
…/<method>(@v)?@v='i%3A0%23.w%7Cdomain\user' |
Lokales SharePoint 2013 unter Verwendung von SAML-Forderungen |
i:05:t|adfs with roles|user@domain.com |
…/<method>(@v)?@v='i%3A05%3At%7Cadfs+with+roles%7Cuser%40domain.com' |
Hinweis
Das Format des Anmeldenamens im SAML-basierten (Security Assertion Markup Language) Forderungsauthentifizierungsbeispiel setzt voraus, dass die Identitätsforderung für eine E-Mail-Adress- oder des Benutzerprinzipalnamensverwendung konfiguriert ist. Die SAML-Forderungsauthentifizierung kann bei Apps, die von SharePoint gehostet sind, nicht eingesetzt werden.
Weitere Ressourcen
Ausführen grundlegender Vorgänge unter Verwendung von SharePoint 2013-REST-Endpunkten
Zugreifen auf SharePoint 2013-Daten über Add-Ins mithilfe der domänenübergreifenden Bibliothek
OAuth-Authentifizierungs- und Autorisierungsablauf für in der Cloud gehostete Apps
Verwenden von OData-Abfragevorgängen in SharePoint REST-Anforderungen
REST-API-Referenz zum Folgen von Personen und Inhalten für SharePoint 2013