Pats - List

服务:

Tokens

API 版本:

7.1-preview.1

获取在此组织中创建的个人访问令牌（PAT）的分页列表。 对 API 的后续调用需要提供相同的筛选选项。

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

具有可选参数:

GET https://vssps.dev.azure.com/{organization}/_apis/tokens/pats?displayFilterOption={displayFilterOption}&sortByOption={sortByOption}&isSortAscending={isSortAscending}&continuationToken={continuationToken}&$top={$top}&api-version=7.1-preview.1

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
api-version	query	True	string	要使用的 API 版本。 这应设置为“7.1-preview.1”才能使用此版本的 API。
$top	query		integer (int32)	（可选）要返回的令牌数，限制为 100
continuationToken	query		string	（可选）从何处开始返回令牌
displayFilterOption	query		DisplayFilterOptions	（可选）指个人访问令牌的状态（PAT）
isSortAscending	query		boolean	（可选）升序或降序
sortByOption	query		SortByOptions	（可选）要排序依据的字段

响应

名称	类型	说明
200 OK	PagedPatTokens	成功作

安全性

accessToken

个人访问令牌。 将用户名和令牌的任何值用作密码。

类型: basic

示例

List personal access tokens

示例请求

HTTP

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

示例响应

状态代码:

200

{
  "continuationToken": "",
  "patTokens": [
    {
      "displayName": "all_access_token",
      "validTo": "2020-11-23T04:04:38.5233333Z",
      "scope": "app_token",
      "targetAccounts": null,
      "validFrom": "2020-10-24T03:04:57.52Z",
      "authorizationId": "4c60c9ed-a378-4883-af16-d655ca025b11",
      "token": null
    },
    {
      "displayName": "work_token",
      "validTo": "2020-11-23T04:03:55.8033333Z",
      "scope": "vso.work_full",
      "targetAccounts": [
        "38aaa865-2c70-4bf7-a308-0c6539c38c1a"
      ],
      "validFrom": "2020-10-24T03:04:19.1466667Z",
      "authorizationId": "eabb38b2-48ef-440b-959b-b9e6cb37a64e",
      "token": null
    },
    {
      "displayName": "new_token",
      "validTo": "2020-12-01T23:46:23.32Z",
      "scope": "app_token",
      "targetAccounts": [
        "38aaa865-2c70-4bf7-a308-0c6539c38c1a"
      ],
      "validFrom": "2020-11-02T22:56:52.1033333Z",
      "authorizationId": "4ab5764f-4193-4f1d-b995-64144880b7d7",
      "token": null
    },
    {
      "displayName": "analytics_token",
      "validTo": "2020-12-01T23:46:23.32Z",
      "scope": "vso.analytics",
      "targetAccounts": [
        "38aaa865-2c70-4bf7-a308-0c6539c38c1a"
      ],
      "validFrom": "2020-10-29T17:26:46.72Z",
      "authorizationId": "3d3aca0c-9ad3-4b07-8334-08ec8b1ddc32",
      "token": null
    }
  ]
}

定义

名称	说明
DisplayFilterOptions	（可选）指个人访问令牌的状态（PAT）
PagedPatTokens	List 方法返回;包含个人访问令牌（PAT）和继续令牌的列表，用于获取下一页结果
PatToken	表示用于访问 Azure DevOps 资源的个人访问令牌（PAT）
SortByOptions	（可选）要排序依据的字段

DisplayFilterOptions

枚举

（可选）指个人访问令牌的状态（PAT）

值	说明
active	令牌处于活动状态（例如尚未吊销且尚未过期）。
all	包括所有令牌。
expired	令牌已过期，除非使用新的到期日期进行更新，否则不再可用。
revoked	令牌已吊销，不再可用。

PagedPatTokens

Object

List 方法返回;包含个人访问令牌（PAT）和继续令牌的列表，用于获取下一页结果

名称	类型	说明
continuationToken	string	用于访问后续 API 调用中用于列出个人访问令牌（PAT）的结果的下一页
patTokens	PatToken[]	个人访问令牌列表（PAT）

PatToken

Object

表示用于访问 Azure DevOps 资源的个人访问令牌（PAT）

名称	类型	说明
authorizationId	string (uuid)	唯一 guid 标识符
displayName	string	令牌名称
scope	string	用于访问 Azure DevOps 资源的令牌范围
targetAccounts	string[] (uuid)	令牌有效的组织;如果令牌适用于所有用户可访问的组织，则为 null
token	string	创建时生成的唯一令牌字符串
validFrom	string (date-time)	令牌创建日期
validTo	string (date-time)	令牌过期日期

SortByOptions

枚举

（可选）要排序依据的字段

值	说明
displayDate	按显示日期排序
displayName	按显示名称排序
status	按状态排序