Teams - Get Teams

  • Ссылка
Service:
Core
API Version:
7.1-preview.3

Получение списка команд.

GET https://dev.azure.com/{organization}/_apis/projects/{projectId}/teams?api-version=7.1-preview.3
With optional parameters: 
GET https://dev.azure.com/{organization}/_apis/projects/{projectId}/teams?$mine={$mine}&$top={$top}&$skip={$skip}&$expandIdentity={$expandIdentity}&api-version=7.1-preview.3

Параметры URI

Имя В Обязательно Тип Описание
organization
 path True

string

Название организации Azure DevOps.
projectId
 path True

string

api-version
 query True

string

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

boolean

Значение, указывающее, следует ли развернуть сведения об удостоверениях в результирующем объекте WebApiTeam.
$mine
 query

boolean

Если значение true, возвращает все команды, запрашивающие пользователя, являются участниками, в противном случае возвращается все пользователи teams, у которого есть доступ на чтение.
$skip
 query

integer

int32

Количество команд, которые нужно пропустить.
$top
 query

integer

int32

Максимальное количество команд для возвращения.

Ответы

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

WebApiTeam[]

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

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

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

Примеры

Sample Request

GET https://dev.azure.com/fabrikam/_apis/projects/eb6e4656-77fc-42a1-9181-4c6d8e9da5d1/teams?api-version=7.1-preview.3

Sample Response

Status code:
200 
{
  "value": [
    {
      "id": "564e8204-a90b-4432-883b-d4363c6125ca",
      "name": "Quality assurance",
      "url": "https://dev.azure.com/fabrikam/_apis/projects/eb6e4656-77fc-42a1-9181-4c6d8e9da5d1/teams/564e8204-a90b-4432-883b-d4363c6125ca",
      "description": "Testing staff",
      "identityUrl": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/564e8204-a90b-4432-883b-d4363c6125ca"
    },
    {
      "id": "66df9be7-3586-467b-9c5f-425b29afedfd",
      "name": "Fabrikam-Fiber-TFVC Team",
      "url": "https://dev.azure.com/fabrikam/_apis/projects/eb6e4656-77fc-42a1-9181-4c6d8e9da5d1/teams/66df9be7-3586-467b-9c5f-425b29afedfd",
      "description": "The default project team.",
      "identityUrl": "https://vssps.dev.azure.com/fabrikam/_apis/Identities/66df9be7-3586-467b-9c5f-425b29afedfd"
    }
  ],
  "count": 2
}

Определения

Имя Описание
Identity
IdentityDescriptor

Дескриптор удостоверения — это оболочка для типа удостоверения (Идентификатор безопасности Windows, Passport) вместе с уникальным идентификатором, таким как SID или PUID.
PropertiesCollection

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

Identity

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

string

Настраиваемое отображаемое имя для удостоверения (если оно есть). Если задать для этого свойства пустую строку, существующее пользовательское отображаемое имя будет очищено. Присвоение этому свойству значения NULL не повлияет на существующее сохраненное значение (так как значения NULL не отправляются по сети или в базу данных).
descriptor

IdentityDescriptor

Дескриптор удостоверения — это оболочка для типа удостоверения (Идентификатор безопасности Windows, Passport) вместе с уникальным идентификатором, таким как SID или PUID.
id

string

Идентификатор удостоверения. Также называется ключом хранилища или VSID.
isActive

boolean

Значение true, если удостоверение является членом любой группы Azure Devops в организации.
isContainer

boolean

Значение true, если удостоверение является группой.
masterId

string

memberIds

string[]

Идентификатор членов удостоверения (только для групп).
memberOf

IdentityDescriptor[]

Дескриптор удостоверения — это оболочка для типа удостоверения (Идентификатор безопасности Windows, Passport) вместе с уникальным идентификатором, таким как SID или PUID.
members

IdentityDescriptor[]

Дескриптор удостоверения — это оболочка для типа удостоверения (Идентификатор безопасности Windows, Passport) вместе с уникальным идентификатором, таким как SID или PUID.
metaTypeId

integer

properties

PropertiesCollection

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

string

Отображаемое имя удостоверения, указанное поставщиком удостоверений источника.
resourceVersion

integer

socialDescriptor

string

subjectDescriptor

string

Дескриптор субъекта сущности Graph.
uniqueUserId

integer

IdentityDescriptor

Дескриптор удостоверения — это оболочка для типа удостоверения (Идентификатор безопасности Windows, Passport) вместе с уникальным идентификатором, таким как SID или PUID.

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

string

Уникальный идентификатор для этого удостоверения, не превышающий 256 символов, который будет сохранен.
identityType

string

Тип дескриптора (например, Windows, Passport и т. д.).

PropertiesCollection

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

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

integer

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

object

keys

string[]

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

string[]

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

WebApiTeam

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

string

Описание команды
id

string

Guid команды (удостоверение). Идентификатор Team Foundation.
identity

Identity

Удостоверение команды.
identityUrl

string

URL-адрес REST API удостоверений для этой команды
name

string

Имя команды
projectId

string

projectName

string

url

string

URL-адрес REST API для команды