Profiles - Get

Service:

Profile

API Version:

7.1-preview.3

Obtiene un perfil de usuario.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
id	path	True	string	Identificador del perfil de usuario de destino dentro de la misma organización o "me" para obtener el perfil del usuario autenticado actual.
api-version	query	True	string	Versión de la API que se va a usar. Debe establecerse en "7.1-preview.3" para usar esta versión de la API.
coreAttributes	query		string	Lista delimitada por comas de atributos de perfil principales que se van a devolver. Los valores válidos son Email, Avatar, DisplayName y ContactWithOffers.
details	query		boolean	Devolver información de perfil público, como el nombre para mostrar, la dirección de correo electrónico, el país, etc. Si es false, se omite el parámetro withAttributes.
forceRefresh	query		boolean	No se usa en esta versión de la API.
partition	query		string	Partición (grupo con nombre) de atributos que se van a devolver.
withAttributes	query		boolean	Si es true, obtiene los atributos (pares clave-valor con nombre de datos arbitrarios) asociados al perfil. El parámetro de partición también debe tener un valor.

Respuestas

Nombre	Tipo	Description
200 OK	Profile	operación correcta

Seguridad

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

Nombre	Description
vso.profile	Concede la capacidad de leer el perfil, las cuentas, las colecciones, los proyectos, los equipos y otros artefactos organizativos de nivel superior.

Ejemplos

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
}

Definiciones

Nombre	Description
AttributeDescriptor	Identifica un atributo con un nombre y un contenedor.
AttributesContainer	Almacena un conjunto de atributos de perfil con nombre.
CoreProfileAttribute	Atributo de perfil que siempre tiene un valor para cada perfil.
Profile	Un perfil de usuario.
ProfileAttribute	Objeto con nombre asociado a un perfil.
ProfileState	Estado actual del perfil.

AttributeDescriptor

Identifica un atributo con un nombre y un contenedor.

Nombre	Tipo	Description
attributeName	string	El nombre del atributo.
containerName	string	Contenedor en el que reside el atributo.

AttributesContainer

Almacena un conjunto de atributos de perfil con nombre.

Nombre	Tipo	Description
attributes	<string,  ProfileAttribute>	Atributos almacenados por el contenedor.
containerName	string	nombre del contenedor.
revision	integer	Número de revisión máximo de cualquier atributo dentro del contenedor.

CoreProfileAttribute

Atributo de perfil que siempre tiene un valor para cada perfil.

Nombre	Tipo	Description
descriptor	AttributeDescriptor	Descriptor del atributo.
revision	integer	Número de revisión del atributo.
timeStamp	string	Hora en que se cambió el atributo por última vez.
value	string	El valor del atributo.

Profile

Un perfil de usuario.

Nombre	Tipo	Description
applicationContainer	AttributesContainer	Atributos de este perfil.
coreAttributes	<string,  CoreProfileAttribute>	Atributos principales de este perfil.
coreRevision	integer	Número de revisión máximo de cualquier atributo.
id	string	Identificador único del perfil.
profileState	ProfileState	Estado actual del perfil.
revision	integer	Número de revisión máximo de cualquier atributo.
timeStamp	string	Hora en la que se cambió por última vez este perfil.

ProfileAttribute

Objeto con nombre asociado a un perfil.

Nombre	Tipo	Description
descriptor	AttributeDescriptor	Descriptor del atributo.
revision	integer	Número de revisión del atributo.
timeStamp	string	Hora en que se cambió el atributo por última vez.
value	string	El valor del atributo.

ProfileState

Estado actual del perfil.

Nombre	Tipo	Description
custom	string	El perfil está en uso.
customReadOnly	string	El perfil está en uso, pero solo se puede leer.
readOnly	string	El perfil solo se puede leer.