Поделиться через


Accounts - List

Получение списка учетных записей для определенного владельца или определенного участника. Требуется один из следующих параметров: ownerId, memberId.

GET https://app.vssps.visualstudio.com/_apis/accounts?api-version=7.1-preview.1
GET https://app.vssps.visualstudio.com/_apis/accounts?ownerId={ownerId}&memberId={memberId}&properties={properties}&api-version=7.1-preview.1

Параметры URI

Имя В Обязательно Тип Описание
api-version
query True

string

Используемая версия API. Для использования этой версии API необходимо задать значение 7.1-preview.1.

memberId
query

string

uuid

Идентификатор участника учетных записей.

ownerId
query

string

uuid

Идентификатор владельца учетных записей.

properties
query

string

Ответы

Имя Тип Описание
200 OK

Account[]

успешная операция

Безопасность

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 Предоставляет возможность читать профиль, учетные записи, коллекции, проекты, команды и другие артефакты организации верхнего уровня.

Примеры

By member
By owner

By member

Sample Request

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

Sample Response

{
  "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

Sample Request

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

Sample Response

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

Определения

Имя Описание
Account
AccountStatus

Состояние текущей учетной записи

AccountType

Тип учетной записи: Личная, Организация

PropertiesCollection

Класс представляет контейнер свойств в виде коллекции пар "ключ-значение". Принимаются значения всех примитивных типов (любой TypeCode != TypeCode.Objectтип с ), кроме DBNull . Значения типа Byte[], Int32, Double, DateType и String сохраняют свой тип, другие примитивы перенастраиваются как String. Byte[] ожидается как строка в кодировке Base64.

Account

Имя Тип Описание
accountId

string

Идентификатор учетной записи

accountName

string

Имя учетной записи

accountOwner

string

Владелец учетной записи

accountStatus

AccountStatus

Состояние текущей учетной записи

accountType

AccountType

Тип учетной записи: Личная, Организация

accountUri

string

Универсальный код ресурса (URI) для учетной записи

createdBy

string

Кто создал учетную запись

createdDate

string

Дата создания учетной записи

hasMoved

boolean

lastUpdatedBy

string

Удостоверение последнего пользователя для обновления учетной записи

lastUpdatedDate

string

Дата последнего обновления учетной записи

namespaceId

string

Пространство имен для учетной записи

newCollectionId

string

organizationName

string

Организация, создающая учетную запись

properties

PropertiesCollection

Расширенные свойства

statusReason

string

Причина текущего состояния

AccountStatus

Состояние текущей учетной записи

Имя Тип Описание
deleted

string

Эта учетная запись входит в пакет удаления и планируется к удалению.

disabled

string

Эта учетная запись размещения отключена.

enabled

string

Эта учетная запись размещения активна и назначена клиенту.

moved

string

Эта учетная запись не используется локально и физически перемещена.

none

string

AccountType

Тип учетной записи: Личная, Организация

Имя Тип Описание
organization

string

personal

string

PropertiesCollection

Класс представляет контейнер свойств в виде коллекции пар "ключ-значение". Принимаются значения всех примитивных типов (любой TypeCode != TypeCode.Objectтип с ), кроме DBNull . Значения типа Byte[], Int32, Double, DateType и String сохраняют свой тип, другие примитивы перенастраиваются как String. Byte[] ожидается как строка в кодировке Base64.

Имя Тип Описание
count

integer

Количество свойств в коллекции.

item

object

keys

string[]

Набор ключей в коллекции.

values

string[]

Набор значений в коллекции.