Profiles - Get

Service:

Profile

API Version:

7.1-preview.3

Ruft ein Benutzerprofil ab.

GET https://app.vssps.visualstudio.com/_apis/profile/profiles/{id}?api-version=7.1-preview.3

With optional parameters:

GET https://app.vssps.visualstudio.com/_apis/profile/profiles/{id}?details={details}&withAttributes={withAttributes}&partition={partition}&coreAttributes={coreAttributes}&forceRefresh={forceRefresh}&api-version=7.1-preview.3

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
id	path	True	string	Die ID des Zielbenutzerprofils innerhalb desselben organization oder "ich", um das Profil des aktuellen authentifizierten Benutzers abzurufen.
api-version	query	True	string	Version der zu verwendenden API. Dies sollte auf "7.1-preview.3" festgelegt werden, um diese Version der API zu verwenden.
coreAttributes	query		string	Eine durch Trennzeichen getrennte Liste der zurückzugebenden Hauptprofilattribute. Gültige Werte sind Email, Avatar, DisplayName und ContactWithOffers.
details	query		boolean	Geben Sie öffentliche Profilinformationen wie Anzeigename, E-Mail-Adresse, Land usw. zurück. Wenn false, wird der withAttributes-Parameter ignoriert.
forceRefresh	query		boolean	Wird in dieser Version der API nicht verwendet.
partition	query		string	Die Partition (benannte Gruppe) der zurückzugebenden Attribute.
withAttributes	query		boolean	Wenn true, ruft die Attribute (benannte Schlüssel-Wert-Paare beliebiger Daten) ab, die dem Profil zugeordnet sind. Der Partitionsparameter muss ebenfalls einen Wert aufweisen.

Antworten

Name	Typ	Beschreibung
200 OK	Profile	Erfolgreicher Vorgang

Sicherheit

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Name	Beschreibung
vso.profile	Gewährt die Möglichkeit, Ihr Profil, Ihre Konten, Sammlungen, Projekte, Teams und andere Organisationsartefakte auf oberster Ebene zu lesen.

Beispiele

Sample Request

HTTP

GET https://app.vssps.visualstudio.com/_apis/profile/profiles/{id}?api-version=7.1-preview.3

Sample Response

Status code:

200

{
  "displayName": "Normal Paulk",
  "publicAlias": "d6245f20-2af8-44f4-9451-8107cb2767db",
  "emailAddress": "fabrikamfiber16@hotmail.com",
  "coreRevision": 1647,
  "timeStamp": "2014-05-12T22:23:07.727+00:00",
  "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
  "revision": 1647
}

Definitionen

Name	Beschreibung
AttributeDescriptor	Identifiziert ein Attribut mit einem Namen und einem Container.
AttributesContainer	Speichert einen Satz benannter Profilattribute.
CoreProfileAttribute	Ein Profilattribute, das immer über einen Wert für jedes Profil verfügt.
Profile	Ein Benutzerprofil.
ProfileAttribute	Ein benanntes Objekt, das einem Profil zugeordnet ist.
ProfileState	Der aktuelle Status des Profils.

AttributeDescriptor

Identifiziert ein Attribut mit einem Namen und einem Container.

Name	Typ	Beschreibung
attributeName	string	Der Name des Attributs.
containerName	string	Der Container, in dem sich das Attribut befindet.

AttributesContainer

Speichert einen Satz benannter Profilattribute.

Name	Typ	Beschreibung
attributes	<string,  ProfileAttribute>	Die vom Container gespeicherten Attribute.
containerName	string	Der Name des Containers,
revision	integer	Die maximale Revisionsnummer eines Attributs innerhalb des Containers.

CoreProfileAttribute

Ein Profilattribute, das immer über einen Wert für jedes Profil verfügt.

Name	Typ	Beschreibung
descriptor	AttributeDescriptor	Der Deskriptor des Attributs.
revision	integer	Die Revisionsnummer des Attributs.
timeStamp	string	Der Zeitpunkt der letzten Änderung des Attributs.
value	string	Der Wert des Attributs.

Profile

Ein Benutzerprofil.

Name	Typ	Beschreibung
applicationContainer	AttributesContainer	Die Attribute dieses Profils.
coreAttributes	<string,  CoreProfileAttribute>	Die Hauptattribute dieses Profils.
coreRevision	integer	Die maximale Revisionsnummer eines beliebigen Attributs.
id	string	Der eindeutige Bezeichner des Profils.
profileState	ProfileState	Der aktuelle Status des Profils.
revision	integer	Die maximale Revisionsnummer eines beliebigen Attributs.
timeStamp	string	Der Zeitpunkt, zu dem dieses Profil zuletzt geändert wurde.

ProfileAttribute

Ein benanntes Objekt, das einem Profil zugeordnet ist.

Name	Typ	Beschreibung
descriptor	AttributeDescriptor	Der Deskriptor des Attributs.
revision	integer	Die Revisionsnummer des Attributs.
timeStamp	string	Der Zeitpunkt der letzten Änderung des Attributs.
value	string	Der Wert des Attributs.

ProfileState

Der aktuelle Status des Profils.

Name	Typ	Beschreibung
custom	string	Das Profil wird verwendet.
customReadOnly	string	Das Profil wird verwendet, kann aber nur gelesen werden.
readOnly	string	Das Profil kann nur gelesen werden.