Pats - List

Service:

Tokens

API Version:

7.0-preview.1

Ruft eine ausgelagerte Liste der persönlichen Zugriffstoken (PATs) ab, die in diesem organization erstellt wurden. Für nachfolgende Aufrufe der API müssen dieselben Filteroptionen bereitgestellt werden.

GET https://vssps.dev.azure.com/{organization}/_apis/tokens/pats?api-version=7.0-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.0-preview.1

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
organization	path	True	string	Der Name der Azure DevOps-Organisation.
api-version	query	True	string	Version der zu verwendenden API. Dies sollte auf "7.0-preview.1" festgelegt werden, um diese Version der API zu verwenden.
$top	query		integer int32	(Optional) Wie viele Token zurückgegeben werden sollen, Grenzwert von 100
continuationToken	query		string	(Optional) Wo kann mit der Rückgabe von Token begonnen werden?
displayFilterOption	query		DisplayFilterOptions	(Optional) Bezieht sich auf die status des persönlichen Zugriffstokens (PAT)
isSortAscending	query		boolean	(Optional) Aufsteigend oder absteigend
sortByOption	query		SortByOptions	(Optional) Nach welchem Feld sortiert werden soll

Antworten

Name	Typ	Beschreibung
200 OK	PagedPatTokens	Erfolgreicher Vorgang

Sicherheit

accessToken

Persönliches Zugriffstoken. Verwenden Sie einen beliebigen Wert für den Benutzernamen und das Token als Kennwort.

Type: basic

Beispiele

List personal access tokens

Sample Request

HTTP

GET https://vssps.dev.azure.com/{organization}/_apis/tokens/pats?api-version=7.0-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
    }
  ]
}

Definitionen

Name	Beschreibung
DisplayFilterOptions	(Optional) Bezieht sich auf die status des persönlichen Zugriffstokens (PAT)
PagedPatTokens	Von der List-Methode zurückgegeben; enthält eine Liste der persönlichen Zugriffstoken (PATs) und das Fortsetzungstoken zum Abrufen der nächsten Ergebnisseite
PatToken	Stellt ein persönliches Zugriffstoken (PAT) dar, das für den Zugriff auf Azure DevOps-Ressourcen verwendet wird.
SortByOptions	(Optional) Nach welchem Feld sortiert werden soll

DisplayFilterOptions

(Optional) Bezieht sich auf die status des persönlichen Zugriffstokens (PAT)

Name	Typ	Beschreibung
active	string	Token ist aktiv (z. B. wurde nicht widerrufen und ist nicht abgelaufen).
all	string	Enthält alle Token.
expired	string	Das Token ist abgelaufen und kann nicht mehr verwendet werden, es sei denn, es wird mit einem neuen Ablaufdatum aktualisiert.
revoked	string	Token wurde widerrufen und ist nicht mehr verwendbar.

PagedPatTokens

Von der List-Methode zurückgegeben; enthält eine Liste der persönlichen Zugriffstoken (PATs) und das Fortsetzungstoken zum Abrufen der nächsten Ergebnisseite

Name	Typ	Beschreibung
continuationToken	string	Wird verwendet, um auf die nächste Seite der Ergebnisse in aufeinander folgenden API-Aufrufen zum Auflisten von persönlichen Zugriffstoken (PATs) zuzugreifen
patTokens	PatToken[]	Die Liste der persönlichen Zugriffstoken (PATs)

PatToken

Stellt ein persönliches Zugriffstoken (PAT) dar, das für den Zugriff auf Azure DevOps-Ressourcen verwendet wird.

Name	Typ	Beschreibung
authorizationId	string	Eindeutiger GUID-Bezeichner
displayName	string	Der Tokenname
scope	string	Die Tokenbereiche für den Zugriff auf Azure DevOps-Ressourcen
targetAccounts	string[]	Die Organisationen, für die das Token gültig ist; NULL, wenn das Token für alle zugänglichen Organisationen des Benutzers gilt
token	string	Die bei der Erstellung generierte eindeutige Tokenzeichenfolge
validFrom	string	Das Tokenerstellungsdatum
validTo	string	Das Ablaufdatum des Tokens

SortByOptions

(Optional) Nach welchem Feld sortiert werden soll

Name	Typ	Beschreibung
displayDate	string	Sortieren nach Anzeigedatum
displayName	string	Sortieren nach Anzeigename
status	string	Sortieren nach status