Pats - Update

Dienst:

Tokens

API-Version:

7.1-preview.1

Updates ein vorhandenes persönliches Zugriffstoken (PAT) mit den neuen Parametern. Um ein Token zu aktualisieren, muss es gültig sein (wurde nicht widerrufen).

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
organization	path	True	string	Der Name der Azure DevOps-Organisation.
api-version	query	True	string	Version der zu verwendenden API. Dies sollte auf "7.1-preview.1" festgelegt werden, um diese Version der API zu verwenden.

Anforderungstext

Name	Typ	Beschreibung
allOrgs	boolean	(Optional) True, wenn dieses persönliche Zugriffstoken (PAT) für alle zugänglichen Organisationen des Benutzers gilt. False, wenn andernfalls (z. B. wenn das Token für eine bestimmte organization ist)
authorizationId	string	Die authorizationId, die ein einzelnes, eindeutiges persönliches Zugriffstoken (PAT) identifiziert
displayName	string	(Optional) Der Tokenname
scope	string	(Optional) Die Tokenbereiche für den Zugriff auf Azure DevOps-Ressourcen
validTo	string	(Optional) Das Ablaufdatum des Tokens

Antworten

Name	Typ	Beschreibung
200 OK	PatTokenResult	Erfolgreicher Vorgang

Sicherheit

accessToken

Persönliches Zugriffstoken. Verwenden Sie einen beliebigen Wert für den Benutzernamen und das Token als Kennwort.

Typ: basic

Beispiele

Update a personal access token by authorizationId

Beispielanforderung

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
}

Beispiel für eine Antwort

Statuscode:

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

Definitionen

Name	Beschreibung
PatToken	Stellt ein persönliches Zugriffstoken (PAT) dar, das für den Zugriff auf Azure DevOps-Ressourcen verwendet wird.
PatTokenResult	Enthält das resultierende persönliche Zugriffstoken (PAT) und den Fehler (falls vorhanden), der während des Vorgangs aufgetreten ist.
PatTokenUpdateRequest	Kapselt die Anforderungsparameter zum Aktualisieren eines persönlichen Zugriffstokens (PAT)
SessionTokenError	Der fehler (falls vorhanden), der aufgetreten ist

PatToken

Objekt

Stellt ein persönliches Zugriffstoken (PAT) dar, das für den Zugriff auf Azure DevOps-Ressourcen verwendet wird.

Name	Typ	Beschreibung
authorizationId	string	Eindeutiger GUID-Bezeichner
displayName	string	Der Tokenname
scope	string	Die Tokenbereiche für den Zugriff auf Azure DevOps-Ressourcen
targetAccounts	string[]	Die Organisationen, für die das Token gültig ist; NULL, wenn das Token für alle zugänglichen Organisationen des Benutzers gilt
token	string	Die bei der Erstellung generierte eindeutige Tokenzeichenfolge
validFrom	string	Das Tokenerstellungsdatum
validTo	string	Das Ablaufdatum des Tokens

PatTokenResult

Objekt

Enthält das resultierende persönliche Zugriffstoken (PAT) und den Fehler (falls vorhanden), der während des Vorgangs aufgetreten ist.

Name	Typ	Beschreibung
patToken	PatToken	Das resultierende persönliche Zugriffstoken (PAT)
patTokenError	SessionTokenError	Der fehler (falls vorhanden), der aufgetreten ist

PatTokenUpdateRequest

Objekt

Kapselt die Anforderungsparameter zum Aktualisieren eines persönlichen Zugriffstokens (PAT)

Name	Typ	Beschreibung
allOrgs	boolean	(Optional) True, wenn dieses persönliche Zugriffstoken (PAT) für alle zugänglichen Organisationen des Benutzers gilt. False, wenn andernfalls (z. B. wenn das Token für eine bestimmte organization ist)
authorizationId	string	Die authorizationId, die ein einzelnes, eindeutiges persönliches Zugriffstoken (PAT) identifiziert
displayName	string	(Optional) Der Tokenname
scope	string	(Optional) Die Tokenbereiche für den Zugriff auf Azure DevOps-Ressourcen
validTo	string	(Optional) Das Ablaufdatum des Tokens

SessionTokenError

Enumeration

Der fehler (falls vorhanden), der aufgetreten ist

Wert	Beschreibung
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