Profiles - Get

服务:

Profile

API 版本:

7.1

获取用户配置文件。

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

具有可选参数:

GET https://app.vssps.visualstudio.com/_apis/profile/profiles/{id}?details={details}&withAttributes={withAttributes}&partition={partition}&coreAttributes={coreAttributes}&forceRefresh={forceRefresh}&api-version=7.1

URI 参数

名称	在	必需	类型	说明
id	path	True	string	同一组织中的目标用户配置文件的 ID，或“me”以获取当前经过身份验证的用户的配置文件。
api-version	query	True	string	要使用的 API 版本。 这应设置为“7.1”才能使用此版本的 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

类型: oauth2
流向: accessCode
授权 URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
令牌 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

作用域

名称	说明
vso.profile	授予读取配置文件、帐户、集合、项目、团队和其他顶级组织项目的能力。

示例

示例请求

HTTP

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

示例响应

状态代码:

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

Object

标识具有名称和容器的属性。

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

AttributesContainer

Object

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

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

CoreProfileAttribute

Object

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

名称	类型	说明
descriptor	AttributeDescriptor	特性的描述符。
revision	integer (int32)	特性的修订号。
timeStamp	string (date-time)	上次更改属性的时间。
value	string (T)	特性的值。

Profile

Object

用户配置文件。

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

ProfileAttribute

Object

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

名称	类型	说明
descriptor	AttributeDescriptor	特性的描述符。
revision	integer (int32)	特性的修订号。
timeStamp	string (date-time)	上次更改属性的时间。
value	string (T)	特性的值。

ProfileState

枚举

配置文件的当前状态。

值	说明
custom	配置文件正在使用中。
customReadOnly	配置文件正在使用中，但只能读取。
readOnly	配置文件只能读取。