Users - Get

リファレンス

Service:: Graph

API Version:: 7.1-preview.1

記述子でユーザーを取得します。

GET https://vssps.dev.azure.com/{organization}/_apis/graph/users/{userDescriptor}?api-version=7.1-preview.1

URI パラメーター

名前	/	必須	型	説明
organization	path	True	string	Azure DevOps 組織の名前です。
userDescriptor	path	True	string	目的のユーザーの記述子。
api-version	query	True	string	使う API のバージョン。このバージョンの API を使用するには、これを '7.1-preview.1' に設定する必要があります。

応答

名前	型	説明
200 OK	GraphUser	成功した操作

セキュリティ

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.graph	ユーザー、グループ、スコープ、およびグループメンバーシップ情報を読み取る機能を付与します

例

Sample Request

HTTP

GET https://vssps.dev.azure.com/{organization}/_apis/graph/users/{userDescriptor}?api-version=7.1-preview.1

Sample Response

Status code:: 200

{
  "subjectKind": "user",
  "domain": "45aa3d2d-7442-473d-b4d3-3c670da9dd96",
  "principalName": "jtseng@vscsi.us",
  "mailAddress": "jtseng@vscsi.us",
  "origin": "aad",
  "originId": "55c8c7b6-7ace-43bc-918f-304dfa2b6317",
  "displayName": "Jia-hao Tseng",
  "_links": {
    "self": {
      "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Users/aad.MDA0NzBlMzQtZGE2MS03YTY5LWJkOTYtNDg3YTg0OWVjNTU4"
    },
    "memberships": {
      "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Memberships/aad.MDA0NzBlMzQtZGE2MS03YTY5LWJkOTYtNDg3YTg0OWVjNTU4"
    },
    "membershipState": {
      "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/MembershipStates/aad.MDA0NzBlMzQtZGE2MS03YTY5LWJkOTYtNDg3YTg0OWVjNTU4"
    },
    "storageKey": {
      "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/StorageKeys/aad.MDA0NzBlMzQtZGE2MS03YTY5LWJkOTYtNDg3YTg0OWVjNTU4"
    },
    "avatar": {
      "href": "https://dev.azure.com/Fabrikam/_apis/GraphProfile/MemberAvatars/aad.MDA0NzBlMzQtZGE2MS03YTY5LWJkOTYtNDg3YTg0OWVjNTU4"
    }
  },
  "url": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Users/aad.MDA0NzBlMzQtZGE2MS03YTY5LWJkOTYtNDg3YTg0OWVjNTU4",
  "descriptor": "aad.MDA0NzBlMzQtZGE2MS03YTY5LWJkOTYtNDg3YTg0OWVjNTU4"
}

定義

名前	説明
GraphUser
ReferenceLinks	REST 参照リンクのコレクションを表すクラス。

GraphUser

名前	型	説明
_links	ReferenceLinks	このフィールドには、グラフの件名に関する 0 個以上の興味深いリンクが含まれています。これらのリンクを呼び出して、このグラフの件名に関する追加のリレーションシップまたは詳細情報を取得できます。
descriptor	string	記述子は、システムの実行中にグラフの件名を参照する主な方法です。このフィールドは、アカウントと組織の両方で同じグラフの件名を一意に識別します。
directoryAlias	string	バッキングディレクトリ内のユーザーの一般的な一意の短い名前。 AAD ユーザーの場合、これはメールのニックネームに対応します。これは、多くの場合、@記号の前のユーザーのメールアドレスの部分と必ずしも似ていますが、必ずしも似ています。 GitHub ユーザーの場合、これは GitHub ユーザーハンドルに対応します。
displayName	string	これは、グラフの件名の一意でない表示名です。このフィールドを変更するには、ソースプロバイダーでその値を変更する必要があります。
domain	string	これは、グラフメンバーの元のコンテナーの名前を表します。 (MSA の場合、AD の場合はドメインの名前、AAD の場合はディレクトリの tenantID、VSTS グループの場合は ScopeId など)
isDeletedInOrigin	boolean	true の場合、ID プロバイダーでグループが削除されました
legacyDescriptor	string	[内部使用のみ]ID 記述子を使用して古いバージョンの IMS にアクセスする必要がある場合は、レガシ記述子がここに表示されます。
mailAddress	string	特定のグラフメンバーのレコードの電子メールアドレス。これはプリンシパル名とは異なる場合があります。
metaType	string	配信元のユーザーのメタ型 ("member"、"guest"など)。使用可能な値のセットについては、「UserMetaType」を参照してください。
origin	string	配信元識別子 (例: AD、AAD、MSA) のソースプロバイダーの種類
originId	string	配信元のシステムからの一意の識別子。通常は、sid、オブジェクト ID、または Guid です。リンク操作とリンク解除操作では、ユーザーが別のプロバイダーによってサポートされておらず、新しいプロバイダーで異なる一意の ID を持っているため、ユーザーに対してこの値が変更される可能性があります。
principalName	string	これは、ソースプロバイダーのこのグラフメンバーの PrincipalName です。ソースプロバイダーは時間の経過と同時にこのフィールドを変更する可能性があり、VSTS によるグラフメンバーの有効期間中は不変であるとは限りません。
subjectKind	string	このフィールドは、グラフの件名の種類 (グループ、スコープ、ユーザーなど) を識別します。
url	string	この URL は、このグラフの件名のソースリソースへの完全なルートです。

ReferenceLinks

REST 参照リンクのコレクションを表すクラス。

名前	型	説明
links	object	リンクの読み取り専用ビュー。参照リンクは読み取り専用であるため、参照リンクは読み取り専用として公開する必要があります。