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

要求本文

名前	型	説明
allOrgs	boolean	True の場合、この個人用アクセス トークン (PAT) は、ユーザーのすべてのアクセス可能な組織用です。 False を指定しない場合 (トークンが特定のorganization用の場合など)
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	True の場合、この個人用アクセス トークン (PAT) は、ユーザーのすべてのアクセス可能な組織用です。 False を指定しない場合 (トークンが特定のorganization用の場合など)
displayName	string	トークン名
scope	string	Azure DevOps リソースにアクセスするためのトークン スコープ
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