Pats - Create

Erstellt ein neues persönliches Zugriffstoken (PAT) für den anfordernden Benutzer.

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

URI-Parameter

Name In Erforderlich Typ Beschreibung
organization
path True

string

Der Name der Azure DevOps-Organisation.

api-version
query True

string

Version der zu verwendenden API. Dies sollte auf "7.0-preview.1" festgelegt werden, um diese Version der API zu verwenden.

Anforderungstext

Name Typ Beschreibung
allOrgs

boolean

True, wenn dieses persönliche Zugriffstoken (PAT) für alle zugänglichen Organisationen des Benutzers gilt. False, falls andernfalls (z. B. wenn das Token für eine bestimmte organization ist)

displayName

string

Der Tokenname

scope

string

Die Tokenbereiche für den Zugriff auf Azure DevOps-Ressourcen

validTo

string

Das Ablaufdatum des Tokens

Antworten

Name Typ Beschreibung
200 OK

PatTokenResult

Erfolgreicher Vorgang

Sicherheit

accessToken

Persönliches Zugriffstoken. Verwenden Sie einen beliebigen Wert für den Benutzernamen und das Token als Kennwort.

Type: basic

Beispiele

Create a new personal access token

Sample Request

POST https://vssps.dev.azure.com/{organization}/_apis/tokens/pats?api-version=7.0-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"
}

Definitionen

Name Beschreibung
PatToken

Stellt ein persönliches Zugriffstoken (PAT) dar, das für den Zugriff auf Azure DevOps-Ressourcen verwendet wird.

PatTokenCreateRequest

Kapselt die Anforderungsparameter zum Erstellen eines neuen persönlichen Zugriffstokens (PAT)

PatTokenResult

Enthält das resultierende persönliche Zugriffstoken (PAT) und den Fehler (falls vorhanden), der während des Vorgangs aufgetreten ist.

SessionTokenError

Der fehler (falls vorhanden), der aufgetreten ist

PatToken

Stellt ein persönliches Zugriffstoken (PAT) dar, das für den Zugriff auf Azure DevOps-Ressourcen verwendet wird.

Name Typ Beschreibung
authorizationId

string

Eindeutiger GUID-Bezeichner

displayName

string

Der Tokenname

scope

string

Die Tokenbereiche für den Zugriff auf Azure DevOps-Ressourcen

targetAccounts

string[]

Die Organisationen, für die das Token gültig ist; NULL, wenn das Token für alle zugänglichen Organisationen des Benutzers gilt

token

string

Die bei der Erstellung generierte eindeutige Tokenzeichenfolge

validFrom

string

Das Tokenerstellungsdatum

validTo

string

Das Ablaufdatum des Tokens

PatTokenCreateRequest

Kapselt die Anforderungsparameter zum Erstellen eines neuen persönlichen Zugriffstokens (PAT)

Name Typ Beschreibung
allOrgs

boolean

True, wenn dieses persönliche Zugriffstoken (PAT) für alle zugänglichen Organisationen des Benutzers gilt. False, falls andernfalls (z. B. wenn das Token für eine bestimmte organization ist)

displayName

string

Der Tokenname

scope

string

Die Tokenbereiche für den Zugriff auf Azure DevOps-Ressourcen

validTo

string

Das Ablaufdatum des Tokens

PatTokenResult

Enthält das resultierende persönliche Zugriffstoken (PAT) und den Fehler (falls vorhanden), der während des Vorgangs aufgetreten ist.

Name Typ Beschreibung
patToken

PatToken

Das resultierende persönliche Zugriffstoken (PAT)

patTokenError

SessionTokenError

Der fehler (falls vorhanden), der aufgetreten ist

SessionTokenError

Der fehler (falls vorhanden), der aufgetreten ist

Name Typ Beschreibung
accessDenied

string

authorizationNotFound

string

displayNameRequired

string

duplicateHash

string

failedToIssueAccessToken

string

failedToReadTenantPolicy

string

failedToUpdateAccessToken

string

fullScopePatPolicyViolation

string

globalPatPolicyViolation

string

hostAuthorizationNotFound

string

invalidAuthorizationId

string

invalidClient

string

invalidClientId

string

invalidClientType

string

invalidDisplayName

string

invalidScope

string

invalidSource

string

invalidSourceIP

string

invalidTargetAccounts

string

invalidToken

string

invalidUserId

string

invalidUserType

string

invalidValidTo

string

none

string

patLifespanPolicyViolation

string

sourceNotSupported

string

sshPolicyDisabled

string

tokenNotFound

string

userIdRequired

string