Compartir a través de

Pats - Create

  • Referencia
Servicio:
Tokens
Versión de la API:
7.1-preview.1

Crea un nuevo token de acceso personal (PAT) para el usuario solicitante.

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

Parámetros de identificador URI

Nombre En Requerido Tipo Description
organization
 path True

string

El nombre de la organización de Azure DevOps.
api-version
 query True

string

Versión de la API que se va a usar. Debe establecerse en "7.1-preview.1" para usar esta versión de la API.

Cuerpo de la solicitud

Nombre Tipo Description
allOrgs

boolean

True, si este token de acceso personal (PAT) es para todas las organizaciones accesibles del usuario. False, si de lo contrario (por ejemplo, si el token es para una organización específica)
displayName

string

Nombre del token
scope

string

Ámbitos de token para acceder a los recursos de Azure DevOps
validTo

string

Fecha de expiración del token

Respuestas

Nombre Tipo Description
200 OK

PatTokenResult

operación correcta

Seguridad

accessToken

Token de acceso personal. Use cualquier valor para el nombre de usuario y el token como contraseña.

Tipo: basic

Ejemplos

Create a new personal access token

Solicitud de ejemplo

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
}

Respuesta de muestra

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

Definiciones

Nombre Description
PatToken

Representa un token de acceso personal (PAT) que se usa para acceder a los recursos de Azure DevOps.
PatTokenCreateRequest

Encapsula los parámetros de solicitud para crear un nuevo token de acceso personal (PAT)
PatTokenResult

Contiene el token de acceso personal (PAT) resultante y el error (si existe) que se produjo durante la operación.
SessionTokenError

Error (si existe) que se produjo

PatToken

Object

Representa un token de acceso personal (PAT) que se usa para acceder a los recursos de Azure DevOps.

Nombre Tipo Description
authorizationId

string

Identificador guid único
displayName

string

Nombre del token
scope

string

Ámbitos de token para acceder a los recursos de Azure DevOps
targetAccounts

string[]

Las organizaciones para las que el token es válido; null si el token se aplica a todas las organizaciones accesibles del usuario
token

string

Cadena de token única generada al crearse
validFrom

string

Fecha de creación del token
validTo

string

Fecha de expiración del token

PatTokenCreateRequest

Object

Encapsula los parámetros de solicitud para crear un nuevo token de acceso personal (PAT)

Nombre Tipo Description
allOrgs

boolean

True, si este token de acceso personal (PAT) es para todas las organizaciones accesibles del usuario. False, si de lo contrario (por ejemplo, si el token es para una organización específica)
displayName

string

Nombre del token
scope

string

Ámbitos de token para acceder a los recursos de Azure DevOps
validTo

string

Fecha de expiración del token

PatTokenResult

Object

Contiene el token de acceso personal (PAT) resultante y el error (si existe) que se produjo durante la operación.

Nombre Tipo Description
patToken

PatToken

Token de acceso personal (PAT) resultante
patTokenError

SessionTokenError

Error (si existe) que se produjo

SessionTokenError

Enumeration

Error (si existe) que se produjo

Valor Description
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