Accounts - List

Service:

Accounts

API Version:

7.1-preview.1

特定の所有者または特定のメンバーのアカウントの一覧を取得します。 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

URI パラメーター

名前	/	必須	型	説明
api-version	query	True	string	使う API のバージョン。 このバージョンの API を使用するには、これを '7.1-preview.1' に設定する必要があります。
memberId	query		string uuid	アカウントのメンバーの ID。
ownerId	query		string uuid	アカウントの所有者の ID。
properties	query		string

応答

名前	型	説明
200 OK	Account[]	正常な操作

セキュリティ

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	プロファイル、アカウント、コレクション、プロジェクト、チーム、およびその他のトップレベルの組織成果物を読み取る機能を付与します。

例

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

定義

名前	説明
Account
AccountStatus	現在のアカウントの状態
AccountType	アカウントの種類: 個人用、組織
PropertiesCollection	クラスは、キーと値のペアのコレクションとしてプロパティ バッグを表します。 を除くすべてのプリミティブ型 (を持つ任意の TypeCode != TypeCode.Object型) の DBNull 値が受け入れられます。 Byte[]、Int32、Double、DateType、String 型の値は型を保持し、他のプリミティブは String として再チューニングされます。 Byte[] は base64 でエンコードされた文字列として必要です。

Account

名前	型	説明
accountId	string	アカウントの識別子
accountName	string	アカウントの名前
accountOwner	string	アカウントの所有者
accountStatus	AccountStatus	現在のアカウントの状態
accountType	AccountType	アカウントの種類: 個人用、組織
accountUri	string	アカウントの URI
createdBy	string	アカウントを作成したユーザー
createdDate	string	アカウントが作成された日付
hasMoved	boolean
lastUpdatedBy	string	アカウントを更新する最後のユーザーの ID
lastUpdatedDate	string	アカウントが最後に更新された日付
namespaceId	string	アカウントの名前空間
newCollectionId	string
organizationName	string	アカウントを作成した組織
properties	PropertiesCollection	拡張プロパティ
statusReason	string	現在の状態の理由

AccountStatus

現在のアカウントの状態

名前	型	説明
deleted	string	このアカウントは削除バッチの一部であり、削除がスケジュールされています。
disabled	string	このホスティング アカウントは無効になっています。
enabled	string	このホスティング アカウントはアクティブであり、顧客に割り当てられます。
moved	string	このアカウントはローカルでマスターされず、物理的に移動されました。
none	string

AccountType

アカウントの種類: 個人用、組織

名前	型	説明
organization	string
personal	string

PropertiesCollection

クラスは、キーと値のペアのコレクションとしてプロパティ バッグを表します。 を除くすべてのプリミティブ型 (を持つ任意の TypeCode != TypeCode.Object型) の DBNull 値が受け入れられます。 Byte[]、Int32、Double、DateType、String 型の値は型を保持し、他のプリミティブは String として再チューニングされます。 Byte[] は base64 でエンコードされた文字列として必要です。

名前	型	説明
count	integer	コレクション内のプロパティの数。
item	object
keys	string[]	コレクション内のキーのセット。
values	string[]	コレクション内の値のセット。