Profiles - Get

Usługa:

Profile

Wersja interfejsu API:

7.1

Pobiera profil użytkownika.

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

Z parametrami opcjonalnymi:

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
id	path	True	string	Identyfikator docelowego profilu użytkownika w tej samej organizacji lub "ja", aby uzyskać profil bieżącego uwierzytelnionego użytkownika.
api-version	query	True	string	Wersja interfejsu API do użycia. Należy ustawić wartość "7.1", aby używać tej wersji interfejsu API.
coreAttributes	query		string	Rozdzielana przecinkami lista atrybutów profilu podstawowego do zwrócenia. Prawidłowe wartości to Email, Avatar, DisplayName i ContactWithOffers.
details	query		boolean	Zwracaj informacje o profilu publicznym, takie jak nazwa wyświetlana, adres e-mail, kraj itp. Jeśli wartość false, parametr withAttributes jest ignorowany.
forceRefresh	query		boolean	Nie jest używany w tej wersji interfejsu API.
partition	query		string	Partycja (nazwana grupa) atrybutów do zwrócenia.
withAttributes	query		boolean	Jeśli wartość true, pobiera atrybuty (nazwane pary klucz-wartość dowolnego danych) skojarzone z profilem. Parametr partycji musi również mieć wartość.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	Profile	operacja zakończona powodzeniem

Zabezpieczenia

oauth2

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Adres URL tokenu: 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

Zakresy

Nazwa	Opis
vso.profile	Umożliwia odczytywanie profilu, kont, kolekcji, projektów, zespołów i innych artefaktów organizacyjnych najwyższego poziomu.

Przykłady

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

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
}

Definicje

Nazwa	Opis
AttributeDescriptor	Identyfikuje atrybut o nazwie i kontenerze.
AttributesContainer	Przechowuje zestaw nazwanych atrybutów profilu.
CoreProfileAttribute	Atrybut profilu, który zawsze ma wartość dla każdego profilu.
Profile	Profil użytkownika.
ProfileAttribute	Nazwany obiekt skojarzony z profilem.
ProfileState	Bieżący stan profilu.

AttributeDescriptor

Objekt

Identyfikuje atrybut o nazwie i kontenerze.

Nazwa	Typ	Opis
attributeName	string	Nazwa atrybutu.
containerName	string	Kontener, w którym znajduje się atrybut.

AttributesContainer

Objekt

Przechowuje zestaw nazwanych atrybutów profilu.

Nazwa	Typ	Opis
attributes	<string,  ProfileAttribute>	Atrybuty przechowywane przez kontener.
containerName	string	Nazwa kontenera.
revision	integer (int32)	Maksymalna liczba poprawek dowolnego atrybutu w kontenerze.

CoreProfileAttribute

Objekt

Atrybut profilu, który zawsze ma wartość dla każdego profilu.

Nazwa	Typ	Opis
descriptor	AttributeDescriptor	Deskryptor atrybutu.
revision	integer (int32)	Numer poprawki atrybutu.
timeStamp	string (date-time)	Czas ostatniej zmiany atrybutu.
value	string (T)	Wartość atrybutu.

Profile

Objekt

Profil użytkownika.

Nazwa	Typ	Opis
applicationContainer	AttributesContainer	Atrybuty tego profilu.
coreAttributes	<string,  CoreProfileAttribute>	Podstawowe atrybuty tego profilu.
coreRevision	integer (int32)	Maksymalna liczba poprawek dowolnego atrybutu.
id	string (uuid)	Unikatowy identyfikator profilu.
profileState	ProfileState	Bieżący stan profilu.
revision	integer (int32)	Maksymalna liczba poprawek dowolnego atrybutu.
timeStamp	string (date-time)	Czas ostatniej zmiany tego profilu.

ProfileAttribute

Objekt

Nazwany obiekt skojarzony z profilem.

Nazwa	Typ	Opis
descriptor	AttributeDescriptor	Deskryptor atrybutu.
revision	integer (int32)	Numer poprawki atrybutu.
timeStamp	string (date-time)	Czas ostatniej zmiany atrybutu.
value	string (T)	Wartość atrybutu.

ProfileState

Wyliczanie

Bieżący stan profilu.

Wartość	Opis
custom	Profil jest używany.
customReadOnly	Profil jest używany, ale można go odczytywać tylko.
readOnly	Profil może być odczytywany tylko.