Group Entitlements - List
获取帐户的组权利。
GET https://vsaex.dev.azure.com/{organization}/_apis/groupentitlements?api-version=5.1-preview.1URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
organization
|
path | True |
string |
Azure DevOps 组织的名称。 |
|
api-version
|
query | True |
string |
要使用的 API 版本。 这应设置为“5.1-preview.1”才能使用此版本的 API。 |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 200 OK |
成功的操作 |
安全性
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.memberentitlementmanagement | 授予读取用户、其许可证以及他们可以访问的项目和扩展的能力 |
示例
Sample Request
GET https://vsaex.dev.azure.com/{organization}/_apis/groupentitlements?api-version=5.1-preview.1
Sample Response
{
"count": 2,
"value": [
{
"id": "8edcddd7-867a-419f-b330-4108f36615ca",
"group": {
"subjectKind": "group",
"description": "Hockey App - Core Team",
"domain": "14c5367e-ee12-4c94-98b8-b52c1fe3cfb1",
"principalName": "Hockey App - Core Team",
"mailAddress": "hockeyappcoreteam@fabrikam.com",
"origin": "aad",
"originId": "00000000-0000-0000-0000-000000000000",
"displayName": "Hockey App - Core Team",
"_links": {
"self": {
"href": "https://vssps.dev.azure.com/fabrikam/_apis/graph/groups/aadgp.AMzkjN0QzM5ADNtYTO2IjNwEzM3ITL2UDMxAzN5MTOtIzM5YjM1EDNwETLz0iNxYDOwQTO3EjMtMTM0YDO5IDM0ITL5YTOwADN0AjMx0SN0IDN3MTM1UTMtkTLx0yU"
},
"memberships": {
"href": "https://vssps.dev.azure.com/fabrikam/_apis/graph/memberships/aadgp.AMzkjN0QzM5ADNtYTO2IjNwEzM3ITL2UDMxAzN5MTOtIzM5YjM1EDNwETLz0iNxYDOwQTO3EjMtMTM0YDO5IDM0ITL5YTOwADN0AjMx0SN0IDN3MTM1UTMtkTLx0yU"
},
"membershipState": {
"href": "https://vssps.dev.azure.com/fabrikam/_apis/graph/membershipstates/aadgp.AMzkjN0QzM5ADNtYTO2IjNwEzM3ITL2UDMxAzN5MTOtIzM5YjM1EDNwETLz0iNxYDOwQTO3EjMtMTM0YDO5IDM0ITL5YTOwADN0AjMx0SN0IDN3MTM1UTMtkTLx0yU"
},
"storageKey": {
"href": "https://vssps.dev.azure.com/fabrikam/_apis/graph/storagekeys/aadgp.AMzkjN0QzM5ADNtYTO2IjNwEzM3ITL2UDMxAzN5MTOtIzM5YjM1EDNwETLz0iNxYDOwQTO3EjMtMTM0YDO5IDM0ITL5YTOwADN0AjMx0SN0IDN3MTM1UTMtkTLx0yU"
}
},
"url": "https://vssps.dev.azure.com/fabrikam/_apis/graph/groups/aadgp.AMzkjN0QzM5ADNtYTO2IjNwEzM3ITL2UDMxAzN5MTOtIzM5YjM1EDNwETLz0iNxYDOwQTO3EjMtMTM0YDO5IDM0ITL5YTOwADN0AjMx0SN0IDN3MTM1UTMtkTLx0yU",
"descriptor": "aadgp.AMzkjN0QzM5ADNtYTO2IjNwEzM3ITL2UDMxAzN5MTOtIzM5YjM1EDNwETLz0iNxYDOwQTO3EjMtMTM0YDO5IDM0ITL5YTOwADN0AjMx0SN0IDN3MTM1UTMtkTLx0yU"
},
"licenseRule": {
"licensingSource": "account",
"accountLicenseType": "express",
"msdnLicenseType": "none",
"licenseDisplayName": "Basic",
"status": "active",
"statusMessage": "",
"assignmentSource": "unknown"
},
"extensionRules": [],
"projectEntitlements": [
{
"projectRef": {
"id": "83e2bc87-1ed3-4926-9f50-9ef67bbdf6b0",
"name": "HockeyApp"
},
"group": {
"groupType": "projectContributor",
"displayName": "Project Contributors"
},
"isProjectPermissionInherited": false,
"teamRefs": [],
"assignmentSource": "unknown"
}
],
"status": "applied"
},
{
"id": "5458dc43-7b78-47ba-9b48-d45792ba8376",
"group": {
"subjectKind": "group",
"description": "",
"domain": "14c5367e-ee12-4c94-98b8-b52c1fe3cfb1",
"principalName": "Test Vendor Group",
"mailAddress": "vendorgp2@fabrikam.com",
"origin": "aad",
"originId": "00000000-0000-0000-0000-000000000000",
"displayName": "Test Vendor Group",
"_links": {
"self": {
"href": "https://vssps.dev.azure.com/fabrikam/_apis/graph/groups/aadgp.Uy0xLTktMTU1MTM3NDI0NS0xMjA0NDAwOTY5LTI0MDI5ODY0MTMtMjE3OTQwODYxNi0zLTQxMjU4MDI4MzMtMzY0MDAxOTUzNC0yMzUzOTcxMTUxLTMwNjQ4NTMyMzk"
},
"memberships": {
"href": "https://vssps.dev.azure.com/fabrikam/_apis/graph/memberships/aadgp.Uy0xLTktMTU1MTM3NDI0NS0xMjA0NDAwOTY5LTI0MDI5ODY0MTMtMjE3OTQwODYxNi0zLTQxMjU4MDI4MzMtMzY0MDAxOTUzNC0yMzUzOTcxMTUxLTMwNjQ4NTMyMzk"
},
"membershipState": {
"href": "https://vssps.dev.azure.com/fabrikam/_apis/graph/membershipstates/aadgp.Uy0xLTktMTU1MTM3NDI0NS0xMjA0NDAwOTY5LTI0MDI5ODY0MTMtMjE3OTQwODYxNi0zLTQxMjU4MDI4MzMtMzY0MDAxOTUzNC0yMzUzOTcxMTUxLTMwNjQ4NTMyMzk"
},
"storageKey": {
"href": "https://vssps.dev.azure.com/fabrikam/_apis/graph/storagekeys/aadgp.Uy0xLTktMTU1MTM3NDI0NS0xMjA0NDAwOTY5LTI0MDI5ODY0MTMtMjE3OTQwODYxNi0zLTQxMjU4MDI4MzMtMzY0MDAxOTUzNC0yMzUzOTcxMTUxLTMwNjQ4NTMyMzk"
}
},
"url": "https://vssps.dev.azure.com/fabrikam/_apis/graph/groups/aadgp.Uy0xLTktMTU1MTM3NDI0NS0xMjA0NDAwOTY5LTI0MDI5ODY0MTMtMjE3OTQwODYxNi0zLTQxMjU4MDI4MzMtMzY0MDAxOTUzNC0yMzUzOTcxMTUxLTMwNjQ4NTMyMzk",
"descriptor": "aadgp.Uy0xLTktMTU1MTM3NDI0NS0xMjA0NDAwOTY5LTI0MDI5ODY0MTMtMjE3OTQwODYxNi0zLTQxMjU4MDI4MzMtMzY0MDAxOTUzNC0yMzUzOTcxMTUxLTMwNjQ4NTMyMzk"
},
"licenseRule": {
"licensingSource": "account",
"accountLicenseType": "express",
"msdnLicenseType": "none",
"licenseDisplayName": "Basic",
"status": "active",
"statusMessage": "",
"assignmentSource": "unknown"
},
"extensionRules": [],
"projectEntitlements": [
{
"projectRef": {
"id": "83e2bc87-1ed3-4926-9f50-9ef67bbdf6b0",
"name": "HockeyApp"
},
"group": {
"groupType": "projectContributor",
"displayName": "Project Contributors"
},
"isProjectPermissionInherited": false,
"teamRefs": [],
"assignmentSource": "unknown"
}
],
"status": "applied"
}
]
}定义
| 名称 | 说明 |
|---|---|
|
Access |
分配给用户的许可证 |
|
Account |
帐户许可证 (类型，例如 Express、利益干系人等) |
|
Account |
帐户中的用户状态 |
|
Assignment |
许可证 (的分配源，例如组、未知等。 |
| Extension |
分配给用户的扩展 |
|
Graph |
图形组实体 |
|
Graph |
Graph 用户实体 |
| Group |
项目组 (例如参与者、读者等) |
|
Group |
具有其他属性的组实体，包括其许可证、扩展和项目成员身份 |
|
Group |
组规则的状态。 |
|
Group |
组类型 |
|
Licensing |
许可源 (例如帐户MSDN 等) |
|
Msdn |
MSDN 许可证 (的类型，例如Visual Studio Professional、Visual Studio Enterprise等) |
|
Project |
项目与用户在该项目中的有效权限之间的关系。 |
|
Project |
用户是通过 Azure DevOps 还是 AAD 组成员身份继承对项目的权限。 |
|
Project |
对项目的引用 |
|
Reference |
表示 REST 引用链接集合的类。 |
|
Team |
对团队的引用 |
|
User |
具有其他属性（包括许可证、扩展和项目成员身份）的用户实体 |
AccessLevel
分配给用户的许可证
| 名称 | 类型 | 说明 |
|---|---|---|
| accountLicenseType |
帐户许可证 (类型，例如 Express、利益干系人等) |
|
| assignmentSource |
许可证 (的分配源，例如组、未知等。 |
|
| licenseDisplayName |
string |
许可证的显示名称 |
| licensingSource |
许可源 (例如帐户MSDN 等) |
|
| msdnLicenseType |
MSDN 许可证 (的类型，例如Visual Studio Professional、Visual Studio Enterprise等) |
|
| status |
帐户中的用户状态 |
|
| statusMessage |
string |
状态消息。 |
AccountLicenseType
帐户许可证 (类型，例如 Express、利益干系人等)
| 名称 | 类型 | 说明 |
|---|---|---|
| advanced |
string |
|
| earlyAdopter |
string |
|
| express |
string |
|
| none |
string |
|
| professional |
string |
|
| stakeholder |
string |
AccountUserStatus
帐户中的用户状态
| 名称 | 类型 | 说明 |
|---|---|---|
| active |
string |
用户至少登录到 VSTS 帐户一次 |
| deleted |
string |
VSTS 帐户管理员从 VSTS 帐户中删除用户 |
| disabled |
string |
用户无法登录;主要由管理员用于临时删除因缺少或重新分配许可证而删除用户 |
| expired |
string |
用户可以登录;主要在许可证处于过期状态并且我们给予宽限期时使用 |
| none |
string |
|
| pending |
string |
VSTS 帐户管理员邀请用户加入 VSTS 帐户，但尚未注册/登录 |
| pendingDisabled |
string |
用户已禁用;如果重新启用，则它们仍将处于挂起状态 |
AssignmentSource
许可证 (的分配源，例如组、未知等。
| 名称 | 类型 | 说明 |
|---|---|---|
| groupRule |
string |
|
| none |
string |
|
| unknown |
string |
Extension
分配给用户的扩展
| 名称 | 类型 | 说明 |
|---|---|---|
| assignmentSource |
此扩展的分配源。 即显式分配或从组规则。 |
|
| id |
string |
扩展的库 ID。 |
| name |
string |
此扩展的友好名称。 |
| source |
此扩展分配的源。 例如：msdn、account、none 等。 |
GraphGroup
图形组实体
| 名称 | 类型 | 说明 |
|---|---|---|
| _links |
此字段包含零个或多个有关图形主题的有趣链接。 可以调用这些链接来获取有关此图主题的其他关系或更详细的信息。 |
|
| 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 是指向此图主题的源资源的完整路由。 |
GraphUser
Graph 用户实体
| 名称 | 类型 | 说明 |
|---|---|---|
| _links |
此字段包含零个或多个有关图形主题的有趣链接。 可以调用这些链接来获取有关此图主题的其他关系或更详细的信息。 |
|
| descriptor |
string |
描述符是在系统运行时引用图形主题的主要方法。 此字段将唯一标识帐户和组织中的同一图形主题。 |
| directoryAlias |
string |
后备目录中用户通常唯一的短名称。 对于 AAD 用户，这对应于邮件昵称，通常但不一定类似于 @ 符号前的用户邮件地址部分。 对于 GitHub 用户，这对应于 GitHub 用户句柄。 |
| displayName |
string |
这是图形主题的非唯一显示名称。 若要更改此字段，必须在源提供程序中更改其值。 |
| domain |
string |
这表示图形成员的源容器的名称。 (对于 MSA，这是“Windows Live ID”，对于 AD，这是域的名称，对于 AAD，为目录的 tenantID，对于 VSTS 组，则为 ScopeId，等等) |
| isDeletedInOrigin |
boolean |
如果为 true，则标识提供者中的组已被删除 |
| legacyDescriptor |
string |
[仅限内部使用]如果需要使用标识描述符访问旧版 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 是指向此图主题的源资源的完整路由。 |
Group
项目组 (例如参与者、读者等)
| 名称 | 类型 | 说明 |
|---|---|---|
| displayName |
string |
组的显示名称 |
| groupType |
组类型 |
GroupEntitlement
具有其他属性的组实体，包括其许可证、扩展和项目成员身份
| 名称 | 类型 | 说明 |
|---|---|---|
| extensionRules |
扩展规则。 |
|
| group |
成员引用。 |
|
| id |
string |
与 GraphMember 的 ID 匹配的唯一标识符。 |
| lastExecuted |
string |
[Readonly]上一次执行组许可规则的时间 (，无论是否) 进行了任何更改。 |
| licenseRule |
许可证规则。 |
|
| members |
组成员。 仅在创建新组时使用。 |
|
| projectEntitlements |
项目与成员在该项目中的有效权限之间的关系。 |
|
| status |
组规则的状态。 |
GroupLicensingRuleStatus
组规则的状态。
| 名称 | 类型 | 说明 |
|---|---|---|
| applied |
string |
应用规则 |
| applyPending |
string |
规则已创建或更新，但应用挂起 |
| incompatible |
string |
组规则不兼容 |
| unableToApply |
string |
规则无法意外应用，应重试 |
GroupType
组类型
| 名称 | 类型 | 说明 |
|---|---|---|
| custom |
string |
|
| projectAdministrator |
string |
|
| projectContributor |
string |
|
| projectReader |
string |
|
| projectStakeholder |
string |
LicensingSource
许可源 (例如帐户MSDN 等)
| 名称 | 类型 | 说明 |
|---|---|---|
| account |
string |
|
| auto |
string |
|
| msdn |
string |
|
| none |
string |
|
| profile |
string |
|
| trial |
string |
MsdnLicenseType
MSDN 许可证 (的类型，例如Visual Studio Professional、Visual Studio Enterprise等)
| 名称 | 类型 | 说明 |
|---|---|---|
| eligible |
string |
|
| enterprise |
string |
|
| none |
string |
|
| platforms |
string |
|
| premium |
string |
|
| professional |
string |
|
| testProfessional |
string |
|
| ultimate |
string |
ProjectEntitlement
项目与用户在该项目中的有效权限之间的关系。
| 名称 | 类型 | 说明 |
|---|---|---|
| assignmentSource |
分配源 (，例如组或未知) 。 |
|
| group |
项目组 (例如参与者、读者等) |
|
| projectPermissionInherited |
用户是通过 Azure DevOps 还是 AAD 组成员身份继承对项目的权限。 |
|
| projectRef |
Project Ref |
|
| teamRefs |
Team |
团队参考 |
ProjectPermissionInherited
用户是通过 Azure DevOps 还是 AAD 组成员身份继承对项目的权限。
| 名称 | 类型 | 说明 |
|---|---|---|
| inherited |
string |
|
| notInherited |
string |
|
| notSet |
string |
ProjectRef
对项目的引用
| 名称 | 类型 | 说明 |
|---|---|---|
| id |
string |
项目 ID。 |
| name |
string |
项目名称。 |
ReferenceLinks
表示 REST 引用链接集合的类。
| 名称 | 类型 | 说明 |
|---|---|---|
| links |
object |
链接的只读视图。 由于引用链接是只读的，因此我们只想将其公开为只读。 |
TeamRef
对团队的引用
| 名称 | 类型 | 说明 |
|---|---|---|
| id |
string |
团队 ID |
| name |
string |
团队名称 |
UserEntitlement
具有其他属性（包括许可证、扩展和项目成员身份）的用户实体
| 名称 | 类型 | 说明 |
|---|---|---|
| accessLevel |
许可证表示的用户访问级别。 |
|
| dateCreated |
string |
[Readonly]将用户添加到集合的日期。 |
| extensions |
用户的扩展。 |
|
| groupAssignments |
[Readonly]此用户所属的 GroupEntitlements。 |
|
| id |
string |
与 GraphMember 关联的标识的 ID 匹配的唯一标识符。 |
| lastAccessedDate |
string |
[Readonly]用户上次访问集合的日期。 |
| projectEntitlements |
项目与用户在该项目中的有效权限之间的关系。 |
|
| user |
用户引用。 |
反馈
即将发布：在整个 2024 年，我们将逐步淘汰作为内容反馈机制的“GitHub 问题”，并将其取代为新的反馈系统。 有关详细信息，请参阅：https://aka.ms/ContentUserFeedback。
提交和查看相关反馈