Pats - Update

Odwołanie

Service:: Tokens

API Version:: 7.1-preview.1

Aktualizacje istniejącego osobistego tokenu dostępu (PAT) z nowymi parametrami. Aby zaktualizować token, musi być prawidłowy (nie został odwołany).

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
organization	path	True	string	Nazwa organizacji usługi Azure DevOps.
api-version	query	True	string	Wersja interfejsu API do użycia. Powinno to być ustawione na wartość "7.1-preview.1", aby używać tej wersji interfejsu API.

Treść żądania

Nazwa	Typ	Opis
allOrgs	boolean	(Opcjonalnie) Prawda, jeśli ten osobisty token dostępu (PAT) jest przeznaczony dla wszystkich organizacji dostępnych przez użytkownika. Fałsz, jeśli w przeciwnym razie (np. jeśli token jest przeznaczony dla określonej organizacji)
authorizationId	string	Identyfikator autoryzacji identyfikujący pojedynczy, unikatowy osobisty token dostępu (PAT)
displayName	string	(Opcjonalnie) Nazwa tokenu
scope	string	(Opcjonalnie) Zakresy tokenów na potrzeby uzyskiwania dostępu do zasobów usługi Azure DevOps
validTo	string	(Opcjonalnie) Data wygaśnięcia tokenu

Odpowiedzi

Nazwa	Typ	Opis
200 OK	PatTokenResult	operacja zakończona powodzeniem

Zabezpieczenia

accessToken

Osobisty token dostępu. Użyj dowolnej wartości nazwy użytkownika i tokenu jako hasła.

Type: basic

Przykłady

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

Definicje

Nazwa	Opis
PatToken	Reprezentuje osobisty token dostępu (PAT) używany do uzyskiwania dostępu do zasobów usługi Azure DevOps
PatTokenResult	Zawiera wynikowy osobisty token dostępu (PAT) i błąd (jeśli wystąpił) podczas operacji
PatTokenUpdateRequest	Hermetyzuje parametry żądania dotyczące aktualizowania osobistego tokenu dostępu (PAT)
SessionTokenError	Błąd (jeśli wystąpił)

PatToken

Reprezentuje osobisty token dostępu (PAT) używany do uzyskiwania dostępu do zasobów usługi Azure DevOps

Nazwa	Typ	Opis
authorizationId	string	Unikatowy identyfikator guid
displayName	string	Nazwa tokenu
scope	string	Zakresy tokenów na potrzeby uzyskiwania dostępu do zasobów usługi Azure DevOps
targetAccounts	string[]	Organizacje, dla których token jest prawidłowy; null, jeśli token ma zastosowanie do wszystkich organizacji dostępnych przez użytkownika
token	string	Unikatowy ciąg tokenu wygenerowany podczas tworzenia
validFrom	string	Data utworzenia tokenu
validTo	string	Data wygaśnięcia tokenu

PatTokenResult

Zawiera wynikowy osobisty token dostępu (PAT) i błąd (jeśli wystąpił) podczas operacji

Nazwa	Typ	Opis
patToken	PatToken	Wynikowy osobisty token dostępu (PAT)
patTokenError	SessionTokenError	Błąd (jeśli wystąpił)

PatTokenUpdateRequest

Hermetyzuje parametry żądania dotyczące aktualizowania osobistego tokenu dostępu (PAT)

Nazwa	Typ	Opis
allOrgs	boolean	(Opcjonalnie) Prawda, jeśli ten osobisty token dostępu (PAT) jest przeznaczony dla wszystkich organizacji dostępnych przez użytkownika. Fałsz, jeśli w przeciwnym razie (np. jeśli token jest przeznaczony dla określonej organizacji)
authorizationId	string	Identyfikator autoryzacji identyfikujący pojedynczy, unikatowy osobisty token dostępu (PAT)
displayName	string	(Opcjonalnie) Nazwa tokenu
scope	string	(Opcjonalnie) Zakresy tokenów na potrzeby uzyskiwania dostępu do zasobów usługi Azure DevOps
validTo	string	(Opcjonalnie) Data wygaśnięcia tokenu

SessionTokenError

Błąd (jeśli wystąpił)

Nazwa	Typ	Opis
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

Udostępnij za pośrednictwem