Pats - Update

Služba:

Tokens

Verze rozhraní API:

7.1-preview.1

Aktualizace existující token PAT (Personal Access Token) s novými parametry. Pokud chcete aktualizovat token, musí být platný (nebyl odvolán).

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
organization	path	True	string	Název organizace Azure DevOps.
api-version	query	True	string	Verze rozhraní API, která se má použít. Aby se tato verze rozhraní API používala, měla by být nastavená na 7.1-preview.1.

Text požadavku

Name	Typ	Description
allOrgs	boolean	(Volitelné) Hodnota True, pokud je tento token PAT (Personal Access Token) určený pro všechny přístupné organizace uživatele. Nepravda, pokud je to jinak (např. pokud je token určený pro konkrétní organizaci)
authorizationId	string	AuthorizationId identifikující jeden jedinečný token PAT (Personal Access Token)
displayName	string	(Volitelné) Název tokenu
scope	string	(Volitelné) Obory tokenů pro přístup k prostředkům Azure DevOps
validTo	string	(Volitelné) Datum vypršení platnosti tokenu

Odpovědi

Name	Typ	Description
200 OK	PatTokenResult	úspěšná operace

Zabezpečení

accessToken

Osobní přístupový token. Jako heslo použijte libovolnou hodnotu pro uživatelské jméno a token.

Typ: basic

Příklady

Update a personal access token by authorizationId

Ukázkový požadavek

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
}

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
PatToken	Představuje token PAT (Personal Access Token) používaný pro přístup k prostředkům Azure DevOps.
PatTokenResult	Obsahuje výsledný token PAT (Personal Access Token) a chybu (pokud existuje), ke které došlo během operace.
PatTokenUpdateRequest	Zapouzdří parametry požadavku pro aktualizaci tokenu PAT (Personal Access Token).
SessionTokenError	Chyba (pokud k nějaké došlo)

PatToken

Object

Představuje token PAT (Personal Access Token) používaný pro přístup k prostředkům Azure DevOps.

Name	Typ	Description
authorizationId	string	Jedinečný identifikátor GUID
displayName	string	Název tokenu
scope	string	Obory tokenů pro přístup k prostředkům Azure DevOps
targetAccounts	string[]	Organizace, pro které je token platný; null, pokud token platí pro všechny přístupné organizace uživatele
token	string	Jedinečný řetězec tokenu vygenerovaný při vytvoření
validFrom	string	Datum vytvoření tokenu
validTo	string	Datum vypršení platnosti tokenu

PatTokenResult

Object

Obsahuje výsledný token PAT (Personal Access Token) a chybu (pokud existuje), ke které došlo během operace.

Name	Typ	Description
patToken	PatToken	Výsledný token PAT (Personal Access Token)
patTokenError	SessionTokenError	Chyba (pokud k nějaké došlo)

PatTokenUpdateRequest

Object

Zapouzdří parametry požadavku pro aktualizaci tokenu PAT (Personal Access Token).

Name	Typ	Description
allOrgs	boolean	(Volitelné) Hodnota True, pokud je tento token PAT (Personal Access Token) určený pro všechny přístupné organizace uživatele. Nepravda, pokud je to jinak (např. pokud je token určený pro konkrétní organizaci)
authorizationId	string	AuthorizationId identifikující jeden jedinečný token PAT (Personal Access Token)
displayName	string	(Volitelné) Název tokenu
scope	string	(Volitelné) Obory tokenů pro přístup k prostředkům Azure DevOps
validTo	string	(Volitelné) Datum vypršení platnosti tokenu

SessionTokenError

Enumeration

Chyba (pokud k nějaké došlo)

Hodnota	Description
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