Pats - Get

リファレンス

サービス:: Tokens

API バージョン:: 7.1-preview.1

1 つの個人用アクセストークン (PAT) を取得します。

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

URI パラメーター

名前	/	必須	型	説明
organization	path	True	string	Azure DevOps 組織の名前です。
api-version	query	True	string	使う API のバージョン。このバージョンの API を使用するには、これを '7.1-preview.1' に設定する必要があります。
authorizationId	query	True	string uuid	1 つの一意の個人用アクセストークン (PAT) を識別する authorizationId

応答

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

セキュリティ

accessToken

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

型: basic

例

Get a personal access token by authorizationId

要求のサンプル

HTTP

GET https://vssps.dev.azure.com/{organization}/_apis/tokens/pats?authorizationId=cf42cc9f-f170-4375-92ba-c13d58a6545f&api-version=7.1-preview.1

応答のサンプル

状態コード:: 200

{
  "patToken": {
    "displayName": "analytics_token",
    "validTo": "2020-12-01T23:46:23.32Z",
    "scope": "vso.analytics",
    "targetAccounts": [
      "38aaa865-2c70-4bf7-a308-0c6539c38c1a"
    ],
    "validFrom": "2020-10-29T17:26:46.72Z",
    "authorizationId": "3d3aca0c-9ad3-4b07-8334-08ec8b1ddc32",
    "token": null
  },
  "patTokenError": "none"
}

定義

名前	説明
PatToken	Azure DevOps リソースへのアクセスに使用される個人用アクセストークン (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	トークンの有効期限

PatTokenResult

Object

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

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

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

次の方法で共有