Profiles - Get

Reference

Service:: Profile

API Version:: 7.1-preview.3

Získá profil uživatele.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
id	path	True	string	ID cílového profilu uživatele ve stejné organizaci nebo "já" pro získání profilu aktuálního ověřeného uživatele.
api-version	query	True	string	Verze rozhraní API, která se má použít. Aby se tato verze rozhraní API používala, měla by být nastavená na 7.1-preview.3.
coreAttributes	query		string	Seznam atributů základního profilu oddělených čárkami, které se mají vrátit. Platné hodnoty jsou Email, Avatar, DisplayName a ContactWithOffers.
details	query		boolean	Vrátit informace veřejného profilu, jako je zobrazované jméno, e-mailová adresa, země atd. Pokud je false, parametr withAttributes se ignoruje.
forceRefresh	query		boolean	V této verzi rozhraní API se nepoužívá.
partition	query		string	Oddíl (pojmenovaná skupina) atributů, které se mají vrátit.
withAttributes	query		boolean	Pokud je true, získá atributy (pojmenované páry klíč-hodnota libovolných dat) přidružené k profilu. Parametr oddílu musí mít také hodnotu.

Odpovědi

Name	Typ	Description
200 OK	Profile	úspěšná operace

Zabezpečení

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	Description
vso.profile	Umožňuje číst váš profil, účty, kolekce, projekty, týmy a další artefakty organizace nejvyšší úrovně.

Příklady

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
}

Definice

Name	Description
AttributeDescriptor	Identifikuje atribut s názvem a kontejnerem.
AttributesContainer	Ukládá sadu atributů pojmenovaného profilu.
CoreProfileAttribute	Atribut profilu, který má vždy hodnotu pro každý profil.
Profile	Profil uživatele.
ProfileAttribute	Pojmenovaný objekt přidružený k profilu.
ProfileState	Aktuální stav profilu.

AttributeDescriptor

Identifikuje atribut s názvem a kontejnerem.

Name	Typ	Description
attributeName	string	Název atributu
containerName	string	Kontejner, ve kterém se atribut nachází.

AttributesContainer

Ukládá sadu atributů pojmenovaného profilu.

Name	Typ	Description
attributes	<string, ProfileAttribute>	Atributy uložené kontejnerem.
containerName	string	Název kontejneru.
revision	integer	Maximální počet revizí libovolného atributu v kontejneru.

CoreProfileAttribute

Atribut profilu, který má vždy hodnotu pro každý profil.

Name	Typ	Description
descriptor	AttributeDescriptor	Popisovač atributu.
revision	integer	Číslo revize atributu.
timeStamp	string	Čas poslední změny atributu
value	string	Hodnota atributu.

Profile

Profil uživatele.

Name	Typ	Description
applicationContainer	AttributesContainer	Atributy tohoto profilu.
coreAttributes	<string, CoreProfileAttribute>	Základní atributy tohoto profilu.
coreRevision	integer	Maximální číslo revize libovolného atributu.
id	string	Jedinečný identifikátor profilu.
profileState	ProfileState	Aktuální stav profilu.
revision	integer	Maximální číslo revize libovolného atributu.
timeStamp	string	Čas, kdy byl tento profil naposledy změněn.

ProfileAttribute

Pojmenovaný objekt přidružený k profilu.

Name	Typ	Description
descriptor	AttributeDescriptor	Popisovač atributu.
revision	integer	Číslo revize atributu.
timeStamp	string	Čas poslední změny atributu
value	string	Hodnota atributu.

ProfileState

Aktuální stav profilu.

Name	Typ	Description
custom	string	Profil se používá.
customReadOnly	string	Profil se používá, ale dá se jenom číst.
readOnly	string	Profil je možné pouze číst.

Sdílet prostřednictvím