Profiles - Get

Referência

Service:: Profile

API Version:: 7.1-preview.3

Obtém um perfil de usuário.

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 URI

Nome	Em	Obrigatório	Tipo	Description
id	path	True	string	A ID do perfil de usuário de destino dentro da mesma organização ou "eu" para obter o perfil do usuário autenticado atual.
api-version	query	True	string	Versão da API a ser usada. Isso deve ser definido como '7.1-preview.3' para usar essa versão da API.
coreAttributes	query		string	Uma lista delimitada por vírgulas de atributos de perfil principais a serem retornados. Os valores válidos são Email, Avatar, DisplayName e ContactWithOffers.
details	query		boolean	Retornar informações de perfil público, como nome de exibição, endereço de email, país etc. Se false, o parâmetro withAttributes será ignorado.
forceRefresh	query		boolean	Não usado nesta versão da API.
partition	query		string	A partição (grupo nomeado) de atributos a serem retornados.
withAttributes	query		boolean	Se true, obtém os atributos (pares chave-valor nomeados de dados arbitrários) associados ao perfil. O parâmetro de partição também deve ter um valor .

Respostas

Nome	Tipo	Description
200 OK	Profile	operação bem-sucedida

Segurança

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	Description
vso.profile	Concede a capacidade de ler seu perfil, contas, coleções, projetos, equipes e outros artefatos organizacionais de nível superior.

Exemplos

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
}

Definições

Nome	Description
AttributeDescriptor	Identifica um atributo com um nome e um contêiner.
AttributesContainer	Armazena um conjunto de atributos de perfil nomeados.
CoreProfileAttribute	Um atributo de perfil que sempre tem um valor para cada perfil.
Profile	Um perfil de usuário.
ProfileAttribute	Um objeto nomeado associado a um perfil.
ProfileState	O estado atual do perfil.

AttributeDescriptor

Identifica um atributo com um nome e um contêiner.

Nome	Tipo	Description
attributeName	string	O nome do atributo.
containerName	string	O contêiner no qual o atributo reside.

AttributesContainer

Armazena um conjunto de atributos de perfil nomeados.

Nome	Tipo	Description
attributes	<string, ProfileAttribute>	Os atributos armazenados pelo contêiner.
containerName	string	É o nome do contêiner.
revision	integer	O número máximo de revisão de qualquer atributo dentro do contêiner.

CoreProfileAttribute

Um atributo de perfil que sempre tem um valor para cada perfil.

Nome	Tipo	Description
descriptor	AttributeDescriptor	O descritor do atributo.
revision	integer	O número de revisão do atributo.
timeStamp	string	A hora em que o atributo foi alterado pela última vez.
value	string	O valor do atributo.

Profile

Um perfil de usuário.

Nome	Tipo	Description
applicationContainer	AttributesContainer	Os atributos desse perfil.
coreAttributes	<string, CoreProfileAttribute>	Os atributos principais desse perfil.
coreRevision	integer	O número máximo de revisão de qualquer atributo.
id	string	O identificador exclusivo do perfil.
profileState	ProfileState	O estado atual do perfil.
revision	integer	O número máximo de revisão de qualquer atributo.
timeStamp	string	A hora em que esse perfil foi alterado pela última vez.

ProfileAttribute

Um objeto nomeado associado a um perfil.

Nome	Tipo	Description
descriptor	AttributeDescriptor	O descritor do atributo.
revision	integer	O número de revisão do atributo.
timeStamp	string	A hora em que o atributo foi alterado pela última vez.
value	string	O valor do atributo.

ProfileState

O estado atual do perfil.

Nome	Tipo	Description
custom	string	O perfil está em uso.
customReadOnly	string	O perfil está em uso, mas só pode ser lido.
readOnly	string	O perfil só pode ser lido.

Compartilhar via