Compartilhar via

Pats - Create

  • Referência
Serviço:
Tokens
Versão da API:
7.1-preview.1

Cria um pat (token de acesso pessoal) para o usuário solicitante.

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

Parâmetros de URI

Nome Em Obrigatório Tipo Description
organization
 path True

string

O nome da organização do Azure DevOps.
api-version
 query True

string

Versão da API a ser usada. Isso deve ser definido como '7.1-preview.1' para usar essa versão da api.

Corpo da solicitação

Nome Tipo Description
allOrgs

boolean

True, se esse PAT (token de acesso pessoal) for para todas as organizações acessíveis do usuário. False, caso contrário (por exemplo, se o token for para uma organização específica)
displayName

string

O nome do token
scope

string

Os escopos de token para acessar recursos do Azure DevOps
validTo

string

A data de validade do token

Respostas

Nome Tipo Description
200 OK

PatTokenResult

operação bem-sucedida

Segurança

accessToken

Token de acesso pessoal. Use qualquer valor para o nome de usuário e o token como a senha.

Tipo: basic

Exemplos

Create a new personal access token

Solicitação de exemplo

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
}

Resposta de exemplo

Código de status:
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"
}

Definições

Nome Description
PatToken

Representa um PAT (token de acesso pessoal) usado para acessar recursos do Azure DevOps
PatTokenCreateRequest

Encapsula os parâmetros de solicitação para criar um pat (token de acesso pessoal)
PatTokenResult

Contém o PAT (token de acesso pessoal) resultante e o erro (se houver) que ocorreu durante a operação
SessionTokenError

O erro (se houver) que ocorreu

PatToken

Object

Representa um PAT (token de acesso pessoal) usado para acessar recursos do Azure DevOps

Nome Tipo Description
authorizationId

string

Identificador de guid exclusivo
displayName

string

O nome do token
scope

string

Os escopos de token para acessar recursos do Azure DevOps
targetAccounts

string[]

As organizações para as quais o token é válido; nulo se o token se aplicar a todas as organizações acessíveis do usuário
token

string

A cadeia de caracteres de token exclusiva gerada na criação
validFrom

string

A data de criação do token
validTo

string

A data de validade do token

PatTokenCreateRequest

Object

Encapsula os parâmetros de solicitação para criar um pat (token de acesso pessoal)

Nome Tipo Description
allOrgs

boolean

True, se esse PAT (token de acesso pessoal) for para todas as organizações acessíveis do usuário. False, caso contrário (por exemplo, se o token for para uma organização específica)
displayName

string

O nome do token
scope

string

Os escopos de token para acessar recursos do Azure DevOps
validTo

string

A data de validade do token

PatTokenResult

Object

Contém o PAT (token de acesso pessoal) resultante e o erro (se houver) que ocorreu durante a operação

Nome Tipo Description
patToken

PatToken

O PAT (token de acesso pessoal) resultante
patTokenError

SessionTokenError

O erro (se houver) que ocorreu

SessionTokenError

Enumeration

O erro (se houver) que ocorreu

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