Udostępnij za pośrednictwem


Pats - List

Pobiera listę stronicowanych osobistych tokenów dostępu utworzonych w tej organizacji. Kolejne wywołania interfejsu API wymagają dostarczenia tych samych opcji filtrowania.

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 identyfikatora URI

Nazwa W Wymagane Typ Opis
organization
path True

string

Nazwa organizacji usługi Azure DevOps.

api-version
query True

string

Wersja interfejsu API do użycia. Należy ustawić wartość "7.1-preview.1", aby używać tej wersji interfejsu API.

$top
query

integer (int32)

(Opcjonalnie) Liczba zwracanych tokenów, limit 100

continuationToken
query

string

(Opcjonalnie) Skąd zacząć zwracać tokeny z

displayFilterOption
query

DisplayFilterOptions

(Opcjonalnie) Odwołuje się do stanu osobistego tokenu dostępu (PAT)

isSortAscending
query

boolean

(Opcjonalnie) Rosnąco lub malejąco

sortByOption
query

SortByOptions

(Opcjonalnie) Które pole do sortowania według

Odpowiedzi

Nazwa Typ Opis
200 OK

PagedPatTokens

operacja zakończona powodzeniem

Zabezpieczenia

accessToken

Osobisty token dostępu. Użyj dowolnej wartości dla nazwy użytkownika i tokenu jako hasła.

Typ: basic

Przykłady

List personal access tokens

Przykładowe żądanie

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

Przykładowa odpowiedź

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

Definicje

Nazwa Opis
DisplayFilterOptions

(Opcjonalnie) Odwołuje się do stanu osobistego tokenu dostępu (PAT)

PagedPatTokens

Zwrócone przez metodę List; zawiera listę osobistych tokenów dostępu (PATs) i token kontynuacji w celu uzyskania następnej strony wyników

PatToken

Reprezentuje osobisty token dostępu używany do uzyskiwania dostępu do zasobów usługi Azure DevOps

SortByOptions

(Opcjonalnie) Które pole do sortowania według

DisplayFilterOptions

(Opcjonalnie) Odwołuje się do stanu osobistego tokenu dostępu (PAT)

Wartość Opis
active

Token jest aktywny (np. nie został odwołany i nie wygasł).

all

Zawiera wszystkie tokeny.

expired

Token wygasł i nie można go już używać, chyba że zostanie zaktualizowany o nową datę wygaśnięcia.

revoked

Token został odwołany i nie jest już używany.

PagedPatTokens

Zwrócone przez metodę List; zawiera listę osobistych tokenów dostępu (PATs) i token kontynuacji w celu uzyskania następnej strony wyników

Nazwa Typ Opis
continuationToken

string

Służy do uzyskiwania dostępu do następnej strony wyników w kolejnych wywołaniach interfejsu API w celu wyświetlenia listy osobistych tokenów dostępu (PATs)

patTokens

PatToken[]

Lista osobistych tokenów dostępu (PAT)

PatToken

Reprezentuje osobisty token dostępu używany do uzyskiwania dostępu do zasobów usługi Azure DevOps

Nazwa Typ Opis
authorizationId

string (uuid)

Unikatowy identyfikator guid

displayName

string

Nazwa tokenu

scope

string

Zakresy tokenów na potrzeby uzyskiwania dostępu do zasobów usługi Azure DevOps

targetAccounts

string[] (uuid)

Organizacje, dla których token jest prawidłowy; null, jeśli token ma zastosowanie do wszystkich organizacji dostępnych dla użytkownika

token

string

Unikatowy ciąg tokenu wygenerowany podczas tworzenia

validFrom

string (date-time)

Data utworzenia tokenu

validTo

string (date-time)

Data wygaśnięcia tokenu

SortByOptions

(Opcjonalnie) Które pole do sortowania według

Wartość Opis
displayDate

Sortuj według daty wyświetlania

displayName

Sortuj według nazwy wyświetlanej

status

Sortuj według stanu