Accounts - List

Service:

Accounts

API Version:

7.1-preview.1

Získejte seznam účtů pro konkrétního vlastníka nebo konkrétního člena. Vyžaduje se jeden z následujících parametrů: ownerId, memberId.

GET https://app.vssps.visualstudio.com/_apis/accounts?api-version=7.1-preview.1

With optional parameters:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
api-version	query	True	string	Verze rozhraní API, která se má použít. Aby se tato verze rozhraní API používala, měla by být nastavená na 7.1-preview.1.
memberId	query		string uuid	ID člena účtů.
ownerId	query		string uuid	ID vlastníka účtů.
properties	query		string

Odpovědi

Name	Typ	Description
200 OK	Account[]	úspěšná operace

Zabezpečení

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

Name	Description
vso.profile	Umožňuje číst váš profil, účty, kolekce, projekty, týmy a další artefakty organizace nejvyšší úrovně.

Příklady

By member

By owner

By member

Sample Request

HTTP

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

Sample Response

Status code:

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

Sample Request

HTTP

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

Sample Response

Status code:

200

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

Definice

Name	Description
Account
AccountStatus	Stav aktuálního účtu
AccountType	Typ účtu: Osobní, Organizace
PropertiesCollection	Třída představuje tašku vlastností jako kolekci párů klíč-hodnota. Jsou přijímány hodnoty všech primitivních typů (libovolný typ s TypeCode != TypeCode.Objectvýjimkou DBNull ). Hodnoty typu Byte[], Int32, Double, DateType a String zachovávají svůj typ, ostatní primitivy se přelaďují jako String. Byte[] byl očekáván jako řetězec s kódováním base64.

Account

Name	Typ	Description
accountId	string	Identifikátor účtu
accountName	string	Název účtu
accountOwner	string	Vlastník účtu
accountStatus	AccountStatus	Stav aktuálního účtu
accountType	AccountType	Typ účtu: Osobní, Organizace
accountUri	string	Identifikátor URI pro účet
createdBy	string	Kdo účet vytvořil
createdDate	string	Datum vytvoření účtu
hasMoved	boolean
lastUpdatedBy	string	Identita poslední osoby, která aktualizovala účet
lastUpdatedDate	string	Datum poslední aktualizace účtu
namespaceId	string	Obor názvů pro účet
newCollectionId	string
organizationName	string	Organizace, která účet vytvořila
properties	PropertiesCollection	Rozšířené vlastnosti
statusReason	string	Důvod aktuálního stavu

AccountStatus

Stav aktuálního účtu

Name	Typ	Description
deleted	string	Tento účet je součástí dávky odstranění a je naplánovaný pro odstranění.
disabled	string	Tento hostitelský účet je zakázaný.
enabled	string	Tento hostitelský účet je aktivní a přiřazený zákazníkovi.
moved	string	Tento účet není zvládnut místně a fyzicky se přesunul.
none	string

AccountType

Typ účtu: Osobní, Organizace

Name	Typ	Description
organization	string
personal	string

PropertiesCollection

Třída představuje tašku vlastností jako kolekci párů klíč-hodnota. Jsou přijímány hodnoty všech primitivních typů (libovolný typ s TypeCode != TypeCode.Objectvýjimkou DBNull ). Hodnoty typu Byte[], Int32, Double, DateType a String zachovávají svůj typ, ostatní primitivy se přelaďují jako String. Byte[] byl očekáván jako řetězec s kódováním base64.

Name	Typ	Description
count	integer	Počet vlastností v kolekci.
item	object
keys	string[]	Sada klíčů v kolekci.
values	string[]	Sada hodnot v kolekci.