Pats - Create

Référence

Service:: Tokens

API Version:: 7.1-preview.1

Crée un jeton d’accès personnel (PAT) pour l’utilisateur demandeur.

POST 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	True, si ce jeton d’accès personnel (PAT) concerne toutes les organisations accessibles de l’utilisateur. False, dans le cas contraire (par exemple, si le jeton est destiné à un organization spécifique)
displayName	string	Nom du jeton
scope	string	Étendues de jeton pour accéder aux ressources Azure DevOps
validTo	string	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

Create a new personal access token

Sample Request

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
}

Sample Response

Status code:: 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"
}

Définitions

Nom	Description
PatToken	Représente un jeton d’accès personnel (PAT) utilisé pour accéder aux ressources Azure DevOps
PatTokenCreateRequest	Encapsule les paramètres de demande pour la création d’un jeton d’accès personnel (PAT)
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
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 accéder aux ressources Azure DevOps
targetAccounts	string[]	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

PatTokenCreateRequest

Encapsule les paramètres de demande pour la création d’un jeton d’accès personnel (PAT)

Nom	Type	Description
allOrgs	boolean	True, si ce jeton d’accès personnel (PAT) concerne toutes les organisations accessibles de l’utilisateur. False, dans le cas contraire (par exemple, si le jeton est destiné à un organization spécifique)
displayName	string	Nom du jeton
scope	string	Étendues de jeton pour accéder aux ressources Azure DevOps
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

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