Pats - Create

Riferimento

Service:: Tokens

API Version:: 7.1-preview.1

Crea un nuovo token di accesso personale (PAT) per l'utente che richiede.

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

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
organization	path	True	string	Nome dell'organizzazione di Azure DevOps.
api-version	query	True	string	Versione dell'API da usare. Questa opzione deve essere impostata su '7.1-preview.1' per usare questa versione dell'API.

Corpo della richiesta

Nome	Tipo	Descrizione
allOrgs	boolean	True, se questo token di accesso personale (PAT) è per tutte le organizzazioni accessibili dell'utente. False, se in caso contrario ,ad esempio se il token è per un'organizzazione specifica)
displayName	string	Nome del token
scope	string	Ambiti del token per l'accesso alle risorse di Azure DevOps
validTo	string	Data di scadenza del token

Risposte

Nome	Tipo	Descrizione
200 OK	PatTokenResult	operazione riuscita

Sicurezza

accessToken

Token di accesso personale. Usare qualsiasi valore per il nome utente e il token come password.

Type: basic

Esempio

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

Definizioni

Nome	Descrizione
PatToken	Rappresenta un token di accesso personale (PAT) usato per accedere alle risorse di Azure DevOps
PatTokenCreateRequest	Incapsula i parametri della richiesta per la creazione di un nuovo token di accesso personale (PAT)
PatTokenResult	Contiene il token di accesso personale risultante (PAT) e l'errore (se presente) che si è verificato durante l'operazione
SessionTokenError	Errore (se presente) che si è verificato

PatToken

Rappresenta un token di accesso personale (PAT) usato per accedere alle risorse di Azure DevOps

Nome	Tipo	Descrizione
authorizationId	string	Identificatore guid univoco
displayName	string	Nome del token
scope	string	Ambiti del token per l'accesso alle risorse di Azure DevOps
targetAccounts	string[]	Le organizzazioni per cui il token è valido; Null se il token si applica a tutte le organizzazioni accessibili dell'utente
token	string	Stringa di token univoca generata alla creazione
validFrom	string	Data di creazione del token
validTo	string	Data di scadenza del token

PatTokenCreateRequest

Incapsula i parametri della richiesta per la creazione di un nuovo token di accesso personale (PAT)

Nome	Tipo	Descrizione
allOrgs	boolean	True, se questo token di accesso personale (PAT) è per tutte le organizzazioni accessibili dell'utente. False, se in caso contrario ,ad esempio se il token è per un'organizzazione specifica)
displayName	string	Nome del token
scope	string	Ambiti del token per l'accesso alle risorse di Azure DevOps
validTo	string	Data di scadenza del token

PatTokenResult

Contiene il token di accesso personale risultante (PAT) e l'errore (se presente) che si è verificato durante l'operazione

Nome	Tipo	Descrizione
patToken	PatToken	Token di accesso personale risultante (PAT)
patTokenError	SessionTokenError	Errore (se presente) che si è verificato

SessionTokenError

Errore (se presente) che si è verificato

Nome	Tipo	Descrizione
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

Condividi tramite