Sdílet prostřednictvím


Pats - List

Získá stránkovaný seznam tokenů PAT vytvořených v této organizaci. Další volání rozhraní API vyžadují zadání stejných možností filtrování.

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

Parametry identifikátoru URI

Name V Vyžadováno Typ Description
organization
path True

string

Název organizace Azure DevOps.

api-version
query True

string

Verze rozhraní API, která se má použít. Tato verze rozhraní API by měla být nastavená na 7.1-preview.1.

$top
query

integer

int32

(Volitelné) Kolik tokenů se má vrátit, limit 100

continuationToken
query

string

(Volitelné) Odkud začít vracet tokeny

displayFilterOption
query

DisplayFilterOptions

(Volitelné) Odkazuje na stav tokenu PAT.

isSortAscending
query

boolean

(Volitelné) Vzestupně nebo sestupně

sortByOption
query

SortByOptions

(Volitelné) Podle kterého pole se má řadit

Odpovědi

Name Typ Description
200 OK

PagedPatTokens

úspěšná operace

Zabezpečení

accessToken

Osobní přístupový token. Jako heslo použijte libovolnou hodnotu pro uživatelské jméno a token.

Type: basic

Příklady

List personal access tokens

Sample Request

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

Sample Response

{
  "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
    }
  ]
}

Definice

Name Description
DisplayFilterOptions

(Volitelné) Odkazuje na stav tokenu PAT.

PagedPatTokens

Vráceno List metoda; obsahuje seznam tokenů PAT a token pro pokračování pro získání další stránky výsledků.

PatToken

Představuje token PAT používaný pro přístup k prostředkům Azure DevOps.

SortByOptions

(Volitelné) Podle kterého pole se má řadit

DisplayFilterOptions

(Volitelné) Odkazuje na stav tokenu PAT.

Name Typ Description
active

string

Token je aktivní (např. nebyl odvolán a nevypršela jeho platnost).

all

string

Zahrnuje všechny tokeny.

expired

string

Platnost tokenu vypršela a není možné ho používat, pokud se neaktualizuje s novým datem vypršení platnosti.

revoked

string

Token byl odvolán a už ho nejde použít.

PagedPatTokens

Vráceno List metoda; obsahuje seznam tokenů PAT a token pro pokračování pro získání další stránky výsledků.

Name Typ Description
continuationToken

string

Používá se pro přístup k další stránce výsledků v následných voláních rozhraní API pro výpis tokenů PAT.

patTokens

PatToken[]

Seznam tokenů PAT

PatToken

Představuje token PAT používaný pro přístup k prostředkům Azure DevOps.

Name Typ Description
authorizationId

string

Jedinečný identifikátor GUID

displayName

string

Název tokenu

scope

string

Obory tokenů pro přístup k prostředkům Azure DevOps

targetAccounts

string[]

Organizace, pro které je token platný; null, pokud token platí pro všechny organizace s podporou přístupnosti uživatele

token

string

Jedinečný řetězec tokenu vygenerovaný při vytvoření

validFrom

string

Datum vytvoření tokenu

validTo

string

Datum vypršení platnosti tokenu

SortByOptions

(Volitelné) Podle kterého pole se má řadit

Name Typ Description
displayDate

string

Seřadit podle data zobrazení

displayName

string

Seřadit podle zobrazované jméno

status

string

Seřadit podle stavu