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

Имя	В	Обязательно	Тип	Описание
organization	path	True	string	Название организации Azure DevOps.
api-version	query	True	string	Используемая версия API. Для использования этой версии API необходимо задать значение 7.1-preview.1.

Текст запроса

Имя	Тип	Описание
allOrgs	boolean	(Необязательно) Значение true, если этот личный маркер доступа (PAT) предназначен для всех доступных организаций пользователя. False, если в противном случае (например, если маркер предназначен для определенной организации)
authorizationId	string	Идентификатор авторизации, определяющий один уникальный личный маркер доступа (PAT)
displayName	string	(Необязательно) Имя токена
scope	string	(Необязательно) Области маркера для доступа к ресурсам Azure DevOps
validTo	string	(Необязательно) Дата окончания срока действия маркера

Ответы

Имя	Тип	Описание
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"
}

Определения

Имя	Описание
PatToken	Представляет личный маркер доступа (PAT), используемый для доступа к ресурсам Azure DevOps.
PatTokenResult	Содержит полученный личный маркер доступа (PAT) и ошибку (при наличии), возникшую во время операции.
PatTokenUpdateRequest	Инкапсулирует параметры запроса для обновления личного маркера доступа (PAT)
SessionTokenError	Произошла ошибка (при наличии).

PatToken

Представляет личный маркер доступа (PAT), используемый для доступа к ресурсам Azure DevOps.

Имя	Тип	Описание
authorizationId	string	Уникальный идентификатор GUID
displayName	string	Имя токена
scope	string	Области маркера для доступа к ресурсам Azure DevOps
targetAccounts	string[]	Организации, для которых маркер действителен; значение null, если маркер применяется ко всем организациям, доступным для пользователя.
token	string	Строка уникального маркера, созданная при создании
validFrom	string	Дата создания маркера
validTo	string	Дата окончания срока действия маркера

PatTokenResult

Содержит полученный личный маркер доступа (PAT) и ошибку (при наличии), возникшую во время операции.

Имя	Тип	Описание
patToken	PatToken	Полученный личный маркер доступа (PAT)
patTokenError	SessionTokenError	Произошла ошибка (при наличии).

PatTokenUpdateRequest

Инкапсулирует параметры запроса для обновления личного маркера доступа (PAT)

Имя	Тип	Описание
allOrgs	boolean	(Необязательно) Значение true, если этот личный маркер доступа (PAT) предназначен для всех доступных организаций пользователя. False, если в противном случае (например, если маркер предназначен для определенной организации)
authorizationId	string	Идентификатор авторизации, определяющий один уникальный личный маркер доступа (PAT)
displayName	string	(Необязательно) Имя токена
scope	string	(Необязательно) Области маркера для доступа к ресурсам Azure DevOps
validTo	string	(Необязательно) Дата окончания срока действия маркера

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

Поделиться через