Profiles - Get

Dienst:

Profile

API-Version:

7.1

Ruft ein Benutzerprofil ab.

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

Mit optionalen Parametern:

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
id	path	True	string	Die ID des Zielbenutzerprofils innerhalb derselben Organisation 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" festgelegt werden, um diese Version der API zu verwenden.
coreAttributes	query		string	Eine durch Trennzeichen getrennte Liste der zurückzugebenden Kernprofilattribute. 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üsselwertpaare beliebiger Daten) ab, die dem Profil zugeordnet sind. Der Partitionsparameter muss auch einen Wert aufweisen.

Antworten

Name	Typ	Beschreibung
200 OK	Profile	Erfolgreicher Vorgang

Sicherheit

oauth2

Typ: oauth2
Ablauf: accessCode
Autorisierungs-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

Bereiche

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

Beispiele

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:

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 eine Gruppe von benannten Profilattributen.
CoreProfileAttribute	Ein Profil-Attribut, das immer einen Wert für jedes Profil aufweist.
Profile	Ein Benutzerprofil.
ProfileAttribute	Ein benanntes Objekt, das einem Profil zugeordnet ist.
ProfileState	Der aktuelle Status des Profils.

AttributeDescriptor

Objekt

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

Objekt

Speichert eine Gruppe von benannten Profilattributen.

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

CoreProfileAttribute

Objekt

Ein Profil-Attribut, das immer einen Wert für jedes Profil aufweist.

Name	Typ	Beschreibung
descriptor	AttributeDescriptor	Der Deskriptor des Attributs.
revision	integer (int32)	Die Revisionsnummer des Attributs.
timeStamp	string (date-time)	Der Zeitpunkt, zu dem das Attribut zuletzt geändert wurde.
value	string (T)	Der Wert des Attributs.

Profile

Objekt

Ein Benutzerprofil.

Name	Typ	Beschreibung
applicationContainer	AttributesContainer	Die Attribute dieses Profils.
coreAttributes	<string,  CoreProfileAttribute>	Die Kernattribute dieses Profils.
coreRevision	integer (int32)	Die maximale Revisionsnummer eines beliebigen Attributs.
id	string (uuid)	Der eindeutige Bezeichner des Profils.
profileState	ProfileState	Der aktuelle Status des Profils.
revision	integer (int32)	Die maximale Revisionsnummer eines beliebigen Attributs.
timeStamp	string (date-time)	Die Uhrzeit, zu der dieses Profil zuletzt geändert wurde.

ProfileAttribute

Objekt

Ein benanntes Objekt, das einem Profil zugeordnet ist.

Name	Typ	Beschreibung
descriptor	AttributeDescriptor	Der Deskriptor des Attributs.
revision	integer (int32)	Die Revisionsnummer des Attributs.
timeStamp	string (date-time)	Der Zeitpunkt, zu dem das Attribut zuletzt geändert wurde.
value	string (T)	Der Wert des Attributs.

ProfileState

Enumeration

Der aktuelle Status des Profils.

Wert	Beschreibung
custom	Das Profil wird verwendet.
customReadOnly	Das Profil wird verwendet, kann aber nur gelesen werden.
readOnly	Das Profil kann nur gelesen werden.