User Entitlements - Get User Entitlement

Referensi

Layanan:: Member Entitlement Management

Versi API:: 5.1-preview.2

Mendapatkan Hak Pengguna untuk pengguna.

GET https://vsaex.dev.azure.com/{organization}/_apis/userentitlements/{userId}?api-version=5.1-preview.2

Parameter URI

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

Respons

Nama	Jenis	Deskripsi
200 OK	UserEntitlement	operasi berhasil

Keamanan

oauth2

Jenis: oauth2
Alur: accessCode
URL Otorisasi: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL token: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Cakupan

Nama	Deskripsi
vso.memberentitlementmanagement	Memberikan kemampuan untuk membaca pengguna, lisensi mereka serta proyek dan ekstensi yang dapat mereka akses

Contoh

Permintaan sampel

HTTP

GET https://vsaex.dev.azure.com/{organization}/_apis/userentitlements/fe2f1bdb-9779-491a-a6f6-c6e9322cfb00?api-version=5.1-preview.2

Respon sampel

Kode status:: 200

{
  "id": "fe2f1bdb-9779-491a-a6f6-c6e9322cfb00",
  "user": {
    "subjectKind": "user",
    "metaType": "member",
    "domain": "14c5367e-ee12-4c94-98b8-b52c1fe3cfb1",
    "principalName": "user1@fabrikam.com",
    "mailAddress": "user1@fabrikam.com",
    "origin": "aad",
    "originId": "00000000-0000-0000-0000-000000000000",
    "displayName": "User 1",
    "_links": {
      "self": {
        "href": "https://vssps.dev.azure.com/fabrikam/_apis/graph/users/aad.wUGM3IDZ1UTZzczNtkTZmJWLiRzY30yNyE2MtcDNmFTOzMjY"
      },
      "memberships": {
        "href": "https://vssps.dev.azure.com/fabrikam/_apis/graph/memberships/aad.wUGM3IDZ1UTZzczNtkTZmJWLiRzY30yNyE2MtcDNmFTOzMjY"
      },
      "membershipState": {
        "href": "https://vssps.dev.azure.com/fabrikam/_apis/graph/membershipstates/aad.wUGM3IDZ1UTZzczNtkTZmJWLiRzY30yNyE2MtcDNmFTOzMjY"
      },
      "storageKey": {
        "href": "https://vssps.dev.azure.com/fabrikam/_apis/graph/storagekeys/aad.wUGM3IDZ1UTZzczNtkTZmJWLiRzY30yNyE2MtcDNmFTOzMjY"
      }
    },
    "url": "https://vssps.dev.azure.com/fabrikam/_apis/graph/users/aad.wUGM3IDZ1UTZzczNtkTZmJWLiRzY30yNyE2MtcDNmFTOzMjY",
    "descriptor": "aad.wUGM3IDZ1UTZzczNtkTZmJWLiRzY30yNyE2MtcDNmFTOzMjY"
  },
  "accessLevel": {
    "licensingSource": "account",
    "accountLicenseType": "stakeholder",
    "msdnLicenseType": "none",
    "licenseDisplayName": "Stakeholder",
    "status": "active",
    "statusMessage": "",
    "assignmentSource": "unknown"
  },
  "lastAccessedDate": "0001-01-01T00:00:00Z",
  "projectEntitlements": [],
  "extensions": [],
  "groupAssignments": []
}

Definisi

Nama	Deskripsi
AccessLevel	Lisensi yang ditetapkan untuk pengguna
AccountLicenseType	Jenis Lisensi Akun (misalnya Ekspres, Pemangku Kepentingan, dll.)
AccountUserStatus	Status pengguna di akun
AssignmentSource	Sumber Penugasan Lisensi (misalnya Grup, Tidak Diketahui, dll.
Extension	Ekstensi yang ditetapkan untuk pengguna
GraphGroup	Entitas grup grafik
GraphUser	Entitas pengguna grafik
Group	Grup Proyek (misalnya Kontributor, Pembaca, dll.)
GroupEntitlement	Entitas grup dengan properti tambahan termasuk lisensi, ekstensi, dan keanggotaan proyeknya
GroupLicensingRuleStatus	Status aturan grup.
GroupType	Jenis Grup
LicensingSource	Sumber Lisensi (misalnya Akun. MSDN dll.)
MsdnLicenseType	Jenis Lisensi MSDN (misalnya Visual Studio Professional, Visual Studio Enterprise, dll.)
ProjectEntitlement	Hubungan antara proyek dan izin efektif pengguna dalam proyek tersebut.
ProjectPermissionInherited	Apakah pengguna mewarisi izin ke proyek melalui azure DevOps atau keanggotaan grup AAD.
ProjectRef	Referensi ke proyek
ReferenceLinks	Kelas untuk mewakili kumpulan tautan referensi REST.
TeamRef	Referensi ke tim
UserEntitlement	Entitas pengguna dengan properti tambahan termasuk lisensi, ekstensi, dan keanggotaan proyek mereka

AccessLevel

Objek

Lisensi yang ditetapkan untuk pengguna

Nama	Jenis	Deskripsi
accountLicenseType	AccountLicenseType	Jenis Lisensi Akun (misalnya Ekspres, Pemangku Kepentingan, dll.)
assignmentSource	AssignmentSource	Sumber Penugasan Lisensi (misalnya Grup, Tidak Diketahui, dll.
licenseDisplayName	string	Nama tampilan Lisensi
licensingSource	LicensingSource	Sumber Lisensi (misalnya Akun. MSDN dll.)
msdnLicenseType	MsdnLicenseType	Jenis Lisensi MSDN (misalnya Visual Studio Professional, Visual Studio Enterprise, dll.)
status	AccountUserStatus	Status pengguna di akun
statusMessage	string	Pesan status.

AccountLicenseType

Enumeration

Jenis Lisensi Akun (misalnya Ekspres, Pemangku Kepentingan, dll.)

Nilai	Deskripsi
advanced
earlyAdopter
express
none
professional
stakeholder

AccountUserStatus

Enumeration

Status pengguna di akun

Nilai	Deskripsi
active	Pengguna telah masuk setidaknya sekali ke akun VSTS
deleted	Pengguna dihapus dari akun VSTS oleh admin akun VSTS
disabled	Pengguna tidak dapat masuk; terutama digunakan oleh admin untuk menghapus pengguna untuk sementara waktu karena tidak ada atau realokasi lisensi
expired	Pengguna dapat masuk; terutama digunakan ketika lisensi dalam status kedaluwarsa dan kami memberikan masa tenggang
none
pending	Pengguna diundang untuk bergabung dengan akun VSTS oleh admin akun VSTS, tetapi belum mendaftar/masuk
pendingDisabled	Pengguna dinonaktifkan; jika dapat diaktifkan kembali, mereka masih akan berada dalam status Tertunda

AssignmentSource

Enumeration

Sumber Penugasan Lisensi (misalnya Grup, Tidak Diketahui, dll.

Nilai	Deskripsi
groupRule
none
unknown

Extension

Objek

Ekstensi yang ditetapkan untuk pengguna

Nama	Jenis	Deskripsi
assignmentSource	AssignmentSource	Sumber penugasan untuk ekstensi ini. Yaitu secara eksplisit ditetapkan atau dari aturan grup.
id	string	ID Galeri Ekstensi.
name	string	Nama ekstensi yang mudah diingat.
source	LicensingSource	Sumber penetapan ekstensi ini. Misalnya: msdn, akun, tidak ada, dll.

GraphGroup

Objek

Entitas grup grafik

Nama	Jenis	Deskripsi
_links	ReferenceLinks	Bidang ini berisi nol atau lebih tautan menarik tentang subjek grafik. Tautan ini dapat dipanggil untuk mendapatkan hubungan tambahan atau informasi lebih rinci tentang subjek grafik ini.
description	string	Frasa singkat untuk membantu pembaca manusia membedakan kelompok dengan nama yang sama
descriptor	string	Deskriptor adalah cara utama untuk mereferensikan subjek grafik saat sistem berjalan. Bidang ini akan mengidentifikasi subjek grafik yang sama secara unik di seluruh Akun dan Organisasi.
displayName	string	Ini adalah nama tampilan subjek grafik yang tidak unik. Untuk mengubah bidang ini, Anda harus mengubah nilainya di penyedia sumber.
domain	string	Ini mewakili nama kontainer asal untuk anggota grafik. (Untuk MSA ini adalah "Windows Live ID", untuk AD nama domain, untuk AAD tenantID direktori, untuk VSTS mengelompokkan ScopeId, dll)
legacyDescriptor	string	[Penggunaan Internal Saja] Deskriptor warisan ada di sini jika Anda perlu mengakses IMS versi lama menggunakan deskriptor identitas.
mailAddress	string	Alamat email rekaman untuk anggota grafik tertentu. Ini mungkin berbeda dari nama utama.
origin	string	Jenis penyedia sumber untuk pengidentifikasi asal (misalnya: AD, AAD, MSA)
originId	string	Pengidentifikasi unik dari sistem asal. Biasanya sid, id objek, atau Guid. Menautkan dan membatalkan tautan operasi dapat menyebabkan nilai ini berubah untuk pengguna karena pengguna tidak didukung oleh penyedia yang berbeda dan memiliki id unik yang berbeda di penyedia baru.
principalName	string	Ini adalah PrincipalName anggota grafik ini dari penyedia sumber. Penyedia sumber dapat mengubah bidang ini dari waktu ke waktu dan tidak dijamin tidak dapat diubah selama masa pakai anggota grafik oleh VSTS.
subjectKind	string	Bidang ini mengidentifikasi jenis subjek grafik (misalnya: Grup, Cakupan, Pengguna).
url	string	Url ini adalah rute lengkap ke sumber daya sumber subjek grafik ini.

GraphUser

Objek

Entitas pengguna grafik

Nama	Jenis	Deskripsi
_links	ReferenceLinks	Bidang ini berisi nol atau lebih tautan menarik tentang subjek grafik. Tautan ini dapat dipanggil untuk mendapatkan hubungan tambahan atau informasi lebih rinci tentang subjek grafik ini.
descriptor	string	Deskriptor adalah cara utama untuk mereferensikan subjek grafik saat sistem berjalan. Bidang ini akan mengidentifikasi subjek grafik yang sama secara unik di seluruh Akun dan Organisasi.
directoryAlias	string	Nama pendek yang umumnya unik untuk pengguna di direktori cadangan. Untuk pengguna AAD, ini sesuai dengan nama panggilan email, yang sering tetapi belum tentu mirip dengan bagian alamat email pengguna sebelum tanda @. Untuk pengguna GitHub, ini sesuai dengan handel pengguna GitHub.
displayName	string	Ini adalah nama tampilan subjek grafik yang tidak unik. Untuk mengubah bidang ini, Anda harus mengubah nilainya di penyedia sumber.
domain	string	Ini mewakili nama kontainer asal untuk anggota grafik. (Untuk MSA ini adalah "Windows Live ID", untuk AD nama domain, untuk AAD tenantID direktori, untuk VSTS mengelompokkan ScopeId, dll)
isDeletedInOrigin	boolean	Jika true, grup telah dihapus di IdP
legacyDescriptor	string	[Penggunaan Internal Saja] Deskriptor warisan ada di sini jika Anda perlu mengakses IMS versi lama menggunakan deskriptor identitas.
mailAddress	string	Alamat email rekaman untuk anggota grafik tertentu. Ini mungkin berbeda dari nama utama.
metaType	string	Jenis meta pengguna di asal, seperti "anggota", "tamu", dll. Lihat UserMetaType untuk kumpulan nilai yang mungkin.
origin	string	Jenis penyedia sumber untuk pengidentifikasi asal (misalnya: AD, AAD, MSA)
originId	string	Pengidentifikasi unik dari sistem asal. Biasanya sid, id objek, atau Guid. Menautkan dan membatalkan tautan operasi dapat menyebabkan nilai ini berubah untuk pengguna karena pengguna tidak didukung oleh penyedia yang berbeda dan memiliki id unik yang berbeda di penyedia baru.
principalName	string	Ini adalah PrincipalName anggota grafik ini dari penyedia sumber. Penyedia sumber dapat mengubah bidang ini dari waktu ke waktu dan tidak dijamin tidak dapat diubah selama masa pakai anggota grafik oleh VSTS.
subjectKind	string	Bidang ini mengidentifikasi jenis subjek grafik (misalnya: Grup, Cakupan, Pengguna).
url	string	Url ini adalah rute lengkap ke sumber daya sumber subjek grafik ini.

Group

Objek

Grup Proyek (misalnya Kontributor, Pembaca, dll.)

Nama	Jenis	Deskripsi
displayName	string	Nama Tampilan Grup
groupType	GroupType	Jenis Grup

GroupEntitlement

Objek

Entitas grup dengan properti tambahan termasuk lisensi, ekstensi, dan keanggotaan proyeknya

Nama	Jenis	Deskripsi
extensionRules	Extension[]	Aturan Ekstensi.
group	GraphGroup	Referensi anggota.
id	string	Pengidentifikasi unik yang cocok dengan Id GraphMember.
lastExecuted	string	[Baca saja] Terakhir kali aturan lisensi grup dijalankan (terlepas dari apakah ada perubahan yang dilakukan).
licenseRule	AccessLevel	Aturan Lisensi.
members	UserEntitlement[]	Anggota grup. Hanya digunakan saat membuat grup baru.
projectEntitlements	ProjectEntitlement[]	Hubungan antara proyek dan izin efektif anggota dalam proyek tersebut.
status	GroupLicensingRuleStatus	Status aturan grup.

GroupLicensingRuleStatus

Enumeration

Status aturan grup.

Nilai	Deskripsi
applied	Aturan diterapkan
applyPending	Aturan dibuat atau diperbarui, tetapi terapkan tertunda
incompatible	Aturan grup tidak kompatibel
unableToApply	Aturan gagal diterapkan secara tidak terduga dan harus dicoba kembali

GroupType

Enumeration

Jenis Grup

Nilai	Deskripsi
custom
projectAdministrator
projectContributor
projectReader
projectStakeholder

LicensingSource

Enumeration

Sumber Lisensi (misalnya Akun. MSDN dll.)

Nilai	Deskripsi
account
auto
msdn
none
profile
trial

MsdnLicenseType

Enumeration

Jenis Lisensi MSDN (misalnya Visual Studio Professional, Visual Studio Enterprise, dll.)

Nilai	Deskripsi
eligible
enterprise
none
platforms
premium
professional
testProfessional
ultimate

ProjectEntitlement

Objek

Hubungan antara proyek dan izin efektif pengguna dalam proyek tersebut.

Nama	Jenis	Deskripsi
assignmentSource	AssignmentSource	Sumber Penugasan (misalnya Grup atau Tidak Diketahui).
group	Group	Grup Proyek (misalnya Kontributor, Pembaca, dll.)
projectPermissionInherited	ProjectPermissionInherited	Apakah pengguna mewarisi izin ke proyek melalui azure DevOps atau keanggotaan grup AAD.
projectRef	ProjectRef	Project Ref
teamRefs	TeamRef[]	Tim Ref.

ProjectPermissionInherited

Enumeration

Apakah pengguna mewarisi izin ke proyek melalui azure DevOps atau keanggotaan grup AAD.

Nilai	Deskripsi
inherited
notInherited
notSet

ProjectRef

Objek

Referensi ke proyek

Nama	Jenis	Deskripsi
id	string	ID Proyek.
name	string	Nama Proyek.

ReferenceLinks

Objek

Kelas untuk mewakili kumpulan tautan referensi REST.

Nama	Jenis	Deskripsi
links	object	Tampilan baca-saja dari tautan. Karena tautan Referensi bersifat baca-saja, kami hanya ingin mengeksposnya sebagai baca saja.

TeamRef

Objek

Referensi ke tim

Nama	Jenis	Deskripsi
id	string	ID Tim
name	string	Nama Tim