Pats - Update

Servizio:

Tokens

Versione API:

7.1-preview.1

Aggiornamenti un token di accesso personale esistente con i nuovi parametri. Per aggiornare un token, deve essere valido (non è stato revocato).

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
organization	path	True	string	Nome dell'organizzazione di Azure DevOps.
api-version	query	True	string	Versione dell'API da usare. Questa opzione deve essere impostata su '7.1-preview.1' per usare questa versione dell'API.

Corpo della richiesta

Nome	Tipo	Descrizione
allOrgs	boolean	(Facoltativo) True se questo token di accesso personale (PAT) è per tutte le organizzazioni accessibili dell'utente. False se in caso contrario ,ad esempio se il token è per un'organizzazione specifica)
authorizationId	string	AuthorizationId che identifica un singolo token di accesso personale univoco (PAT)
displayName	string	(Facoltativo) Nome del token
scope	string	(Facoltativo) Ambiti del token per l'accesso alle risorse di Azure DevOps
validTo	string	(Facoltativo) Data di scadenza del token

Risposte

Nome	Tipo	Descrizione
200 OK	PatTokenResult	operazione riuscita

Sicurezza

accessToken

Token di accesso personale. Usare qualsiasi valore per il nome utente e il token come password.

Tipo: basic

Esempio

Update a personal access token by authorizationId

Esempio di richiesta

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
}

Risposta di esempio

Codice di stato:

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

Definizioni

Nome	Descrizione
PatToken	Rappresenta un token di accesso personale (PAT) usato per accedere alle risorse di Azure DevOps
PatTokenResult	Contiene il token di accesso personale risultante (PAT) e l'errore (se presente) che si è verificato durante l'operazione
PatTokenUpdateRequest	Incapsula i parametri della richiesta per l'aggiornamento di un token di accesso personale (PAT)
SessionTokenError	Errore (se presente) che si è verificato

PatToken

Object

Rappresenta un token di accesso personale (PAT) usato per accedere alle risorse di Azure DevOps

Nome	Tipo	Descrizione
authorizationId	string	Identificatore guid univoco
displayName	string	Nome del token
scope	string	Ambiti del token per l'accesso alle risorse di Azure DevOps
targetAccounts	string[]	Le organizzazioni per cui il token è valido; Null se il token si applica a tutte le organizzazioni accessibili dell'utente
token	string	Stringa di token univoca generata alla creazione
validFrom	string	Data di creazione del token
validTo	string	Data di scadenza del token

PatTokenResult

Object

Contiene il token di accesso personale risultante (PAT) e l'errore (se presente) che si è verificato durante l'operazione

Nome	Tipo	Descrizione
patToken	PatToken	Token di accesso personale risultante (PAT)
patTokenError	SessionTokenError	Errore (se presente) che si è verificato

PatTokenUpdateRequest

Object

Incapsula i parametri della richiesta per l'aggiornamento di un token di accesso personale (PAT)

Nome	Tipo	Descrizione
allOrgs	boolean	(Facoltativo) True se questo token di accesso personale (PAT) è per tutte le organizzazioni accessibili dell'utente. False se in caso contrario ,ad esempio se il token è per un'organizzazione specifica)
authorizationId	string	AuthorizationId che identifica un singolo token di accesso personale univoco (PAT)
displayName	string	(Facoltativo) Nome del token
scope	string	(Facoltativo) Ambiti del token per l'accesso alle risorse di Azure DevOps
validTo	string	(Facoltativo) Data di scadenza del token

SessionTokenError

Enumeration

Errore (se presente) che si è verificato

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