Groups - Get

参考

服务:: Graph

API 版本:: 7.1-preview.1

按组描述符获取组。

即使组已从帐户中删除或已删除其所有成员身份，也会返回该组。

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

URI 参数

名称	在	必需	类型	说明
groupDescriptor	path	True	string	所需图形组的描述符。
organization	path	True	string	Azure DevOps 组织的名称。
api-version	query	True	string	要使用的 API 版本。应将其设置为“7.1-preview.1”才能使用此版本的 API。

响应

名称	类型	说明
200 OK	GraphGroup	成功的操作

安全性

oauth2

类型: oauth2
流向: accessCode
授权 URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
令牌 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

作用域

名称	说明
vso.graph	授予读取用户、组、范围和组成员身份信息的能力

示例

示例请求

HTTP

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

示例响应

状态代码:: 200

{
  "subjectKind": "group",
  "description": "Full time employees working on Fabrikam",
  "isCrossProject": true,
  "domain": "vstfs:///Framework/IdentityDomain/9b4f7336-c130-40bd-87f3-4201361ddbd1",
  "principalName": "[TEAM FOUNDATION]\\Full Time Engineers",
  "mailAddress": null,
  "origin": "aad",
  "originId": "77ed2186-aaf6-4299-ac9e-37ba282c2b95",
  "displayName": "Full Time Engineers",
  "_links": {
    "self": {
      "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Groups/aadgp.Uy0xLTktMTU1MTM3NDI0NS0xMjA0NDAwOTY5LTI0MDI5ODY0MTMtMjE3OTQwODYxNi0zLTIyNTAzNzA0MjMtNDEzODM3NTQ5MC0yODk2MDUwMTA2LTY3Mzk4MzM4MQ"
    },
    "memberships": {
      "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Memberships/aadgp.Uy0xLTktMTU1MTM3NDI0NS0xMjA0NDAwOTY5LTI0MDI5ODY0MTMtMjE3OTQwODYxNi0zLTIyNTAzNzA0MjMtNDEzODM3NTQ5MC0yODk2MDUwMTA2LTY3Mzk4MzM4MQ"
    },
    "membershipState": {
      "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/MembershipStates/aadgp.Uy0xLTktMTU1MTM3NDI0NS0xMjA0NDAwOTY5LTI0MDI5ODY0MTMtMjE3OTQwODYxNi0zLTIyNTAzNzA0MjMtNDEzODM3NTQ5MC0yODk2MDUwMTA2LTY3Mzk4MzM4MQ"
    },
    "storageKey": {
      "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/StorageKeys/aadgp.Uy0xLTktMTU1MTM3NDI0NS0xMjA0NDAwOTY5LTI0MDI5ODY0MTMtMjE3OTQwODYxNi0zLTIyNTAzNzA0MjMtNDEzODM3NTQ5MC0yODk2MDUwMTA2LTY3Mzk4MzM4MQ"
    }
  },
  "url": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Groups/aadgp.Uy0xLTktMTU1MTM3NDI0NS0xMjA0NDAwOTY5LTI0MDI5ODY0MTMtMjE3OTQwODYxNi0zLTIyNTAzNzA0MjMtNDEzODM3NTQ5MC0yODk2MDUwMTA2LTY3Mzk4MzM4MQ",
  "descriptor": "aadgp.Uy0xLTktMTU1MTM3NDI0NS0xMjA0NDAwOTY5LTI0MDI5ODY0MTMtMjE3OTQwODYxNi0zLTIyNTAzNzA0MjMtNDEzODM3NTQ5MC0yODk2MDUwMTA2LTY3Mzk4MzM4MQ"
}

定义

名称	说明
GraphGroup	图形组实体
ReferenceLinks	表示 REST 引用链接集合的类。

GraphGroup

Object

图形组实体

名称	类型	说明
_links	ReferenceLinks	此字段包含有关图形主题的零个或多个相关链接。可以调用这些链接来获取有关此图主题的其他关系或更多详细信息。
description	string	帮助人类读者消除具有相似名称的群体的简短短语
descriptor	string	描述符是在系统运行时引用图形主题的主要方式。此字段将唯一标识帐户和组织中的同一图形主题。
displayName	string	这是图形主题的非唯一显示名称。若要更改此字段，必须在源提供程序中更改其值。
domain	string	这表示图形成员的源容器的名称。 (对于 MSA，这是“Windows Live ID”，对于 AD 为域名称，对于 AAD 为目录的 tenantID，对于 VSTS 组，为 ScopeId 等)
legacyDescriptor	string	[仅限内部使用]如果需要使用标识描述符访问旧版本的 IMS，请在此处使用旧描述符。
mailAddress	string	给定图形成员的记录的电子邮件地址。这可能不同于主体名称。
origin	string	源标识符的源提供程序类型 (例如：AD、AAD、MSA)
originId	string	源系统中的唯一标识符。通常为 sid、对象 ID 或 Guid。链接和取消链接操作可能会导致用户更改此值，因为该用户不受其他提供程序的支持，并且新提供程序中具有不同的唯一 ID。
principalName	string	这是源提供程序中此图成员的 PrincipalName。源提供程序可能会随时间推移更改此字段，但 VSTS 不保证在图形成员的生命周期内不可变。
subjectKind	string	此字段标识图形主题的类型 (例如：组、范围、用户) 。
url	string	此 URL 是此图主题的源资源的完整路由。

ReferenceLinks