Profiles - Get

リファレンス

Service:: Profile

API Version:: 7.1-preview.3

ユーザープロファイルを取得します。

GET https://app.vssps.visualstudio.com/_apis/profile/profiles/{id}?api-version=7.1-preview.3

With optional parameters:

GET https://app.vssps.visualstudio.com/_apis/profile/profiles/{id}?details={details}&withAttributes={withAttributes}&partition={partition}&coreAttributes={coreAttributes}&forceRefresh={forceRefresh}&api-version=7.1-preview.3

URI パラメーター

名前	/	必須	型	説明
id	path	True	string	同じorganization内のターゲットユーザープロファイルの ID。現在の認証済みユーザーのプロファイルを取得する場合は 'me' です。
api-version	query	True	string	使う API のバージョン。このバージョンの API を使用するには、これを '7.1-preview.3' に設定する必要があります。
coreAttributes	query		string	返されるコアプロファイル属性のコンマ区切りのリスト。有効な値は、Email、アバター、DisplayName、ContactWithOffers です。
details	query		boolean	表示名、メールアドレス、国などのパブリックプロファイル情報を返します。false の場合、withAttributes パラメーターは無視されます。
forceRefresh	query		boolean	このバージョンの API では使用されません。
partition	query		string	返される属性のパーティション (名前付きグループ)。
withAttributes	query		boolean	true の場合、プロファイルに関連付けられている属性 (任意のデータの名前付きキーと値のペア) を取得します。 partition パラメーターにも値が必要です。

応答

名前	型	説明
200 OK	Profile	正常な操作

セキュリティ

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

例

Sample Request

HTTP

GET https://app.vssps.visualstudio.com/_apis/profile/profiles/{id}?api-version=7.1-preview.3

Sample Response

Status code:: 200

{
  "displayName": "Normal Paulk",
  "publicAlias": "d6245f20-2af8-44f4-9451-8107cb2767db",
  "emailAddress": "fabrikamfiber16@hotmail.com",
  "coreRevision": 1647,
  "timeStamp": "2014-05-12T22:23:07.727+00:00",
  "id": "d6245f20-2af8-44f4-9451-8107cb2767db",
  "revision": 1647
}

定義

名前	説明
AttributeDescriptor	名前とコンテナーを持つ属性を識別します。
AttributesContainer	名前付きプロファイル属性のセットを格納します。
CoreProfileAttribute	各プロファイルの値を常に持つプロファイル属性。
Profile	ユーザープロファイル。
ProfileAttribute	プロファイルに関連付けられている名前付きオブジェクト。
ProfileState	プロファイルの現在の状態。

AttributeDescriptor

名前とコンテナーを持つ属性を識別します。

名前	型	説明
attributeName	string	属性の名前。
containerName	string	属性が存在するコンテナー。

AttributesContainer

名前付きプロファイル属性のセットを格納します。

名前	型	説明
attributes	<string, ProfileAttribute>	コンテナーによって格納される属性。
containerName	string	コンテナーの名前。
revision	integer	コンテナー内の任意の属性の最大リビジョン番号。

CoreProfileAttribute

各プロファイルの値を常に持つプロファイル属性。

名前	型	説明
descriptor	AttributeDescriptor	属性の記述子。
revision	integer	属性のリビジョン番号。
timeStamp	string	属性が最後に変更された時刻。
value	string	属性の値。

Profile

ユーザープロファイル。

名前	型	説明
applicationContainer	AttributesContainer	このプロファイルの属性。
coreAttributes	<string, CoreProfileAttribute>	このプロファイルのコア属性。
coreRevision	integer	任意の属性の最大リビジョン番号。
id	string	プロファイルの一意識別子。
profileState	ProfileState	プロファイルの現在の状態。
revision	integer	任意の属性の最大リビジョン番号。
timeStamp	string	このプロファイルが最後に変更された時刻。

ProfileAttribute

プロファイルに関連付けられている名前付きオブジェクト。

名前	型	説明
descriptor	AttributeDescriptor	属性の記述子。
revision	integer	属性のリビジョン番号。
timeStamp	string	属性が最後に変更された時刻。
value	string	属性の値。

ProfileState

プロファイルの現在の状態。

名前	型	説明
custom	string	プロファイルが使用中です。
customReadOnly	string	プロファイルは使用中ですが、読み取りのみが可能です。
readOnly	string	プロファイルは読み取り専用です。

次の方法で共有