Subject Query - Query
搜索 Azure Devops 用户或/和组。 结果将在不超过 100 个图形主题的批处理中返回。
POST https://vssps.dev.azure.com/{organization}/_apis/graph/subjectquery?api-version=7.1-preview.1URI 参数
| 名称 | 在 | 必需 | 类型 | 说明 |
|---|---|---|---|---|
|
organization
|
path | True |
string |
Azure DevOps 组织的名称。 |
|
api-version
|
query | True |
string |
要使用的 API 版本。 这应设置为“7.1-preview.1”才能使用此版本的 API。 |
请求正文
| 名称 | 类型 | 说明 |
|---|---|---|
| query |
string |
搜索词以搜索 Azure Devops 用户或/和组 |
| scopeDescriptor |
string |
可选参数。 指定非默认范围（集合、项目）以搜索范围内的用户或组。 |
| subjectKind |
string[] |
可以同时指定“User”或“Group” |
响应
| 名称 | 类型 | 说明 |
|---|---|---|
| 200 OK |
成功操作 |
安全性
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 | 授予读取用户、组、范围和组成员身份信息的能力 |
定义
| 名称 | 说明 |
|---|---|
|
Graph |
顶级图形实体 |
|
Graph |
使用图形 API 进行搜索 |
|
Reference |
表示 REST 引用链接集合的类。 |
GraphSubject
顶级图形实体
| 名称 | 类型 | 说明 |
|---|---|---|
| _links |
此字段包含有关图形主题的零个或多个有趣的链接。 可以调用这些链接以获取有关此图形主题的其他关系或更详细的信息。 |
|
| descriptor |
string |
描述符是在系统运行时引用图形主题的主要方法。 此字段将唯一标识帐户和组织中的同一图形主题。 |
| displayName |
string |
这是图形主题的非唯一显示名称。 若要更改此字段，必须在源提供程序中更改其值。 |
| legacyDescriptor |
string |
[仅限内部使用]如果需要使用标识描述符访问旧版 IMS，则此处提供了旧描述符。 |
| origin |
string |
源标识符的源提供程序类型（例如：AD、AAD、MSA） |
| originId |
string |
源系统的唯一标识符。 通常为 sid、对象 ID 或 Guid。 链接和取消链接操作可能会导致用户更改此值，因为该用户不受其他提供程序的支持，并且新提供程序中具有不同的唯一 ID。 |
| subjectKind |
string |
此字段标识图形主题的类型（例如：组、范围、用户）。 |
| url |
string |
此 URL 是指向此图形主题的源资源的完整路由。 |
GraphSubjectQuery
使用图形 API 进行搜索
| 名称 | 类型 | 说明 |
|---|---|---|
| query |
string |
搜索词以搜索 Azure Devops 用户或/和组 |
| scopeDescriptor |
string |
可选参数。 指定非默认范围（集合、项目）以搜索范围内的用户或组。 |
| subjectKind |
string[] |
可以同时指定“User”或“Group” |
ReferenceLinks
表示 REST 引用链接集合的类。
| 名称 | 类型 | 说明 |
|---|---|---|
| links |
object |
链接的只读视图。 由于引用链接是只读的，因此我们只想将其公开为只读链接。 |