Profiles - Get

参考

Service:: Profile

API Version:: 7.1-preview.3

获取用户配置文件。

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

URI 参数

名称	在	必需	类型	说明
id	path	True	string	同一组织内目标用户配置文件的 ID，或“me”，用于获取当前经过身份验证的用户的配置文件。
api-version	query	True	string	要使用的 API 版本。这应设置为“7.1-preview.3”才能使用此版本的 API。
coreAttributes	query		string	要返回的核心配置文件属性的逗号分隔列表。有效值为 Email、Avatar、DisplayName 和 ContactWithOffers。
details	query		boolean	返回公共配置文件信息，例如显示名称、电子邮件地址、国家/地区等。如果为 false，则忽略 withAttributes 参数。
forceRefresh	query		boolean	此版本的 API 中未使用。
partition	query		string	分区 (命名组) 要返回的属性。
withAttributes	query		boolean	如果为 true，则获取 (与配置文件关联的任意数据) 的命名键值对的属性。分区参数还必须具有值。

响应

名称	类型	说明
200 OK	Profile	成功的操作

安全性

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

名称	说明
vso.profile	授予读取个人资料、帐户、集合、项目、团队和其他顶级组织项目的能力。

示例

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
}

定义

名称	说明
AttributeDescriptor	使用名称和容器标识属性。
AttributesContainer	存储一组命名配置文件属性。
CoreProfileAttribute	配置文件属性，它始终具有每个配置文件的值。
Profile	用户配置文件。
ProfileAttribute	与配置文件关联的命名对象。
ProfileState	配置文件的当前状态。

AttributeDescriptor

使用名称和容器标识属性。

名称	类型	说明
attributeName	string	属性名。
containerName	string	属性所在的容器。

AttributesContainer

存储一组命名配置文件属性。

名称	类型	说明
attributes	<string, ProfileAttribute>	容器存储的属性。
containerName	string	容器的名称。
revision	integer	容器中任何属性的最大修订号。

CoreProfileAttribute

配置文件属性，它始终具有每个配置文件的值。

名称	类型	说明
descriptor	AttributeDescriptor	属性的描述符。
revision	integer	属性的修订号。
timeStamp	string	上次更改属性的时间。
value	string	属性的值。

Profile

用户配置文件。

名称	类型	说明
applicationContainer	AttributesContainer	此配置文件的属性。
coreAttributes	<string, CoreProfileAttribute>	此配置文件的核心属性。
coreRevision	integer	任何属性的最大修订号。
id	string	配置文件的唯一标识符。
profileState	ProfileState	配置文件的当前状态。
revision	integer	任何属性的最大修订号。
timeStamp	string	上次更改此配置文件的时间。

ProfileAttribute

与配置文件关联的命名对象。

名称	类型	说明
descriptor	AttributeDescriptor	属性的描述符。
revision	integer	属性的修订号。
timeStamp	string	上次更改属性的时间。
value	string	属性的值。

ProfileState

配置文件的当前状态。

名称	类型	说明
custom	string	配置文件正在使用中。
customReadOnly	string	配置文件正在使用中，但只能读取。
readOnly	string	只能读取配置文件。

通过