Accounts - List

Service:

Accounts

API Version:

7.1-preview.1

Obtenha uma lista de contas para um proprietário específico ou um membro específico. Um dos seguintes parâmetros é necessário: 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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
api-version	query	True	string	Versão da API a ser usada. Isso deve ser definido como '7.1-preview.1' para usar essa versão da api.
memberId	query		string uuid	ID para um membro das contas.
ownerId	query		string uuid	ID do proprietário das contas.
properties	query		string

Respostas

Nome	Tipo	Description
200 OK	Account[]	operação bem-sucedida

Segurança

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

Nome	Description
vso.profile	Concede a capacidade de ler seu perfil, contas, coleções, projetos, equipes e outros artefatos organizacionais de nível superior.

Exemplos

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

Definições

Nome	Description
Account
AccountStatus	Status de conta atual
AccountType	Tipo de conta: Pessoal, Organização
PropertiesCollection	A classe representa um recipiente de propriedades como uma coleção de pares chave-valor. Os valores de todos os tipos primitivos (qualquer tipo com um TypeCode != TypeCode.Object) exceto para DBNull são aceitos. Valores do tipo Byte[], Int32, Double, DateType e String preservam seu tipo, outros primitivos são reajustados como uma Cadeia de Caracteres. Byte[] esperado como cadeia de caracteres codificada em base64.

Account

Nome	Tipo	Description
accountId	string	Identificador de uma conta
accountName	string	Nome de uma conta
accountOwner	string	Proprietário da conta
accountStatus	AccountStatus	Status de conta atual
accountType	AccountType	Tipo de conta: Pessoal, Organização
accountUri	string	Uri para uma conta
createdBy	string	Quem criou a conta
createdDate	string	A conta de data foi criada
hasMoved	boolean
lastUpdatedBy	string	Identidade da última pessoa a atualizar a conta
lastUpdatedDate	string	A conta de data foi atualizada pela última vez
namespaceId	string	Namespace para uma conta
newCollectionId	string
organizationName	string	Organização que criou a conta
properties	PropertiesCollection	Propriedades estendidas
statusReason	string	Motivo do status atual

AccountStatus

Status de conta atual

Nome	Tipo	Description
deleted	string	Essa conta faz parte do lote de exclusão e está agendada para exclusão.
disabled	string	Essa conta de hospedagem está desabilitada.
enabled	string	Essa conta de hospedagem está ativa e atribuída a um cliente.
moved	string	Essa conta não é dominada localmente e foi fisicamente movida.
none	string

AccountType

Tipo de conta: Pessoal, Organização

Nome	Tipo	Description
organization	string
personal	string

PropertiesCollection

A classe representa um recipiente de propriedades como uma coleção de pares chave-valor. Os valores de todos os tipos primitivos (qualquer tipo com um TypeCode != TypeCode.Object) exceto para DBNull são aceitos. Valores do tipo Byte[], Int32, Double, DateType e String preservam seu tipo, outros primitivos são reajustados como uma Cadeia de Caracteres. Byte[] esperado como cadeia de caracteres codificada em base64.

Nome	Tipo	Description
count	integer	A contagem de propriedades na coleção.
item	object
keys	string[]	O conjunto de chaves na coleção.
values	string[]	O conjunto de valores na coleção.