通过

Accounts - List

  • 参考
服务:
Accounts
API 版本:
7.1

获取特定所有者或特定成员的帐户列表。 以下参数之一是必需的：ownerId、memberId。

GET https://app.vssps.visualstudio.com/_apis/accounts?api-version=7.1
具有可选参数: 
GET https://app.vssps.visualstudio.com/_apis/accounts?ownerId={ownerId}&memberId={memberId}&properties={properties}&api-version=7.1

URI 参数

名称 在 必需 类型 说明
api-version
 query True

string

要使用的 API 版本。 这应设置为“7.1”才能使用此版本的 API。
memberId
 query

string (uuid)

帐户成员的 ID。
ownerId
 query

string (uuid)

帐户所有者的 ID。
properties
 query

string

响应

名称 类型 说明
200 OK

Account[]

成功作

安全性

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 授予读取配置文件、帐户、集合、项目、团队和其他顶级组织项目的能力。

示例

By member
By owner

By member

示例请求

GET https://app.vssps.visualstudio.com/_apis/accounts?memberId=d6245f20-2af8-44f4-9451-8107cb2767db&api-version=7.1

示例响应

状态代码:
200 
{
  "count": 2,
  "value": [
    {
      "accountId": "6affcbef-fe5d-44c6-8a29-439b79aaa118",
      "accountUri": "https://vssps.dev.azure.com/Fabrikam-Fiber-Inc/",
      "accountName": "Fabrikam-Fiber-Inc",
      "properties": {}
    },
    {
      "accountId": "bf83696f-383b-4980-95b5-1f1127640a8a",
      "accountUri": "https://vssps.dev.azure.com/NormalPaulk/",
      "accountName": "NormalPaulk",
      "properties": {}
    }
  ]
}

By owner

示例请求

GET https://app.vssps.visualstudio.com/_apis/accounts?ownerId=d6245f20-2af8-44f4-9451-8107cb2767db&api-version=7.1

示例响应

状态代码:
200 
{
  "count": 1,
  "value": [
    {
      "accountId": "bf83696f-383b-4980-95b5-1f1127640a8a",
      "accountUri": "https://NormalPaulk.vssps.visualstudio.com:443/",
      "accountName": "NormalPaulk",
      "properties": {}
    }
  ]
}

定义

名称 说明
Account
AccountStatus

当前帐户状态
AccountType

帐户类型：个人、组织
PropertiesCollection

类将属性包表示为键值对的集合。 接受除 DBNull 以外的所有基元类型（具有 TypeCode != TypeCode.Object的任何类型）的值。 Byte[]、Int32、Double、DateType 和 String 类型的值将保留其类型，其他基元将重新调整为 String。 Byte[] 应为 base64 编码字符串。

Account

Object
名称 类型 说明
accountId

string (uuid)

帐户的标识符
accountName

string

帐户的名称
accountOwner

string (uuid)

帐户所有者
accountStatus

AccountStatus

当前帐户状态
accountType

AccountType

帐户类型：个人、组织
accountUri

string

帐户的 URI
createdBy

string (uuid)

创建帐户的人员
createdDate

string (date-time)

创建日期帐户
hasMoved

boolean

lastUpdatedBy

string (uuid)

要更新帐户的最后一个人的身份
lastUpdatedDate

string (date-time)

上次更新日期帐户
namespaceId

string (uuid)

帐户的命名空间
newCollectionId

string (uuid)

organizationName

string

创建帐户的组织
properties

PropertiesCollection

扩展属性
statusReason

string

当前状态的原因

AccountStatus

枚举

当前帐户状态

值 说明
deleted

此帐户是删除批处理的一部分，并计划进行删除。
disabled

此托管帐户已禁用。
enabled

此托管帐户处于活动状态，并分配给客户。
moved

此帐户未在本地掌握，并且已实际移动。
none

AccountType

枚举

帐户类型：个人、组织

值 说明
organization
personal

PropertiesCollection

Object

类将属性包表示为键值对的集合。 接受除 DBNull 以外的所有基元类型（具有 TypeCode != TypeCode.Object的任何类型）的值。 Byte[]、Int32、Double、DateType 和 String 类型的值将保留其类型，其他基元将重新调整为 String。 Byte[] 应为 base64 编码字符串。

名称 类型 说明
count

integer (int32)

集合中的属性计数。
item

object

keys

string[]

集合中的键集。
values

string[]

集合中的值集。