Pats - Update

Service:

Tokens

API Version:

7.1-preview.1

使用新参数 (PAT) 汇报现有的个人访问令牌。 若要更新令牌，该令牌必须有效， (尚未) 撤销。

PUT 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) 适用于所有用户的可访问组织，则为 True。 假 如果否则 (例如，如果令牌是针对特定组织)
authorizationId	string	标识单个唯一个人访问令牌的 authorizationId (PAT)
displayName	string	(可选) 令牌名称
scope	string	(可选) 用于访问 Azure DevOps 资源的令牌范围
validTo	string	(可选) 令牌到期日期

响应

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

安全性

accessToken

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

Type: basic

示例

Update a personal access token by authorizationId

Sample Request

HTTP

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

{
  "authorizationId": "3d3aca0c-9ad3-4b07-8334-08ec8b1ddc32",
  "displayName": "updated_token",
  "scope": "vso.analytics",
  "validTo": "2020-12-25T23:46:23.319Z",
  "allOrgs": true
}

Sample Response

Status code:

200

{
  "patToken": {
    "displayName": "updated_token",
    "validTo": "2020-12-25T23:46:23.32Z",
    "scope": "vso.analytics",
    "targetAccounts": null,
    "validFrom": "2020-10-29T17:26:46.72Z",
    "authorizationId": "3d3aca0c-9ad3-4b07-8334-08ec8b1ddc32",
    "token": null
  },
  "patTokenError": "none"
}

定义

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

PatToken

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

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

PatTokenResult

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

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

PatTokenUpdateRequest

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

名称	类型	说明
allOrgs	boolean	(可选) 如果此个人访问令牌 (PAT) 适用于所有用户的可访问组织，则为 True。 假 如果否则 (例如，如果令牌是针对特定组织)
authorizationId	string	标识单个唯一个人访问令牌的 authorizationId (PAT)
displayName	string	(可选) 令牌名称
scope	string	(可选) 用于访问 Azure DevOps 资源的令牌范围
validTo	string	(可选) 令牌到期日期

SessionTokenError

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

名称	类型	说明
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