Share via


Pats - List

Obtient une liste paginée des jetons d’accès personnels (PAT) créés dans cette organization. Les appels ultérieurs à l’API nécessitent que les mêmes options de filtrage soient fournies.

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

Paramètres URI

Nom Dans Obligatoire Type Description
organization
path True

string

Nom de l’organisation Azure DevOps.

api-version
query True

string

Version de l’API à utiliser. Cette valeur doit être définie sur « 7.1-preview.1 » pour utiliser cette version de l’API.

$top
query

integer

int32

(Facultatif) Nombre de jetons à retourner, limite de 100

continuationToken
query

string

(Facultatif) Où commencer à retourner des jetons à partir de

displayFilterOption
query

DisplayFilterOptions

(Facultatif) Fait référence au status du jeton d’accès personnel (PAT)

isSortAscending
query

boolean

(Facultatif) Croissant ou décroissant

sortByOption
query

SortByOptions

(Facultatif) Quel champ trier

Réponses

Nom Type Description
200 OK

PagedPatTokens

opération réussie

Sécurité

accessToken

Jeton d’accès personnel. Utilisez n’importe quelle valeur pour le nom d’utilisateur et le jeton comme mot de passe.

Type: basic

Exemples

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

Définitions

Nom Description
DisplayFilterOptions

(Facultatif) Fait référence au status du jeton d’accès personnel (PAT)

PagedPatTokens

Retourné par la méthode List ; contient une liste de jetons d’accès personnels (PAT) et le jeton de continuation pour obtenir la page de résultats suivante

PatToken

Représente un jeton d’accès personnel (PAT) utilisé pour accéder aux ressources Azure DevOps

SortByOptions

(Facultatif) Quel champ trier

DisplayFilterOptions

(Facultatif) Fait référence au status du jeton d’accès personnel (PAT)

Nom Type Description
active

string

Le jeton est actif (par exemple, n’a pas été révoqué et n’a pas expiré).

all

string

Inclut tous les jetons.

expired

string

Le jeton a expiré et n’est plus utilisable, sauf s’il est mis à jour avec une nouvelle date d’expiration.

revoked

string

Le jeton a été révoqué et n’est plus utilisable.

PagedPatTokens

Retourné par la méthode List ; contient une liste de jetons d’accès personnels (PAT) et le jeton de continuation pour obtenir la page de résultats suivante

Nom Type Description
continuationToken

string

Utilisé pour accéder à la page de résultats suivante dans les appels d’API successifs pour lister les jetons d’accès personnels (PAT)

patTokens

PatToken[]

Liste des jetons d’accès personnels (PAT)

PatToken

Représente un jeton d’accès personnel (PAT) utilisé pour accéder aux ressources Azure DevOps

Nom Type Description
authorizationId

string

Identificateur guid unique

displayName

string

Nom du jeton

scope

string

Étendues de jeton pour l’accès aux ressources Azure DevOps

targetAccounts

string[]

Les organisations pour lesquelles le jeton est valide ; Null si le jeton s’applique à toutes les organisations accessibles de l’utilisateur

token

string

Chaîne de jeton unique générée lors de la création

validFrom

string

Date de création du jeton

validTo

string

Date d’expiration du jeton

SortByOptions

(Facultatif) Quel champ trier

Nom Type Description
displayDate

string

Trier par date d’affichage

displayName

string

Trier par nom d’affichage

status

string

Trier par status