Pats - Create
为请求用户创建新的个人访问令牌 (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 版本。 应将其设置为“7.1-preview.1”才能使用此版本的 API。 |
请求正文
名称 | 类型 | 说明 |
---|---|---|
allOrgs |
boolean |
如此,如果此个人访问令牌 (PAT) 适用于所有用户的可访问组织。 False,否则 (例如,如果令牌适用于特定组织) |
displayName |
string |
令牌名称 |
scope |
string |
用于访问 Azure DevOps 资源的令牌范围 |
validTo |
string |
令牌过期日期 |
响应
名称 | 类型 | 说明 |
---|---|---|
200 OK |
成功的操作 |
安全性
accessToken
个人访问令牌。 将任何值用作用户名和令牌作为密码。
Type:
basic
示例
Create a new personal access token
Sample Request
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
}
Sample Response
{
"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"
}
定义
名称 | 说明 |
---|---|
Pat |
表示用于访问 Azure DevOps 资源 (PAT) 的个人访问令牌 |
Pat |
封装用于创建新的个人访问令牌的请求参数 (PAT) |
Pat |
包含生成的个人访问令牌 (PAT) ,如果操作期间发生任何) ,则 (错误 |
Session |
如果发生任何) ,则 (错误 |
PatToken
表示用于访问 Azure DevOps 资源 (PAT) 的个人访问令牌
名称 | 类型 | 说明 |
---|---|---|
authorizationId |
string |
唯一 guid 标识符 |
displayName |
string |
令牌名称 |
scope |
string |
用于访问 Azure DevOps 资源的令牌范围 |
targetAccounts |
string[] |
令牌有效的组织;如果令牌应用于所有用户的可访问组织,则为 null |
token |
string |
创建时生成的唯一令牌字符串 |
validFrom |
string |
令牌创建日期 |
validTo |
string |
令牌过期日期 |
PatTokenCreateRequest
封装用于创建新的个人访问令牌的请求参数 (PAT)
名称 | 类型 | 说明 |
---|---|---|
allOrgs |
boolean |
如此,如果此个人访问令牌 (PAT) 适用于所有用户的可访问组织。 False,否则 (例如,如果令牌适用于特定组织) |
displayName |
string |
令牌名称 |
scope |
string |
用于访问 Azure DevOps 资源的令牌范围 |
validTo |
string |
令牌过期日期 |
PatTokenResult
包含生成的个人访问令牌 (PAT) ,如果操作期间发生任何) ,则 (错误
名称 | 类型 | 说明 |
---|---|---|
patToken |
生成的个人访问令牌 (PAT) |
|
patTokenError |
如果发生任何) ,则 (错误 |
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 |