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 參數

名稱	位於	必要	類型	Description
organization	path	True	string	Azure DevOps 組織的名稱。
userDescriptor	path	True	string	所需使用者的描述項。
api-version	query	True	string	要使用的 API 版本。這應該設定為 '7.1-preview.1' 以使用此版本的 API。

回應

名稱	類型	Description
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

名稱	Description
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"
}

定義

名稱	Description
GraphUser
ReferenceLinks	表示 REST 參考連結集合的類別。

GraphUser

名稱	類型	Description
_links	ReferenceLinks	此欄位包含有關圖表主旨的零個或多個有趣連結。您可以叫用這些連結來取得其他關聯性，或取得此圖表主體的詳細資訊。
descriptor	string	描述項是在系統執行時參考圖形主旨的主要方式。此欄位可唯一識別帳戶和組織之間的相同圖表主旨。
directoryAlias	string	支援目錄中使用者的簡短、一般唯一名稱。對於 AAD 使用者，這會對應至郵件昵稱，這通常但不一定類似于 @ 符號之前使用者郵寄地址的一部分。對於 GitHub 使用者，這會對應至 GitHub 使用者控制碼。
displayName	string	這是圖表主旨的非唯一顯示名稱。若要變更此欄位，您必須在來源提供者中變更其值。
domain	string	這代表圖形成員的來源容器名稱。 (對於 MSA 而言，這是「Windows Live ID」、AD 功能變數名稱、針對目錄的 tenantID、VSTS 群組 ScopeId 等)
isDeletedInOrigin	boolean	當為 true 時，已在識別提供者中刪除群組
legacyDescriptor	string	[僅限內部使用]如果您需要使用身分識別描述元來存取舊版 IMS，則舊版描述元位於此處。
mailAddress	string	指定圖形成員的記錄電子郵件地址。這可能與主體名稱不同。
metaType	string	來源中使用者的中繼類型，例如「member」、「guest」等。如需一組可能的值，請參閱 UserMetaType。
origin	string	來源識別碼的來源提供者類型 (例如：AD、AAD、MSA)
originId	string	來源系統的唯一識別碼。通常是 sid、物件識別碼或 Guid。連結和取消連結作業可能會導致使用者的這個值變更，因為使用者不是由不同的提供者支援，而且在新提供者中具有不同的唯一識別碼。
principalName	string	這是來源提供者中此圖形成員的 PrincipalName。來源提供者可能會隨著時間變更此欄位，而且 VSTS 不保證圖表成員的存留期不可變。
subjectKind	string	此欄位會識別圖表主旨的類型 (，例如：群組、範圍、使用者) 。
url	string	此 URL 是此圖表主體來源資源的完整路由。

ReferenceLinks

表示 REST 參考連結集合的類別。

名稱	類型	Description
links	object	連結的唯讀檢視。因為參考連結是唯讀的，所以我們只想要將它們公開為唯讀。

Share via