Pats - Create

Usługa:

Tokens

Wersja interfejsu API:

7.1-preview.1

Tworzy nowy osobisty token dostępu (PAT) dla żądanego użytkownika.

POST 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. Ta wartość powinna być ustawiona na wartość "7.1-preview.1", aby używać tej wersji interfejsu API.

Treść żądania

Nazwa	Typ	Opis
allOrgs	boolean	Prawda, jeśli ten osobisty token dostępu (PAT) jest przeznaczony dla wszystkich organizacji dostępnych dla użytkownika. Fałsz, jeśli w przeciwnym razie (np. jeśli token jest przeznaczony dla określonej organizacji)
displayName	string	Nazwa tokenu
scope	string	Zakresy tokenu na potrzeby uzyskiwania dostępu do zasobów usługi Azure DevOps
validTo	string	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.

Typ: basic

Przykłady

Create a new personal access token

Przykładowe żądanie

HTTP

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

{
  "displayName": "new_token",
  "scope": "app_token",
  "validTo": "2020-12-01T23:46:23.319Z",
  "allOrgs": false
}

Przykładowa odpowiedź

Kod stanu:

200

{
  "patToken": {
    "displayName": "new_token",
    "validTo": "2020-12-01T23:46:23.32Z",
    "scope": "app_token",
    "targetAccounts": [
      "38aaa865-2c70-4bf7-a308-0c6539c38c1a"
    ],
    "validFrom": "2020-11-02T22:56:52.1033333Z",
    "authorizationId": "4ab5764f-4193-4f1d-b995-64144880b7d7",
    "token": "dip55dwf4vpitomw63jzvomefmi2jluguprzwwqwuc6xq4fhocwq"
  },
  "patTokenError": "none"
}

Definicje

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

PatToken

Object

Reprezentuje osobisty token dostępu 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 tokenu 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 dla użytkownika
token	string	Unikatowy ciąg tokenu wygenerowany podczas tworzenia
validFrom	string	Data utworzenia tokenu
validTo	string	Data wygaśnięcia tokenu

PatTokenCreateRequest

Object

Hermetyzuje parametry żądania do utworzenia nowego osobistego tokenu dostępu (PAT)

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

PatTokenResult

Object

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

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

SessionTokenError

Enumeration

Błąd (jeśli istnieje), który wystąpił

Wartość	Opis
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