Share via

Users - List

  • 参考
Service:
Graph
API Version:
5.1-preview.1

获取给定范围内所有用户的列表。

由于用户列表可能很大，因此结果以用户页形式返回。 如果结果多于在单个页面中返回的结果数，则结果集将包含用于检索下一组结果的继续标记。

GET https://vssps.dev.azure.com/{organization}/_apis/graph/users?api-version=5.1-preview.1
With optional parameters: 
GET https://vssps.dev.azure.com/{organization}/_apis/graph/users?subjectTypes={subjectTypes}&continuationToken={continuationToken}&api-version=5.1-preview.1

URI 参数

名称 在 必需 类型 说明
organization
 path True

string

Azure DevOps 组织的名称。
api-version
 query True

string

要使用的 API 版本。 这应设置为“5.1-preview.1”才能使用此版本的 API。
continuationToken
 query

string

一个不透明的数据 Blob，允许在上一页结束之后立即恢复下一页数据。 了解是否剩余更多数据的唯一可靠方法是存在继续标记。
subjectTypes
 query

string

array (string)

以逗号分隔的用户主题子类型列表，以减少检索到的结果，例如 msa“、”aad“、”svc“ (服务标识) 、”imp“ (导入的标识) 等。

响应

名称 类型 说明
200 OK

GraphUser[]

成功的操作

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

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

示例

Sample Request

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

Sample Response

Status code:
200 
{
  "count": 5,
  "value": [
    {
      "subjectKind": "user",
      "metaType": "member",
      "domain": "LOCAL AUTHORITY",
      "principalName": "TeamFoundationService (TEAM FOUNDATION)",
      "mailAddress": "",
      "origin": "vsts",
      "originId": "00ca946b-2fe9-4f2a-ae2f-40d5c48001bc",
      "displayName": "TeamFoundationService (TEAM FOUNDATION)",
      "_links": {
        "self": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Users/acs.Nzc4OWYwOWQtZTA1My00ZjJlLWJkZWUtMGM4Zjg0NzZhNGJj"
        },
        "memberships": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Memberships/acs.Nzc4OWYwOWQtZTA1My00ZjJlLWJkZWUtMGM4Zjg0NzZhNGJj"
        },
        "membershipState": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/MembershipStates/acs.Nzc4OWYwOWQtZTA1My00ZjJlLWJkZWUtMGM4Zjg0NzZhNGJj"
        },
        "storageKey": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/StorageKeys/acs.Nzc4OWYwOWQtZTA1My00ZjJlLWJkZWUtMGM4Zjg0NzZhNGJj"
        },
        "avatar": {
          "href": "https://dev.azure.com/Fabrikam/_apis/GraphProfile/MemberAvatars/acs.Nzc4OWYwOWQtZTA1My00ZjJlLWJkZWUtMGM4Zjg0NzZhNGJj"
        }
      },
      "url": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Users/acs.Nzc4OWYwOWQtZTA1My00ZjJlLWJkZWUtMGM4Zjg0NzZhNGJj",
      "descriptor": "acs.Nzc4OWYwOWQtZTA1My00ZjJlLWJkZWUtMGM4Zjg0NzZhNGJj"
    },
    {
      "subjectKind": "user",
      "metaType": "guest",
      "domain": "45aa3d2d-7442-473d-b4d3-3c670da9dd96",
      "principalName": "fabrikamfiber4@hotmail.com",
      "mailAddress": "fabrikamfiber4@hotmail.com",
      "origin": "aad",
      "originId": "ddddb7d1-2de3-4bab-98b6-ddcc994e964d",
      "displayName": "Jamal Hartnett",
      "_links": {
        "self": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Users/aad.YWZkMzM2ZGQtZTgwYy03MWViLThlYmQtODMzNjMxYmEwNWM2"
        },
        "memberships": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Memberships/aad.YWZkMzM2ZGQtZTgwYy03MWViLThlYmQtODMzNjMxYmEwNWM2"
        },
        "membershipState": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/MembershipStates/aad.YWZkMzM2ZGQtZTgwYy03MWViLThlYmQtODMzNjMxYmEwNWM2"
        },
        "storageKey": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/StorageKeys/aad.YWZkMzM2ZGQtZTgwYy03MWViLThlYmQtODMzNjMxYmEwNWM2"
        },
        "avatar": {
          "href": "https://dev.azure.com/Fabrikam/_apis/GraphProfile/MemberAvatars/aad.YWZkMzM2ZGQtZTgwYy03MWViLThlYmQtODMzNjMxYmEwNWM2"
        }
      },
      "url": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Users/aad.YWZkMzM2ZGQtZTgwYy03MWViLThlYmQtODMzNjMxYmEwNWM2",
      "descriptor": "aad.YWZkMzM2ZGQtZTgwYy03MWViLThlYmQtODMzNjMxYmEwNWM2"
    },
    {
      "subjectKind": "user",
      "metaType": "member",
      "domain": "45aa3d2d-7442-473d-b4d3-3c670da9dd96",
      "principalName": "ftotten@vscsi.us",
      "mailAddress": "ftotten@vscsi.us",
      "origin": "aad",
      "originId": "4be8f294-000d-4431-8506-57420b88e204",
      "displayName": "Francis Totten",
      "_links": {
        "self": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Users/aad.NjU5MDNmOTItNTNkYy03MWIzLWJiMGUtZTY5Y2ZhMWNiNzE5"
        },
        "memberships": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Memberships/aad.NjU5MDNmOTItNTNkYy03MWIzLWJiMGUtZTY5Y2ZhMWNiNzE5"
        },
        "membershipState": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/MembershipStates/aad.NjU5MDNmOTItNTNkYy03MWIzLWJiMGUtZTY5Y2ZhMWNiNzE5"
        },
        "storageKey": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/StorageKeys/aad.NjU5MDNmOTItNTNkYy03MWIzLWJiMGUtZTY5Y2ZhMWNiNzE5"
        },
        "avatar": {
          "href": "https://dev.azure.com/Fabrikam/_apis/GraphProfile/MemberAvatars/aad.NjU5MDNmOTItNTNkYy03MWIzLWJiMGUtZTY5Y2ZhMWNiNzE5"
        }
      },
      "url": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Users/aad.NjU5MDNmOTItNTNkYy03MWIzLWJiMGUtZTY5Y2ZhMWNiNzE5",
      "descriptor": "aad.NjU5MDNmOTItNTNkYy03MWIzLWJiMGUtZTY5Y2ZhMWNiNzE5"
    },
    {
      "subjectKind": "user",
      "metaType": "member",
      "domain": "45aa3d2d-7442-473d-b4d3-3c670da9dd96",
      "principalName": "jmarks@vscsi.us",
      "mailAddress": "jmarks@vscsi.us",
      "origin": "aad",
      "originId": "f867eff7-2024-49b4-9626-25777ae370f6",
      "displayName": "Justin VSCSI AAD",
      "_links": {
        "self": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Users/aad.NGRkODVlNDctOGM1MS03MTZlLTljZGUtZjA3Yjc0NDU0ZWFj"
        },
        "memberships": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Memberships/aad.NGRkODVlNDctOGM1MS03MTZlLTljZGUtZjA3Yjc0NDU0ZWFj"
        },
        "membershipState": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/MembershipStates/aad.NGRkODVlNDctOGM1MS03MTZlLTljZGUtZjA3Yjc0NDU0ZWFj"
        },
        "storageKey": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/StorageKeys/aad.NGRkODVlNDctOGM1MS03MTZlLTljZGUtZjA3Yjc0NDU0ZWFj"
        },
        "avatar": {
          "href": "https://dev.azure.com/Fabrikam/_apis/GraphProfile/MemberAvatars/aad.NGRkODVlNDctOGM1MS03MTZlLTljZGUtZjA3Yjc0NDU0ZWFj"
        }
      },
      "url": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Users/aad.NGRkODVlNDctOGM1MS03MTZlLTljZGUtZjA3Yjc0NDU0ZWFj",
      "descriptor": "aad.NGRkODVlNDctOGM1MS03MTZlLTljZGUtZjA3Yjc0NDU0ZWFj"
    },
    {
      "subjectKind": "user",
      "domain": "Build",
      "principalName": "10feb381-82c3-4902-8e1f-840299a48ae4",
      "mailAddress": "",
      "origin": "vsts",
      "originId": "ca261b38-d22b-4b13-b0d8-f6b8cbe16f90",
      "displayName": "Project Collection Build Service (Fabrikam)",
      "_links": {
        "self": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Users/svc.OWI0ZjczMzYtYzEzMC00MGJkLTg3ZjMtNDIwMTM2MWRkYmQxOkJ1aWxkOjEwZmViMzgxLTgyYzMtNDkwMi04ZTFmLTg0MDI5OWE0OGFlNA"
        },
        "memberships": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Memberships/svc.OWI0ZjczMzYtYzEzMC00MGJkLTg3ZjMtNDIwMTM2MWRkYmQxOkJ1aWxkOjEwZmViMzgxLTgyYzMtNDkwMi04ZTFmLTg0MDI5OWE0OGFlNA"
        },
        "membershipState": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/MembershipStates/svc.OWI0ZjczMzYtYzEzMC00MGJkLTg3ZjMtNDIwMTM2MWRkYmQxOkJ1aWxkOjEwZmViMzgxLTgyYzMtNDkwMi04ZTFmLTg0MDI5OWE0OGFlNA"
        },
        "storageKey": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/StorageKeys/svc.OWI0ZjczMzYtYzEzMC00MGJkLTg3ZjMtNDIwMTM2MWRkYmQxOkJ1aWxkOjEwZmViMzgxLTgyYzMtNDkwMi04ZTFmLTg0MDI5OWE0OGFlNA"
        },
        "avatar": {
          "href": "https://dev.azure.com/Fabrikam/_apis/GraphProfile/MemberAvatars/svc.OWI0ZjczMzYtYzEzMC00MGJkLTg3ZjMtNDIwMTM2MWRkYmQxOkJ1aWxkOjEwZmViMzgxLTgyYzMtNDkwMi04ZTFmLTg0MDI5OWE0OGFlNA"
        }
      },
      "url": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Users/svc.OWI0ZjczMzYtYzEzMC00MGJkLTg3ZjMtNDIwMTM2MWRkYmQxOkJ1aWxkOjEwZmViMzgxLTgyYzMtNDkwMi04ZTFmLTg0MDI5OWE0OGFlNA",
      "descriptor": "svc.OWI0ZjczMzYtYzEzMC00MGJkLTg3ZjMtNDIwMTM2MWRkYmQxOkJ1aWxkOjEwZmViMzgxLTgyYzMtNDkwMi04ZTFmLTg0MDI5OWE0OGFlNA"
    }
  ]
}

定义

名称 说明
GraphUser

Graph 用户实体
ReferenceLinks

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

GraphUser

Graph 用户实体

名称 类型 说明
_links

ReferenceLinks

此字段包含零个或多个有关图形主题的有趣链接。 可以调用这些链接来获取有关此图主题的其他关系或更详细的信息。
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 是指向此图主题的源资源的完整路由。

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

名称 类型 说明
links

object

链接的只读视图。 由于引用链接是只读的，因此我们只想将其公开为只读。