Freigeben über


Teams - Get Teams

Dient zum Abrufen einer Liste von Teams.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
organization
path True

string

Der Name der Azure DevOps-Organisation.

projectId
path True

string

api-version
query True

string

Version der zu verwendenden API. Dies sollte auf "7.1" festgelegt werden, um diese Version der API zu verwenden.

$expandIdentity
query

boolean

Ein Wert, der angibt, ob Identitätsinformationen im WebApiTeam-Ergebnisobjekt erweitert werden sollen.

$mine
query

boolean

Wenn "true" alle Teams zurückgibt, die den Benutzer anfordern, Mitglied ist, andernfalls wird der Lesezugriff für alle Teams-Benutzer zurückgegeben.

$skip
query

integer (int32)

Anzahl der teams, die übersprungen werden sollen.

$top
query

integer (int32)

Maximale Anzahl von Teams, die zurückgegeben werden sollen.

Antworten

Name Typ Beschreibung
200 OK

WebApiTeam[]

Erfolgreicher Vorgang

Sicherheit

oauth2

Typ: oauth2
Ablauf: accessCode
Autorisierungs-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

Bereiche

Name Beschreibung
vso.profile Gewährt die Möglichkeit, Ihr Profil, Konten, Sammlungen, Projekte, Teams und andere Organisationsartefakte auf oberster Ebene zu lesen.
vso.project Gewährt die Möglichkeit, Projekte und Teams zu lesen.

Beispiele

Beispielanforderung

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

Beispiel für eine Antwort

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

Definitionen

Name Beschreibung
Identity
IdentityDescriptor

Ein Identitätsdeskriptor ist ein Wrapper für den Identitätstyp (Windows SID, Passport) und einen eindeutigen Bezeichner wie die SID oder PUID.

PropertiesCollection

Die Klasse stellt einen Eigenschaftenbehälter als Sammlung von Schlüsselwertpaaren dar. Werte aller Grundtypen (beliebiger Typ mit einem TypeCode != TypeCode.Object) mit Ausnahme von DBNull werden akzeptiert. Werte vom Typ Byte[], Int32, Double, DateType und String behalten ihren Typ bei, andere Grundtypen werden als Zeichenfolge neu abgestimmt. Byte[] als base64-codierte Zeichenfolge erwartet.

WebApiTeam

Identity

Name Typ Beschreibung
customDisplayName

string

Der benutzerdefinierte Anzeigename für die Identität (falls vorhanden). Wenn Sie diese Eigenschaft auf eine leere Zeichenfolge festlegen, wird der vorhandene benutzerdefinierte Anzeigename gelöscht. Das Festlegen dieser Eigenschaft auf NULL wirkt sich nicht auf den vorhandenen dauerhaften Wert aus (da NULL-Werte nicht über die Verbindung oder an die Datenbank gesendet werden)

descriptor

IdentityDescriptor

Ein Identitätsdeskriptor ist ein Wrapper für den Identitätstyp (Windows SID, Passport) und einen eindeutigen Bezeichner wie die SID oder PUID.

id

string (uuid)

Identitätsbezeichner. Auch als Speicherschlüssel oder VSID bezeichnet

isActive

boolean

True, wenn die Identität eine Mitgliedschaft in einer beliebigen Azure Devops-Gruppe in der Organisation hat.

isContainer

boolean

True, wenn die Identität eine Gruppe ist.

masterId

string (uuid)

memberIds

string[] (uuid)

ID der Mitglieder der Identität (nur Gruppen).

memberOf

IdentityDescriptor[]

Ein Identitätsdeskriptor ist ein Wrapper für den Identitätstyp (Windows SID, Passport) und einen eindeutigen Bezeichner wie die SID oder PUID.

members

IdentityDescriptor[]

Ein Identitätsdeskriptor ist ein Wrapper für den Identitätstyp (Windows SID, Passport) und einen eindeutigen Bezeichner wie die SID oder PUID.

metaTypeId

integer (int32)

properties

PropertiesCollection

Die Klasse stellt einen Eigenschaftenbehälter als Sammlung von Schlüsselwertpaaren dar. Werte aller Grundtypen (beliebiger Typ mit einem TypeCode != TypeCode.Object) mit Ausnahme von DBNull werden akzeptiert. Werte vom Typ Byte[], Int32, Double, DateType und String behalten ihren Typ bei, andere Grundtypen werden als Zeichenfolge neu abgestimmt. Byte[] als base64-codierte Zeichenfolge erwartet.

providerDisplayName

string

Der Anzeigename für die Identität, wie vom Quellidentitätsanbieter angegeben.

resourceVersion

integer (int32)

socialDescriptor

string

subjectDescriptor

string

Betreffdeskriptor einer Graph-Entität.

uniqueUserId

integer (int32)

IdentityDescriptor

Ein Identitätsdeskriptor ist ein Wrapper für den Identitätstyp (Windows SID, Passport) und einen eindeutigen Bezeichner wie die SID oder PUID.

Name Typ Beschreibung
identifier

string

Der eindeutige Bezeichner für diese Identität, nicht mehr als 256 Zeichen, die beibehalten werden.

identityType

string

Typ des Deskriptors (z. B. Windows, Passport usw.).

PropertiesCollection

Die Klasse stellt einen Eigenschaftenbehälter als Sammlung von Schlüsselwertpaaren dar. Werte aller Grundtypen (beliebiger Typ mit einem TypeCode != TypeCode.Object) mit Ausnahme von DBNull werden akzeptiert. Werte vom Typ Byte[], Int32, Double, DateType und String behalten ihren Typ bei, andere Grundtypen werden als Zeichenfolge neu abgestimmt. Byte[] als base64-codierte Zeichenfolge erwartet.

Name Typ Beschreibung
count

integer (int32)

Die Anzahl der Eigenschaften in der Auflistung.

item

object

keys

string[]

Der Satz von Schlüsseln in der Auflistung.

values

string[]

Der Wertesatz in der Auflistung.

WebApiTeam

Name Typ Beschreibung
description

string

Teambeschreibung

id

string (uuid)

Team-GUID. Eine Team Foundation-ID.

identity

Identity

Teamidentität.

identityUrl

string

ID-REST-API-URL zu diesem Team

name

string

Teamname

projectId

string (uuid)

projectName

string

url

string

Team-REST-API-URL