Pats - Create

Reference

Service:: Tokens

API Version:: 7.1-preview.1

Vytvoří nový token PAT (Personal Access Token) pro žádajícího uživatele.

POST 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	Ano, pokud je tento token PAT určený pro všechny přístupné organizace uživatele. Nepravda, pokud je to jinak (například pokud je token určený pro konkrétní organizaci)
displayName	string	Název tokenu
scope	string	Obory tokenů pro přístup k prostředkům Azure DevOps
validTo	string	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.

Type: basic

Příklady

Create a new personal access token

Sample Request

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
}

Sample Response

Status code:: 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"
}

Definice

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

PatToken

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

PatTokenCreateRequest

Zapouzdří parametry požadavku pro vytvoření nového tokenu PAT (Personal Access Token).

Name	Typ	Description
allOrgs	boolean	Ano, pokud je tento token PAT určený pro všechny přístupné organizace uživatele. Nepravda, pokud je to jinak (například pokud je token určený pro konkrétní organizaci)
displayName	string	Název tokenu
scope	string	Obory tokenů pro přístup k prostředkům Azure DevOps
validTo	string	Datum vypršení platnosti tokenu

PatTokenResult

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)

SessionTokenError

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

Name	Typ	Description
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

Sdílet prostřednictvím