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 參數

名稱	位於	必要	類型	Description
organization	path	True	string	Azure DevOps 組織的名稱。
api-version	query	True	string	要使用的 API 版本。 這應該設定為 '7.1-preview.1' 以使用此版本的 API。

要求本文

名稱	類型	Description
allOrgs	boolean	(選擇性) 如果此個人存取權杖 (PAT) 適用于所有使用者的可存取組織，則為 True。 如果否則 (則為 False，例如，如果權杖適用于特定組織)
authorizationId	string	識別單一唯一個人存取權杖的 authorizationId (PAT)
displayName	string	(選擇性) 權杖名稱
scope	string	(選擇性) 存取 Azure DevOps 資源的權杖範圍
validTo	string	(選擇性) 權杖到期日

回應

名稱	類型	Description
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"
}

定義

名稱	Description
PatToken	代表用於存取 Azure DevOps 資源的個人存取權杖 (PAT)
PatTokenResult	包含產生的個人存取權杖 (PAT) ，如果作業期間發生任何) ，則為錯誤 (
PatTokenUpdateRequest	封裝用於更新個人存取權杖的要求參數， (PAT)
SessionTokenError	如果發生任何) ，就會 (錯誤

PatToken

代表用於存取 Azure DevOps 資源的個人存取權杖 (PAT)

名稱	類型	Description
authorizationId	string	唯一 GUID 識別碼
displayName	string	權杖名稱
scope	string	用來存取 Azure DevOps 資源的權杖範圍
targetAccounts	string[]	權杖有效的組織;如果權杖適用于所有使用者的可存取組織，則為 null
token	string	建立時產生的唯一權杖字串
validFrom	string	權杖建立日期
validTo	string	權杖到期日

PatTokenResult

包含產生的個人存取權杖 (PAT) ，如果作業期間發生任何) ，則為錯誤 (

名稱	類型	Description
patToken	PatToken	PAT) 產生的個人存取權杖 (
patTokenError	SessionTokenError	如果發生任何) ，就會 (錯誤

PatTokenUpdateRequest

封裝用於更新個人存取權杖的要求參數， (PAT)

名稱	類型	Description
allOrgs	boolean	(選擇性) 如果此個人存取權杖 (PAT) 適用于所有使用者的可存取組織，則為 True。 如果否則 (則為 False，例如，如果權杖適用于特定組織)
authorizationId	string	識別單一唯一個人存取權杖的 authorizationId (PAT)
displayName	string	(選擇性) 權杖名稱
scope	string	(選擇性) 存取 Azure DevOps 資源的權杖範圍
validTo	string	(選擇性) 權杖到期日

SessionTokenError

如果發生任何) ，就會 (錯誤

名稱	類型	Description
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