Condividi tramite


Profiles - Get

Ottiene un profilo utente.

GET https://app.vssps.visualstudio.com/_apis/profile/profiles/{id}?api-version=7.1-preview.3
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

Parametri dell'URI

Nome In Necessario Tipo Descrizione
id
path True

string

ID del profilo utente di destinazione all'interno della stessa organizzazione o "me" per ottenere il profilo dell'utente autenticato corrente.

api-version
query True

string

Versione dell'API da usare. Deve essere impostato su '7.1-preview.3' per usare questa versione dell'API.

coreAttributes
query

string

Elenco delimitato da virgole di attributi del profilo di base da restituire. I valori validi sono Email, Avatar, DisplayName e ContactWithOffers.

details
query

boolean

Restituisce informazioni sul profilo pubblico, ad esempio nome visualizzato, indirizzo di posta elettronica, paese e così via. Se false, il parametro withAttributes viene ignorato.

forceRefresh
query

boolean

Non usato in questa versione dell'API.

partition
query

string

Partizione (gruppo denominato) di attributi da restituire.

withAttributes
query

boolean

Se true, ottiene gli attributi (coppie chiave-valore denominate di dati arbitrari) associati al profilo. Anche il parametro di partizione deve avere un valore.

Risposte

Nome Tipo Descrizione
200 OK

Profile

operazione riuscita

Sicurezza

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

Nome Descrizione
vso.profile Concede la possibilità di leggere il profilo, gli account, le raccolte, i progetti, i team e altri artefatti dell'organizzazione di primo livello.

Esempio

Sample Request

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

Sample Response

{
  "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
}

Definizioni

Nome Descrizione
AttributeDescriptor

Identifica un attributo con un nome e un contenitore.

AttributesContainer

Archivia un set di attributi di profilo denominati.

CoreProfileAttribute

Attributo del profilo che ha sempre un valore per ogni profilo.

Profile

Un profilo utente.

ProfileAttribute

Oggetto denominato associato a un profilo.

ProfileState

Stato corrente del profilo.

AttributeDescriptor

Identifica un attributo con un nome e un contenitore.

Nome Tipo Descrizione
attributeName

string

Nome dell'attributo.

containerName

string

Il contenitore in cui risiede l'attributo .

AttributesContainer

Archivia un set di attributi di profilo denominati.

Nome Tipo Descrizione
attributes

<string,  ProfileAttribute>

Attributi archiviati dal contenitore.

containerName

string

Nome del contenitore.

revision

integer

Numero massimo di revisione di qualsiasi attributo all'interno del contenitore.

CoreProfileAttribute

Attributo del profilo che ha sempre un valore per ogni profilo.

Nome Tipo Descrizione
descriptor

AttributeDescriptor

Descrittore dell'attributo.

revision

integer

Numero di revisione dell'attributo.

timeStamp

string

Ora dell'ultima modifica dell'attributo.

value

string

Valore dell'attributo.

Profile

Un profilo utente.

Nome Tipo Descrizione
applicationContainer

AttributesContainer

Attributi di questo profilo.

coreAttributes

<string,  CoreProfileAttribute>

Attributi principali di questo profilo.

coreRevision

integer

Numero massimo di revisione di qualsiasi attributo.

id

string

Identificatore univoco del profilo.

profileState

ProfileState

Stato corrente del profilo.

revision

integer

Numero massimo di revisione di qualsiasi attributo.

timeStamp

string

Ora dell'ultima modifica del profilo.

ProfileAttribute

Oggetto denominato associato a un profilo.

Nome Tipo Descrizione
descriptor

AttributeDescriptor

Descrittore dell'attributo.

revision

integer

Numero di revisione dell'attributo.

timeStamp

string

Ora dell'ultima modifica dell'attributo.

value

string

Valore dell'attributo.

ProfileState

Stato corrente del profilo.

Nome Tipo Descrizione
custom

string

Il profilo è in uso.

customReadOnly

string

Il profilo è in uso, ma può essere letto solo.

readOnly

string

Il profilo può essere letto solo.