Teams - Get All Teams
すべてのチームの一覧を取得します。
GET https://dev.azure.com/{organization}/_apis/teams?api-version=7.1-preview.3
GET https://dev.azure.com/{organization}/_apis/teams?$mine={$mine}&$top={$top}&$skip={$skip}&$expandIdentity={$expandIdentity}&api-version=7.1-preview.3
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
organization
|
path | True |
string |
Azure DevOps 組織の名前です。 |
api-version
|
query | True |
string |
使う API のバージョン。 このバージョンの API を使用するには、これを '7.1-preview.3' に設定する必要があります。 |
$expand
|
query |
boolean |
結果 WebApiTeam オブジェクトの ID 情報を展開するかどうかを示す値。 |
|
$mine
|
query |
boolean |
true の場合は、ユーザーがメンバーであることを要求しているすべてのチームを返します。 それ以外の場合は、すべてのチーム ユーザーが読み取りアクセス権を持っているを返します。 |
|
$skip
|
query |
integer int32 |
スキップするチームの数。 |
|
$top
|
query |
integer int32 |
返されるチームの最大数。 |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
正常な操作 |
セキュリティ
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.project | プロジェクトとチームを読み取る機能を付与します。 |
例
Sample Request
GET https://dev.azure.com/fabrikam/_apis/teams?$mine=True&api-version=7.1-preview.3
Sample Response
{
"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 | |
Identity |
ID 記述子は、ID の種類 (Windows SID、Passport) のラッパーであり、SID や PUID などの一意の識別子です。 |
Properties |
クラスは、キーと値のペアのコレクションとしてプロパティ バッグを表します。 を除くすべてのプリミティブ型 (を持つ任意の |
Web |
Identity
名前 | 型 | 説明 |
---|---|---|
customDisplayName |
string |
ID のカスタム表示名 (存在する場合)。 このプロパティを空の文字列に設定すると、既存のカスタム表示名がクリアされます。 このプロパティを null に設定しても、既存の永続化された値には影響しません (null 値はネットワーク経由またはデータベースに送信されないため) |
descriptor |
ID 記述子は、ID の種類 (Windows SID、Passport) のラッパーであり、SID や PUID などの一意の識別子です。 |
|
id |
string |
ID 識別子。 ストレージ キー (VSID) とも呼ばれます |
isActive |
boolean |
true の ID が、organization内の任意の Azure Devops グループのメンバーシップを持っている場合です。 |
isContainer |
boolean |
TRUE の場合、ID がグループです。 |
masterId |
string |
|
memberIds |
string[] |
ID のメンバーの ID (グループのみ)。 |
memberOf |
ID 記述子は、ID の種類 (Windows SID、Passport) のラッパーであり、SID や PUID などの一意の識別子です。 |
|
members |
ID 記述子は、ID の種類 (Windows SID、Passport) のラッパーであり、SID や PUID などの一意の識別子です。 |
|
metaTypeId |
integer |
|
properties |
クラスは、キーと値のペアのコレクションとしてプロパティ バッグを表します。 を除くすべてのプリミティブ型 (を持つ任意の |
|
providerDisplayName |
string |
ソース ID プロバイダーによって指定された ID の表示名。 |
resourceVersion |
integer |
|
socialDescriptor |
string |
|
subjectDescriptor |
string |
Graph エンティティのサブジェクト記述子。 |
uniqueUserId |
integer |
IdentityDescriptor
ID 記述子は、ID の種類 (Windows SID、Passport) のラッパーであり、SID や PUID などの一意の識別子です。
名前 | 型 | 説明 |
---|---|---|
identifier |
string |
この ID の一意識別子 。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 |
チーム (ID) Guid。 Team Foundation ID。 |
identity |
チーム ID。 |
|
identityUrl |
string |
このチームの ID REST API URL |
name |
string |
チーム名 |
projectId |
string |
|
projectName |
string |
|
url |
string |
Team REST API Url |