Subject Lookup - Lookup Subjects

参考

服务:: Graph

API 版本:: 7.1-preview.1

将描述符解析为批量 (主题) 的用户、组或范围。

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

URI 参数

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

请求正文

名称	类型	说明
lookupKeys	GraphSubjectLookupKey[]

响应

名称	类型	说明
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	授予读取用户、组、范围和组成员身份信息的能力

示例

示例请求

HTTP

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

{
  "lookupKeys": [
    {
      "descriptor": "aadgp.Uy0xLTktMTU1MTM3NDI0NS0xMjA0NDAwOTY5LTI0MDI5ODY0MTMtMjE3OTQwODYxNi0zLTE5MTI3MjIxNjAtMjUyNDcwNjM3MC0yNDg2NjA0ODIwLTg2MjI3NjQyNA"
    },
    {
      "descriptor": "aad.NjJhOWYxYmQtNmEwOS03NjQyLTkzYTAtMDFkMTVmZDQ2NDk4"
    }
  ]
}

示例响应

状态代码:: 200

{
  "count": 2,
  "value": {
    "aadgp.Uy0xLTktMTU1MTM3NDI0NS0xMjA0NDAwOTY5LTI0MDI5ODY0MTMtMjE3OTQwODYxNi0zLTE5MTI3MjIxNjAtMjUyNDcwNjM3MC0yNDg2NjA0ODIwLTg2MjI3NjQyNA": {
      "subjectKind": "group",
      "description": "Part time engineers",
      "isCrossProject": true,
      "domain": "vstfs:///Framework/IdentityDomain/9b4f7336-c130-40bd-87f3-4201361ddbd1",
      "principalName": "[TEAM FOUNDATION]\\Part Time Engineers",
      "mailAddress": null,
      "origin": "aad",
      "originId": "f0d20172-7b96-42f6-9436-941433654b48",
      "displayName": "Part Time Engineers",
      "_links": {
        "self": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Groups/aadgp.Uy0xLTktMTU1MTM3NDI0NS0xMjA0NDAwOTY5LTI0MDI5ODY0MTMtMjE3OTQwODYxNi0zLTE5MTI3MjIxNjAtMjUyNDcwNjM3MC0yNDg2NjA0ODIwLTg2MjI3NjQyNA"
        },
        "memberships": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Memberships/aadgp.Uy0xLTktMTU1MTM3NDI0NS0xMjA0NDAwOTY5LTI0MDI5ODY0MTMtMjE3OTQwODYxNi0zLTE5MTI3MjIxNjAtMjUyNDcwNjM3MC0yNDg2NjA0ODIwLTg2MjI3NjQyNA"
        },
        "membershipState": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/MembershipStates/aadgp.Uy0xLTktMTU1MTM3NDI0NS0xMjA0NDAwOTY5LTI0MDI5ODY0MTMtMjE3OTQwODYxNi0zLTE5MTI3MjIxNjAtMjUyNDcwNjM3MC0yNDg2NjA0ODIwLTg2MjI3NjQyNA"
        },
        "storageKey": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/StorageKeys/aadgp.Uy0xLTktMTU1MTM3NDI0NS0xMjA0NDAwOTY5LTI0MDI5ODY0MTMtMjE3OTQwODYxNi0zLTE5MTI3MjIxNjAtMjUyNDcwNjM3MC0yNDg2NjA0ODIwLTg2MjI3NjQyNA"
        }
      },
      "url": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Groups/aadgp.Uy0xLTktMTU1MTM3NDI0NS0xMjA0NDAwOTY5LTI0MDI5ODY0MTMtMjE3OTQwODYxNi0zLTE5MTI3MjIxNjAtMjUyNDcwNjM3MC0yNDg2NjA0ODIwLTg2MjI3NjQyNA",
      "descriptor": "aadgp.Uy0xLTktMTU1MTM3NDI0NS0xMjA0NDAwOTY5LTI0MDI5ODY0MTMtMjE3OTQwODYxNi0zLTE5MTI3MjIxNjAtMjUyNDcwNjM3MC0yNDg2NjA0ODIwLTg2MjI3NjQyNA"
    },
    "aad.NjJhOWYxYmQtNmEwOS03NjQyLTkzYTAtMDFkMTVmZDQ2NDk4": {
      "subjectKind": "user",
      "domain": "45aa3d2d-7442-473d-b4d3-3c670da9dd96",
      "principalName": "CPotra@vscsi.us",
      "mailAddress": "CPotra@vscsi.us",
      "origin": "aad",
      "originId": "e97b0e7f-0a61-41ad-860c-748ec5fcb20b",
      "displayName": "Cristina Potra",
      "_links": {
        "self": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Users/aad.NjJhOWYxYmQtNmEwOS03NjQyLTkzYTAtMDFkMTVmZDQ2NDk4"
        },
        "memberships": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Memberships/aad.NjJhOWYxYmQtNmEwOS03NjQyLTkzYTAtMDFkMTVmZDQ2NDk4"
        },
        "membershipState": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/MembershipStates/aad.NjJhOWYxYmQtNmEwOS03NjQyLTkzYTAtMDFkMTVmZDQ2NDk4"
        },
        "storageKey": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/StorageKeys/aad.NjJhOWYxYmQtNmEwOS03NjQyLTkzYTAtMDFkMTVmZDQ2NDk4"
        },
        "avatar": {
          "href": "https://dev.azure.com/Fabrikam/_apis/GraphProfile/MemberAvatars/aad.NjJhOWYxYmQtNmEwOS03NjQyLTkzYTAtMDFkMTVmZDQ2NDk4"
        }
      },
      "url": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Users/aad.NjJhOWYxYmQtNmEwOS03NjQyLTkzYTAtMDFkMTVmZDQ2NDk4",
      "descriptor": "aad.NjJhOWYxYmQtNmEwOS03NjQyLTkzYTAtMDFkMTVmZDQ2NDk4"
    }
  }
}

定义

名称	说明
GraphSubject	顶级图形实体
GraphSubjectLookup	使用图形 API对要查找的主题进行批处理
GraphSubjectLookupKey
ReferenceLinks	表示 REST 引用链接集合的类。

GraphSubject

Object

顶级图形实体

名称	类型	说明
_links	ReferenceLinks	此字段包含有关图形主题的零个或多个相关链接。可以调用这些链接来获取有关此图主题的其他关系或更多详细信息。
descriptor	string	描述符是在系统运行时引用图形主题的主要方式。此字段将唯一标识帐户和组织中的同一图形主题。
displayName	string	这是图形主题的非唯一显示名称。若要更改此字段，必须在源提供程序中更改其值。
legacyDescriptor	string	[仅限内部使用]如果需要使用标识描述符访问旧版本的 IMS，请在此处使用旧描述符。
origin	string	源标识符的源提供程序类型 (例如：AD、AAD、MSA)
originId	string	源系统中的唯一标识符。通常为 sid、对象 ID 或 Guid。链接和取消链接操作可能会导致用户更改此值，因为该用户不受其他提供程序的支持，并且新提供程序中具有不同的唯一 ID。
subjectKind	string	此字段标识图形主题的类型 (例如：组、范围、用户) 。
url	string	此 URL 是此图主题的源资源的完整路由。

GraphSubjectLookup

Object

使用图形 API对要查找的主题进行批处理

名称	类型	说明
lookupKeys	GraphSubjectLookupKey[]

GraphSubjectLookupKey

Object

名称	类型	说明
descriptor	string

ReferenceLinks

Object

表示 REST 引用链接集合的类。

名称	类型	说明
links	object	链接的只读视图。由于引用链接是只读的，因此我们只想将其公开为只读。

通过

Subject Lookup - Lookup Subjects

URI 参数

请求正文

响应

安全性

oauth2

作用域

示例

示例请求

示例响应

定义

GraphSubject

GraphSubjectLookup

GraphSubjectLookupKey

ReferenceLinks

其他资源