Pats - Update

Référence

Service:: Tokens

API Version:: 7.1-preview.1

Mises à jour un jeton d’accès personnel (PAT) existant avec les nouveaux paramètres. Pour mettre à jour un jeton, il doit être valide (n’a pas été révoqué).

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
organization	path	True	string	Nom de l’organisation Azure DevOps.
api-version	query	True	string	Version de l’API à utiliser. Cette valeur doit être définie sur « 7.1-preview.1 » pour utiliser cette version de l’API.

Corps de la demande

Nom	Type	Description
allOrgs	boolean	(Facultatif) True si ce jeton d’accès personnel (PAT) est destiné à toutes les organisations accessibles de l’utilisateur. False dans le cas contraire (par exemple, si le jeton est destiné à un organization spécifique)
authorizationId	string	AuthorizationId identifiant un jeton d’accès personnel (PAT) unique
displayName	string	(Facultatif) Nom du jeton
scope	string	(Facultatif) Étendues de jeton pour l’accès aux ressources Azure DevOps
validTo	string	(Facultatif) Date d’expiration du jeton

Réponses

Nom	Type	Description
200 OK	PatTokenResult	opération réussie

Sécurité

accessToken

Jeton d’accès personnel. Utilisez n’importe quelle valeur pour le nom d’utilisateur et le jeton comme mot de passe.

Type: basic

Exemples

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"
}

Définitions

Nom	Description
PatToken	Représente un jeton d’accès personnel (PAT) utilisé pour accéder aux ressources Azure DevOps
PatTokenResult	Contient le jeton d’accès personnel (PAT) résultant et l’erreur (le cas échéant) qui s’est produite pendant l’opération
PatTokenUpdateRequest	Encapsule les paramètres de demande pour la mise à jour d’un jeton d’accès personnel (PAT)
SessionTokenError	Erreur (le cas échéant) qui s’est produite

PatToken

Représente un jeton d’accès personnel (PAT) utilisé pour accéder aux ressources Azure DevOps

Nom	Type	Description
authorizationId	string	Identificateur guid unique
displayName	string	Nom du jeton
scope	string	Étendues de jeton pour l’accès aux ressources Azure DevOps
targetAccounts	string[]	Les organisations pour lesquelles le jeton est valide ; Null si le jeton s’applique à toutes les organisations accessibles de l’utilisateur
token	string	Chaîne de jeton unique générée lors de la création
validFrom	string	Date de création du jeton
validTo	string	Date d’expiration du jeton

PatTokenResult

Contient le jeton d’accès personnel (PAT) résultant et l’erreur (le cas échéant) qui s’est produite pendant l’opération

Nom	Type	Description
patToken	PatToken	Jeton d’accès personnel (PAT) résultant
patTokenError	SessionTokenError	Erreur (le cas échéant) qui s’est produite

PatTokenUpdateRequest

Encapsule les paramètres de demande pour la mise à jour d’un jeton d’accès personnel (PAT)

Nom	Type	Description
allOrgs	boolean	(Facultatif) True si ce jeton d’accès personnel (PAT) est destiné à toutes les organisations accessibles de l’utilisateur. False dans le cas contraire (par exemple, si le jeton est destiné à un organization spécifique)
authorizationId	string	AuthorizationId identifiant un jeton d’accès personnel (PAT) unique
displayName	string	(Facultatif) Nom du jeton
scope	string	(Facultatif) Étendues de jeton pour l’accès aux ressources Azure DevOps
validTo	string	(Facultatif) Date d’expiration du jeton

SessionTokenError

Erreur (le cas échéant) qui s’est produite

Nom	Type	Description
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

Partager via