Pats - List

リファレンス

Service:: Tokens

API Version:: 7.1-preview.1

このorganizationで作成された個人用アクセストークン (PAT) のページリストを取得します。 API の後続の呼び出しでは、同じフィルターオプションを指定する必要があります。

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

With optional parameters:

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 のバージョン。このバージョンの API を使用するには、これを '7.1-preview.1' に設定する必要があります。
$top	query		integer int32	(省略可能)返されるトークンの数(制限は 100)
continuationToken	query		string	(省略可能)トークンの返しを開始する場所
displayFilterOption	query		DisplayFilterOptions	(省略可能)個人用アクセストークン (PAT) の状態を参照します
isSortAscending	query		boolean	(省略可能)昇順または降順
sortByOption	query		SortByOptions	(省略可能)並べ替えの基準となるフィールド

応答

名前	型	説明
200 OK	PagedPatTokens	正常な操作

セキュリティ

accessToken

個人用アクセストークン。ユーザー名とトークンに任意の値をパスワードとして使用します。

Type: basic

例

List personal access tokens

Sample Request

HTTP

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

Sample Response

Status code:: 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	string	トークンがアクティブです (たとえば、取り消されておらず、有効期限が切れていません)。
all	string	すべてのトークンが含まれます。
expired	string	トークンの有効期限が切れており、新しい有効期限で更新されない限り使用できなくなります。
revoked	string	トークンが取り消され、使用できなくなりました。

PagedPatTokens

List メソッドによって返されます。には、個人用アクセストークン (PAT) の一覧と、結果の次のページを取得するための継続トークンが含まれています

名前	型	説明
continuationToken	string	結果の次のページにアクセスするために使用され、連続する API 呼び出しで個人用アクセストークン (PAT) を一覧表示します。
patTokens	PatToken[]	個人用アクセストークン (PAT) の一覧

PatToken

Azure DevOps リソースへのアクセスに使用される個人用アクセストークン (PAT) を表します

名前	型	説明
authorizationId	string	一意の GUID 識別子
displayName	string	トークン名
scope	string	Azure DevOps リソースにアクセスするためのトークンスコープ
targetAccounts	string[]	トークンが有効な組織。トークンがユーザーのアクセス可能なすべての組織に適用される場合は null
token	string	作成時に生成される一意のトークン文字列
validFrom	string	トークンの作成日
validTo	string	トークンの有効期限

SortByOptions

(省略可能)並べ替えの基準となるフィールド

名前	型	説明
displayDate	string	表示日で並べ替え
displayName	string	表示名で並べ替える
status	string	状態で並べ替え

次の方法で共有