Service Principals - List
取得指定範圍中所有服務主體的清單。
由於服務主體清單可能很大,因此結果會以服務主體的頁面傳回。 如果結果數目超過單一頁面中傳回的結果,結果集將會包含接續標記,以擷取下一組結果。 知道沒有更多服務主體留下的唯一可靠方式是缺少接續權杖。
GET https://vssps.dev.azure.com/{organization}/_apis/graph/serviceprincipals?api-version=7.1-preview.1
GET https://vssps.dev.azure.com/{organization}/_apis/graph/serviceprincipals?continuationToken={continuationToken}&scopeDescriptor={scopeDescriptor}&api-version=7.1-preview.1
URI 參數
名稱 | 位於 | 必要 | 類型 | Description |
---|---|---|---|---|
organization
|
path | True |
string |
Azure DevOps 組織的名稱。 |
api-version
|
query | True |
string |
要使用的 API 版本。 這應該設定為 '7.1-preview.1' 以使用此版本的 API。 |
continuation
|
query |
string |
不透明的資料 Blob,可讓下一頁的資料緊接在上一頁結束的位置之後繼續。 知道是否有更多資料留下的唯一可靠方式是接續權杖的存在。 |
|
scope
|
query |
string |
指定非預設範圍 (集合、專案) 來搜尋服務主體。 |
回應
名稱 | 類型 | Description |
---|---|---|
200 OK |
成功的作業 Headers X-MS-ContinuationToken: string |
安全性
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
GET https://vssps.dev.azure.com/{organization}/_apis/graph/serviceprincipals?api-version=7.1-preview.1
Sample Response
{
"count": 2,
"value": [
{
"subjectKind": "servicePrincipal",
"applicationId": "57227acc-068c-4bd0-b122-76af4ca8156d",
"directoryAlias": "db2b37a2-4d17-4de2-b935-59d43396a001",
"domain": "62e2ee3f-dbd4-48d8-9b85-4a3776783e13",
"principalName": "db2b37a2-4d17-4de2-b935-59d43396a001",
"mailAddress": null,
"origin": "aad",
"originId": "db2b37a2-4d17-4de2-b935-59d43396a001",
"displayName": "ServicePrincipalDisplayName",
"_links": {
"self": {
"href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/ServicePrincipals/aadsp.OGY2Njg2ODQtOTAzMi03NWE2LWFiZDctMGJhMDUzYjhiNTIx"
},
"memberships": {
"href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Memberships/aadsp.OGY2Njg2ODQtOTAzMi03NWE2LWFiZDctMGJhMDUzYjhiNTIx"
},
"membershipState": {
"href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/MembershipStates/aadsp.OGY2Njg2ODQtOTAzMi03NWE2LWFiZDctMGJhMDUzYjhiNTIx"
},
"storageKey": {
"href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/StorageKeys/aadsp.OGY2Njg2ODQtOTAzMi03NWE2LWFiZDctMGJhMDUzYjhiNTIx"
},
"avatar": {
"href": "https://dev.azure.com/Fabrikam/_apis/GraphProfile/MemberAvatars/aadsp.OGY2Njg2ODQtOTAzMi03NWE2LWFiZDctMGJhMDUzYjhiNTIx"
}
},
"url": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/ServicePrincipals/aadsp.OGY2Njg2ODQtOTAzMi03NWE2LWFiZDctMGJhMDUzYjhiNTIx",
"descriptor": "aadsp.OGY2Njg2ODQtOTAzMi03NWE2LWFiZDctMGJhMDUzYjhiNTIx"
},
{
"subjectKind": "servicePrincipal",
"applicationId": "4461fafd-3c00-43b1-9e9a-5c554405a9d3",
"directoryAlias": "eb8f407c-9b55-4e8a-acab-7416774c5479",
"domain": "62e2ee3f-dbd4-48d8-9b85-4a3776783e13",
"principalName": "eb8f407c-9b55-4e8a-acab-7416774c5479",
"mailAddress": null,
"origin": "aad",
"originId": "eb8f407c-9b55-4e8a-acab-7416774c5479",
"displayName": "ServicePrincipalDispalyName2",
"_links": {
"self": {
"href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/ServicePrincipals/aadsp.MjBlZDFjMDktMDRhNC03NjYwLThjNjEtZWQ4ZjZhY2ZhNDE5"
},
"memberships": {
"href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Memberships/aadsp.MjBlZDFjMDktMDRhNC03NjYwLThjNjEtZWQ4ZjZhY2ZhNDE5"
},
"membershipState": {
"href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/MembershipStates/aadsp.MjBlZDFjMDktMDRhNC03NjYwLThjNjEtZWQ4ZjZhY2ZhNDE5"
},
"storageKey": {
"href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/StorageKeys/aadsp.MjBlZDFjMDktMDRhNC03NjYwLThjNjEtZWQ4ZjZhY2ZhNDE5"
},
"avatar": {
"href": "https://dev.azure.com/Fabrikam/_apis/GraphProfile/MemberAvatars/aadsp.MjBlZDFjMDktMDRhNC03NjYwLThjNjEtZWQ4ZjZhY2ZhNDE5"
}
},
"url": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/ServicePrincipals/aadsp.MjBlZDFjMDktMDRhNC03NjYwLThjNjEtZWQ4ZjZhY2ZhNDE5",
"descriptor": "aadsp.MjBlZDFjMDktMDRhNC03NjYwLThjNjEtZWQ4ZjZhY2ZhNDE5"
}
]
}
定義
名稱 | Description |
---|---|
Graph |
|
Reference |
表示 REST 參考連結集合的類別。 |
GraphServicePrincipal
名稱 | 類型 | Description |
---|---|---|
_links |
此欄位包含有關圖表主旨的零個或多個有趣連結。 您可以叫用這些連結來取得其他關聯性,或取得此圖表主體的詳細資訊。 |
|
applicationId |
string |
|
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 |
連結的唯讀檢視。 因為參考連結是唯讀的,所以我們只想要將它們公開為唯讀。 |
意見反應
https://aka.ms/ContentUserFeedback。
即將登場:在 2024 年,我們將逐步淘汰 GitHub 問題作為內容的意見反應機制,並將它取代為新的意見反應系統。 如需詳細資訊,請參閱:提交並檢視相關的意見反應