Pats - Create

服务:

Tokens

API 版本:

7.1-preview.1

为请求用户创建新的个人访问令牌 (PAT) 。

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

URI 参数

名称	在	必需	类型	说明
organization	path	True	string	Azure DevOps 组织的名称。
api-version	query	True	string	要使用的 API 版本。 应将其设置为“7.1-preview.1”才能使用此版本的 API。

请求正文

名称	类型	说明
allOrgs	boolean	如此，如果此个人访问令牌 (PAT) 适用于所有用户的可访问组织。 False，否则 (例如，如果令牌适用于特定组织)
displayName	string	令牌名称
scope	string	用于访问 Azure DevOps 资源的令牌范围
validTo	string	令牌过期日期

响应

名称	类型	说明
200 OK	PatTokenResult	成功的操作

安全性

accessToken

个人访问令牌。 将任何值用作用户名和令牌作为密码。

类型: basic

示例

Create a new personal access token

示例请求

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
}

示例响应

状态代码:

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

定义

名称	说明
PatToken	表示用于访问 Azure DevOps 资源 (PAT) 的个人访问令牌
PatTokenCreateRequest	封装用于创建新的个人访问令牌的请求参数 (PAT)
PatTokenResult	包含生成的个人访问令牌 (PAT) ，如果操作期间发生任何) ，则 (错误
SessionTokenError	如果发生任何) ，则 (错误

PatToken

Object

表示用于访问 Azure DevOps 资源 (PAT) 的个人访问令牌

名称	类型	说明
authorizationId	string	唯一 guid 标识符
displayName	string	令牌名称
scope	string	用于访问 Azure DevOps 资源的令牌范围
targetAccounts	string[]	令牌有效的组织;如果令牌应用于所有用户的可访问组织，则为 null
token	string	创建时生成的唯一令牌字符串
validFrom	string	令牌创建日期
validTo	string	令牌过期日期

PatTokenCreateRequest

Object

封装用于创建新的个人访问令牌的请求参数 (PAT)

名称	类型	说明
allOrgs	boolean	如此，如果此个人访问令牌 (PAT) 适用于所有用户的可访问组织。 False，否则 (例如，如果令牌适用于特定组织)
displayName	string	令牌名称
scope	string	用于访问 Azure DevOps 资源的令牌范围
validTo	string	令牌过期日期

PatTokenResult

Object

包含生成的个人访问令牌 (PAT) ，如果操作期间发生任何) ，则 (错误

名称	类型	说明
patToken	PatToken	生成的个人访问令牌 (PAT)
patTokenError	SessionTokenError	如果发生任何) ，则 (错误

SessionTokenError

Enumeration

如果发生任何) ，则 (错误

值	说明
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