Pats - List

Service:

Tokens

API Version:

7.1-preview.1

Obtém uma lista paginada de PATs (tokens de acesso pessoal) criados nesta organização. As chamadas subsequentes à API exigem que as mesmas opções de filtragem sejam fornecidas.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
organization	path	True	string	O nome da organização do Azure DevOps.
api-version	query	True	string	Versão da API a ser usada. Isso deve ser definido como '7.1-preview.1' para usar essa versão da API.
$top	query		integer int32	(Opcional) Quantos tokens retornar, limite de 100
continuationToken	query		string	(Opcional) De onde começar a retornar tokens
displayFilterOption	query		DisplayFilterOptions	(Opcional) Refere-se ao status do PAT (token de acesso pessoal)
isSortAscending	query		boolean	(Opcional) Crescente ou decrescente
sortByOption	query		SortByOptions	(Opcional) Por qual campo classificar

Respostas

Nome	Tipo	Description
200 OK	PagedPatTokens	operação bem-sucedida

Segurança

accessToken

Token de acesso pessoal. Use qualquer valor para o nome de usuário e o token como a senha.

Type: basic

Exemplos

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

Definições

Nome	Description
DisplayFilterOptions	(Opcional) Refere-se ao status do PAT (token de acesso pessoal)
PagedPatTokens	Retornado pelo método List; contém uma lista de PATs (tokens de acesso pessoal) e o token de continuação para obter a próxima página de resultados
PatToken	Representa um PAT (token de acesso pessoal) usado para acessar recursos do Azure DevOps
SortByOptions	(Opcional) Por qual campo classificar

DisplayFilterOptions

(Opcional) Refere-se ao status do PAT (token de acesso pessoal)

Nome	Tipo	Description
active	string	O token está ativo (por exemplo, não foi revogado e não expirou).
all	string	Inclui todos os tokens.
expired	string	O token expirou e não é mais utilizável, a menos que seja atualizado com uma nova data de validade.
revoked	string	O token foi revogado e não é mais utilizável.

PagedPatTokens

Retornado pelo método List; contém uma lista de PATs (tokens de acesso pessoal) e o token de continuação para obter a próxima página de resultados

Nome	Tipo	Description
continuationToken	string	Usado para acessar a próxima página de resultados em sucessivas chamadas à API para listar PATs (tokens de acesso pessoal)
patTokens	PatToken[]	A lista de PATs (tokens de acesso pessoal)

PatToken

Representa um PAT (token de acesso pessoal) usado para acessar recursos do Azure DevOps

Nome	Tipo	Description
authorizationId	string	Identificador de guid exclusivo
displayName	string	O nome do token
scope	string	Os escopos de token para acessar recursos do Azure DevOps
targetAccounts	string[]	As organizações para as quais o token é válido; nulo se o token se aplicar a todas as organizações acessíveis do usuário
token	string	A cadeia de caracteres de token exclusiva gerada na criação
validFrom	string	A data de criação do token
validTo	string	A data de validade do token

SortByOptions

(Opcional) Por qual campo classificar

Nome	Tipo	Description
displayDate	string	Classificar por data de exibição
displayName	string	Classificar por nome de exibição
status	string	Classificar por status