Pats - Update

Layanan:

Tokens

Versi API:

7.1-preview.1

Updates token akses pribadi (PAT) yang ada dengan parameter baru. Untuk memperbarui token, token harus valid (belum dicabut).

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
organization	path	True	string	Nama organisasi Azure DevOps.
api-version	query	True	string	Versi API yang akan digunakan. Ini harus diatur ke '7.1-preview.1' untuk menggunakan versi api ini.

Isi Permintaan

Nama	Jenis	Deskripsi
allOrgs	boolean	(Opsional) Benar jika token akses pribadi (PAT) ini untuk semua organisasi pengguna yang dapat diakses. False jika sebaliknya (misalnya jika token adalah untuk organisasi tertentu)
authorizationId	string	AuthorizationId mengidentifikasi satu token akses pribadi unik (PAT)
displayName	string	(Opsional) Nama token
scope	string	(Opsional) Cakupan token untuk mengakses sumber daya Azure DevOps
validTo	string	(Opsional) Tanggal kedaluwarsa token

Respons

Nama	Jenis	Deskripsi
200 OK	PatTokenResult	operasi berhasil

Keamanan

accessToken

Token akses pribadi. Gunakan nilai apa pun untuk nama pengguna dan token sebagai kata sandi.

Jenis: basic

Contoh

Update a personal access token by authorizationId

Permintaan sampel

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
}

Respon sampel

Kode status:

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

Definisi

Nama	Deskripsi
PatToken	Mewakili token akses pribadi (PAT) yang digunakan untuk mengakses sumber daya Azure DevOps
PatTokenResult	Berisi token akses pribadi (PAT) yang dihasilkan dan kesalahan (jika ada) yang terjadi selama operasi
PatTokenUpdateRequest	Merangkum parameter permintaan untuk memperbarui token akses pribadi (PAT)
SessionTokenError	Kesalahan (jika ada) yang terjadi

PatToken

Objek

Mewakili token akses pribadi (PAT) yang digunakan untuk mengakses sumber daya Azure DevOps

Nama	Jenis	Deskripsi
authorizationId	string	Pengidentifikasi guid unik
displayName	string	Nama token
scope	string	Cakupan token untuk mengakses sumber daya Azure DevOps
targetAccounts	string[]	Organisasi yang tokennya valid; null jika token berlaku untuk semua organisasi pengguna yang dapat diakses
token	string	String token unik yang dihasilkan saat pembuatan
validFrom	string	Tanggal pembuatan token
validTo	string	Tanggal kedaluwarsa token

PatTokenResult

Objek

Berisi token akses pribadi (PAT) yang dihasilkan dan kesalahan (jika ada) yang terjadi selama operasi

Nama	Jenis	Deskripsi
patToken	PatToken	Token akses pribadi (PAT) yang dihasilkan
patTokenError	SessionTokenError	Kesalahan (jika ada) yang terjadi

PatTokenUpdateRequest

Objek

Merangkum parameter permintaan untuk memperbarui token akses pribadi (PAT)

Nama	Jenis	Deskripsi
allOrgs	boolean	(Opsional) Benar jika token akses pribadi (PAT) ini untuk semua organisasi pengguna yang dapat diakses. False jika sebaliknya (misalnya jika token adalah untuk organisasi tertentu)
authorizationId	string	AuthorizationId mengidentifikasi satu token akses pribadi unik (PAT)
displayName	string	(Opsional) Nama token
scope	string	(Opsional) Cakupan token untuk mengakses sumber daya Azure DevOps
validTo	string	(Opsional) Tanggal kedaluwarsa token

SessionTokenError

Enumeration

Kesalahan (jika ada) yang terjadi

Nilai	Deskripsi
accessDenied
authorizationNotFound
deploymentHostNotSupported
displayNameRequired
duplicateHash
failedToIssueAccessToken
failedToReadTenantPolicy
failedToUpdateAccessToken
fullScopePatPolicyViolation
globalPatPolicyViolation
hostAuthorizationNotFound
invalidAudience
invalidAuthorizationId
invalidClient
invalidClientId
invalidClientType
invalidDisplayName
invalidScope
invalidSource
invalidSourceIP
invalidSubject
invalidTargetAccounts
invalidToken
invalidTokenType
invalidUserId
invalidUserType
invalidValidTo
none
patLifespanPolicyViolation
sourceNotSupported
sshPolicyDisabled
tokenNotFound
userIdRequired