Pats - Update

リファレンス

サービス:: Tokens

API バージョン:: 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 のバージョン。このバージョンの API を使用するには、これを '7.1-preview.1' に設定する必要があります。

要求本文

名前	型	説明
allOrgs	boolean	(省略可能)True を指定すると、この個人用アクセストークン (PAT) は、ユーザーのすべてのアクセス可能な組織に対するものです。それ以外の場合は False (トークンが特定のorganization用の場合など)
authorizationId	string	1 つの一意の個人用アクセストークン (PAT) を識別する authorizationId
displayName	string	(省略可能)トークン名
scope	string	(省略可能)Azure DevOps リソースにアクセスするためのトークンスコープ
validTo	string	(省略可能)トークンの有効期限

応答

名前	型	説明
200 OK	PatTokenResult	成功した操作

セキュリティ

accessToken

個人用アクセストークン。ユーザー名とトークンに任意の値をパスワードとして使用します。

型: basic

例

Update a personal access token by authorizationId

要求のサンプル

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
}

応答のサンプル

状態コード:: 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

Object

Azure DevOps リソースへのアクセスに使用される個人用アクセストークン (PAT) を表します

名前	型	説明
authorizationId	string	一意の guid 識別子
displayName	string	トークン名
scope	string	Azure DevOps リソースにアクセスするためのトークンスコープ
targetAccounts	string[]	トークンが有効な組織。トークンがユーザーのすべてのアクセス可能な組織に適用される場合は null
token	string	作成時に生成される一意のトークン文字列
validFrom	string	トークンの作成日
validTo	string	トークンの有効期限

PatTokenResult

Object

結果として得られる個人用アクセストークン (PAT) と、操作中に発生したエラー (存在する場合) が含まれます

名前	型	説明
patToken	PatToken	結果として得られる個人用アクセストークン (PAT)
patTokenError	SessionTokenError	発生したエラー (存在する場合)

PatTokenUpdateRequest

Object

個人用アクセストークン (PAT) を更新するための要求パラメーターをカプセル化します

名前	型	説明
allOrgs	boolean	(省略可能)True を指定すると、この個人用アクセストークン (PAT) は、ユーザーのすべてのアクセス可能な組織に対するものです。それ以外の場合は False (トークンが特定のorganization用の場合など)
authorizationId	string	1 つの一意の個人用アクセストークン (PAT) を識別する authorizationId
displayName	string	(省略可能)トークン名
scope	string	(省略可能)Azure DevOps リソースにアクセスするためのトークンスコープ
validTo	string	(省略可能)トークンの有効期限

SessionTokenError

列挙

発生したエラー (存在する場合)

値	説明
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

次の方法で共有

Pats - Update

URI パラメーター

要求本文

応答

セキュリティ

accessToken

例

Update a personal access token by authorizationId

要求のサンプル

応答のサンプル

定義

PatToken

PatTokenResult

PatTokenUpdateRequest

SessionTokenError

その他のリソース