Pats - Update

Referência

Service:: Tokens

API Version:: 7.1-preview.1

Atualizações um PAT (token de acesso pessoal) existente com os novos parâmetros. Para atualizar um token, ele deve ser válido (não foi revogado).

PUT https://vssps.dev.azure.com/{organization}/_apis/tokens/pats?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.

Corpo da solicitação

Nome	Tipo	Description
allOrgs	boolean	(Opcional) True se esse PAT (token de acesso pessoal) for para todas as organizações acessíveis do usuário. False se for o contrário (por exemplo, se o token for para uma organização específica)
authorizationId	string	A authorizationId que identifica um PAT (token de acesso pessoal) único e exclusivo
displayName	string	(Opcional) O nome do token
scope	string	(Opcional) Os escopos de token para acessar recursos do Azure DevOps
validTo	string	(Opcional) A data de validade do token

Respostas

Nome	Tipo	Description
200 OK	PatTokenResult	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

Update a personal access token by authorizationId

Sample Request

HTTP

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

{
  "authorizationId": "3d3aca0c-9ad3-4b07-8334-08ec8b1ddc32",
  "displayName": "updated_token",
  "scope": "vso.analytics",
  "validTo": "2020-12-25T23:46:23.319Z",
  "allOrgs": true
}

Sample Response

Status code:: 200

{
  "patToken": {
    "displayName": "updated_token",
    "validTo": "2020-12-25T23:46:23.32Z",
    "scope": "vso.analytics",
    "targetAccounts": null,
    "validFrom": "2020-10-29T17:26:46.72Z",
    "authorizationId": "3d3aca0c-9ad3-4b07-8334-08ec8b1ddc32",
    "token": null
  },
  "patTokenError": "none"
}

Definições

Nome	Description
PatToken	Representa um PAT (token de acesso pessoal) usado para acessar recursos do Azure DevOps
PatTokenResult	Contém o PAT (token de acesso pessoal) resultante e o erro (se houver) que ocorreu durante a operação
PatTokenUpdateRequest	Encapsula os parâmetros de solicitação para atualizar um PAT (token de acesso pessoal)
SessionTokenError	O erro (se houver) que ocorreu

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

PatTokenResult

Contém o PAT (token de acesso pessoal) resultante e o erro (se houver) que ocorreu durante a operação

Nome	Tipo	Description
patToken	PatToken	O PAT (token de acesso pessoal) resultante
patTokenError	SessionTokenError	O erro (se houver) que ocorreu

PatTokenUpdateRequest

Encapsula os parâmetros de solicitação para atualizar um PAT (token de acesso pessoal)

Nome	Tipo	Description
allOrgs	boolean	(Opcional) True se esse PAT (token de acesso pessoal) for para todas as organizações acessíveis do usuário. False se for o contrário (por exemplo, se o token for para uma organização específica)
authorizationId	string	A authorizationId que identifica um PAT (token de acesso pessoal) único e exclusivo
displayName	string	(Opcional) O nome do token
scope	string	(Opcional) Os escopos de token para acessar recursos do Azure DevOps
validTo	string	(Opcional) A data de validade do token

SessionTokenError

O erro (se houver) que ocorreu

Nome	Tipo	Description
accessDenied	string
authorizationNotFound	string
deploymentHostNotSupported	string
displayNameRequired	string
duplicateHash	string
failedToIssueAccessToken	string
failedToReadTenantPolicy	string
failedToUpdateAccessToken	string
fullScopePatPolicyViolation	string
globalPatPolicyViolation	string
hostAuthorizationNotFound	string
invalidAudience	string
invalidAuthorizationId	string
invalidClient	string
invalidClientId	string
invalidClientType	string
invalidDisplayName	string
invalidScope	string
invalidSource	string
invalidSourceIP	string
invalidSubject	string
invalidTargetAccounts	string
invalidToken	string
invalidTokenType	string
invalidUserId	string
invalidUserType	string
invalidValidTo	string
none	string
patLifespanPolicyViolation	string
sourceNotSupported	string
sshPolicyDisabled	string
tokenNotFound	string
userIdRequired	string

Compartilhar via