User Entitlements - Get User Entitlements

Odwołanie

Usługa:: Member Entitlement Management

Wersja interfejsu API:: 5.1-preview.2

Pobierz stronicowany zestaw uprawnień użytkowników spełniających kryteria filtrowania. Jeśli filtr nie zostanie przekazany, zostanie zwrócona strona ze wszystkich użytkowników konta.

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

Z parametrami opcjonalnymi:

GET https://vsaex.dev.azure.com/{organization}/_apis/userentitlements?top={top}&skip={skip}&filter={filter}&sortOption={sortOption}&api-version=5.1-preview.2

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
organization	path	True	string	Nazwa organizacji usługi Azure DevOps.
api-version	query	True	string	Wersja interfejsu API do użycia. Powinno to być ustawione na wartość "5.1-preview.2", aby używać tej wersji interfejsu API.
filter	query		string	Rozdzielona przecinkami lista właściwości i ich wartości do filtrowania. Obecnie interfejs API obsługuje filtrowanie tylko według identyfikatora ExtensionId. Przykładowy parametr to filter=extensionId eq search.
skip	query		integer int32	Przesunięcie: liczba rekordów do pominięcia. Wartość domyślna to 0
sortOption	query		string	PropertyName i Order (oddzielone spacją ( )) do sortowania (np. LastAccessDate Desc)
top	query		integer int32	Maksymalna liczba uprawnień użytkownika do zwrócenia. Maksymalna wartość to 10000. Wartość domyślna to 100

Odpowiedzi

Nazwa	Typ	Opis
200 OK	PagedGraphMemberList	operacja zakończona powodzeniem

Zabezpieczenia

oauth2

Typ: oauth2
Flow: accessCode
Adres URL autoryzacji: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Adres URL tokenu: 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

Zakresy

Nazwa	Opis
vso.memberentitlementmanagement	Umożliwia odczytywanie użytkowników, ich licencji, a także projektów i rozszerzeń, do których mogą uzyskiwać dostęp

Definicje

Nazwa	Opis
AccessLevel	Licencja przypisana użytkownikowi
AccountLicenseType	Typ licencji konta (np. Express, Uczestnicy projektu itp.)
AccountUserStatus	Stan użytkownika na koncie
AssignmentSource	Źródło przypisania licencji (np. grupa, nieznany itp.
Extension	Rozszerzenie przypisane do użytkownika
GraphGroup	Jednostka grupy programu Graph
GraphUser	Jednostka użytkownika programu Graph
Group	Grupa projektów (np. współautor, czytelnik itp.)
GroupEntitlement	Jednostka grupy z dodatkowymi właściwościami, w tym jej licencja, rozszerzenia i członkostwo w projekcie
GroupLicensingRuleStatus	Stan reguły grupy.
GroupType	Typ grupy
LicensingSource	Źródło licencjonowania (np. konto. MSDN itp.)
MsdnLicenseType	Typ licencji MSDN (np. Visual Studio Professional, Visual Studio Enterprise itp.)
PagedGraphMemberList	Strona użytkowników
ProjectEntitlement	Relacja między projektem a skutecznymi uprawnieniami użytkownika w tym projekcie.
ProjectPermissionInherited	Niezależnie od tego, czy użytkownik dziedziczy uprawnienia do projektu za pośrednictwem członkostwa w grupie usługi Azure DevOps czy AAD.
ProjectRef	Odwołanie do projektu
ReferenceLinks	Klasa reprezentująca kolekcję linków referencyjnych REST.
TeamRef	Odwołanie do zespołu
UserEntitlement	Jednostka użytkownika z dodatkowymi właściwościami, w tym ich licencja, rozszerzenia i członkostwo w projekcie

AccessLevel

Object

Licencja przypisana użytkownikowi

Nazwa	Typ	Opis
accountLicenseType	AccountLicenseType	Typ licencji konta (np. Express, Uczestnicy projektu itp.)
assignmentSource	AssignmentSource	Źródło przypisania licencji (np. grupa, nieznany itp.
licenseDisplayName	string	Nazwa wyświetlana licencji
licensingSource	LicensingSource	Źródło licencjonowania (np. konto. MSDN itp.)
msdnLicenseType	MsdnLicenseType	Typ licencji MSDN (np. Visual Studio Professional, Visual Studio Enterprise itp.)
status	AccountUserStatus	Stan użytkownika na koncie
statusMessage	string	Komunikat o stanie.

AccountLicenseType

Enumeration

Typ licencji konta (np. Express, Uczestnicy projektu itp.)

Wartość	Opis
advanced
earlyAdopter
express
none
professional
stakeholder

AccountUserStatus

Enumeration

Stan użytkownika na koncie

Wartość	Opis
active	Użytkownik zalogował się co najmniej raz na konto usługi VSTS
deleted	Użytkownik jest usuwany z konta usługi VSTS przez administratora konta usługi VSTS
disabled	Użytkownik nie może się zalogować; głównie używany przez administratora do tymczasowego usunięcia użytkownika z powodu braku lub reallocation licencji
expired	Użytkownik może się zalogować; używane głównie wtedy, gdy licencja jest w stanie wygaśnięcia i otrzymujemy okres prolongaty
none
pending	Użytkownik jest zapraszany do dołączenia do konta usługi VSTS przez administratora konta usługi VSTS, ale jeszcze nie zarejestrował się/zalogował się
pendingDisabled	Użytkownik jest wyłączony; w przypadku ponownego włączenia, nadal będą one w stanie Oczekiwanie

AssignmentSource

Enumeration

Źródło przypisania licencji (np. grupa, nieznany itp.

Wartość	Opis
groupRule
none
unknown

Extension

Object

Rozszerzenie przypisane do użytkownika

Nazwa	Typ	Opis
assignmentSource	AssignmentSource	Źródło przypisania dla tego rozszerzenia. Tj. jawnie przypisane lub z reguły grupy.
id	string	Identyfikator galerii rozszerzenia.
name	string	Przyjazna nazwa tego rozszerzenia.
source	LicensingSource	Źródło tego przypisania rozszerzenia. Np. msdn, konto, brak itp.

GraphGroup

Object

Jednostka grupy programu Graph

Nazwa	Typ	Opis
_links	ReferenceLinks	To pole zawiera zero lub więcej interesujących linków dotyczących tematu grafu. Te linki mogą być wywoływane w celu uzyskania dodatkowych relacji lub bardziej szczegółowych informacji na temat tego tematu grafu.
description	string	Krótka fraza pomagająca czytelnikom uściślać grupy o podobnych nazwach
descriptor	string	Deskryptor jest podstawowym sposobem odwołowania się do tematu grafu podczas działania systemu. To pole będzie jednoznacznie identyfikować ten sam temat grafu zarówno w ramach kont, jak i organizacji.
displayName	string	Jest to unikatowa nazwa wyświetlana tematu grafu. Aby zmienić to pole, musisz zmienić jego wartość u dostawcy źródłowego.
domain	string	Reprezentuje to nazwę kontenera pochodzenia dla elementu członkowskiego grafu. (W przypadku msA jest to "Windows Live ID", w przypadku usługi AD nazwa domeny, dla usługi AAD identyfikator dzierżawy katalogu, dla grup usługi VSTS identyfikator ScopeId itp.)
legacyDescriptor	string	[Tylko użycie wewnętrzne] Starszy deskryptor jest tutaj, jeśli musisz uzyskać dostęp do starej wersji IMS przy użyciu deskryptora tożsamości.
mailAddress	string	Adres e-mail rekordu dla danego elementu członkowskiego grafu. Może to być inne niż główna nazwa.
origin	string	Typ dostawcy źródłowego identyfikatora źródła (np. AD, AAD, MSA)
originId	string	Unikatowy identyfikator z systemu pochodzenia. Zazwyczaj identyfikator sid, identyfikator obiektu lub identyfikator GUID. Operacje łączenia i odłączania mogą spowodować zmianę tej wartości dla użytkownika, ponieważ użytkownik nie jest wspierany przez innego dostawcę i ma inny unikatowy identyfikator w nowym dostawcy.
principalName	string	Jest to nazwa główna tego elementu członkowskiego grafu od dostawcy źródłowego. Dostawca źródłowy może zmienić to pole w czasie i nie ma gwarancji, że będzie on niezmienny dla okresu życia elementu członkowskiego grafu przez usługę VSTS.
subjectKind	string	To pole identyfikuje typ tematu grafu (np. Grupa, Zakres, Użytkownik).
url	string	Ten adres URL jest pełną trasą do zasobu źródłowego tego tematu grafu.

GraphUser

Object

Jednostka użytkownika programu Graph

Nazwa	Typ	Opis
_links	ReferenceLinks	To pole zawiera zero lub więcej interesujących linków dotyczących tematu grafu. Te linki mogą być wywoływane w celu uzyskania dodatkowych relacji lub bardziej szczegółowych informacji na temat tego tematu grafu.
descriptor	string	Deskryptor jest podstawowym sposobem odwołowania się do tematu grafu podczas działania systemu. To pole będzie jednoznacznie identyfikować ten sam temat grafu zarówno w ramach kont, jak i organizacji.
directoryAlias	string	Krótka, ogólnie unikatowa nazwa użytkownika w katalogu zaplecza. W przypadku użytkowników usługi AAD odpowiada to pseudonimowi poczty, który jest często, ale niekoniecznie podobny do części adresu e-mail użytkownika przed znakiem @. W przypadku użytkowników usługi GitHub odpowiada to obsłudze użytkownika usługi GitHub.
displayName	string	Jest to unikatowa nazwa wyświetlana tematu grafu. Aby zmienić to pole, musisz zmienić jego wartość u dostawcy źródłowego.
domain	string	Reprezentuje to nazwę kontenera pochodzenia dla elementu członkowskiego grafu. (W przypadku msA jest to "Windows Live ID", w przypadku usługi AD nazwa domeny, dla usługi AAD identyfikator dzierżawy katalogu, dla grup usługi VSTS identyfikator ScopeId itp.)
isDeletedInOrigin	boolean	W przypadku wartości true grupa została usunięta w dostawcy tożsamości
legacyDescriptor	string	[Tylko użycie wewnętrzne] Starszy deskryptor jest tutaj, jeśli musisz uzyskać dostęp do starej wersji IMS przy użyciu deskryptora tożsamości.
mailAddress	string	Adres e-mail rekordu dla danego elementu członkowskiego grafu. Może to być inne niż główna nazwa.
metaType	string	Meta typ użytkownika w miejscu pochodzenia, taki jak "członek", "gość" itp. Zobacz UserMetaType, aby uzyskać zestaw możliwych wartości.
origin	string	Typ dostawcy źródłowego identyfikatora źródła (np. AD, AAD, MSA)
originId	string	Unikatowy identyfikator z systemu pochodzenia. Zazwyczaj identyfikator sid, identyfikator obiektu lub identyfikator GUID. Operacje łączenia i odłączania mogą spowodować zmianę tej wartości dla użytkownika, ponieważ użytkownik nie jest wspierany przez innego dostawcę i ma inny unikatowy identyfikator w nowym dostawcy.
principalName	string	Jest to nazwa główna tego elementu członkowskiego grafu od dostawcy źródłowego. Dostawca źródłowy może zmienić to pole w czasie i nie ma gwarancji, że będzie on niezmienny dla okresu życia elementu członkowskiego grafu przez usługę VSTS.
subjectKind	string	To pole identyfikuje typ tematu grafu (np. Grupa, Zakres, Użytkownik).
url	string	Ten adres URL jest pełną trasą do zasobu źródłowego tego tematu grafu.

Group

Object

Grupa projektów (np. współautor, czytelnik itp.)

Nazwa	Typ	Opis
displayName	string	Nazwa wyświetlana grupy
groupType	GroupType	Typ grupy

GroupEntitlement

Object

Jednostka grupy z dodatkowymi właściwościami, w tym jej licencja, rozszerzenia i członkostwo w projekcie

Nazwa	Typ	Opis
extensionRules	Extension[]	Reguły rozszerzeń.
group	GraphGroup	Odwołanie do elementu członkowskiego.
id	string	Unikatowy identyfikator zgodny z identyfikatorem elementu GraphMember.
lastExecuted	string	[Readonly] Ostatni raz reguła licencjonowania grupy została wykonana (niezależnie od tego, czy wprowadzono jakiekolwiek zmiany).
licenseRule	AccessLevel	Reguła licencji.
members	UserEntitlement[]	Członkowie grupy. Używane tylko podczas tworzenia nowej grupy.
projectEntitlements	ProjectEntitlement[]	Relacja między projektem a skutecznymi uprawnieniami członka w tym projekcie.
status	GroupLicensingRuleStatus	Stan reguły grupy.

GroupLicensingRuleStatus

Enumeration

Stan reguły grupy.

Wartość	Opis
applied	Reguła jest stosowana
applyPending	Reguła jest tworzona lub aktualizowana, ale zastosowanie jest oczekujące
incompatible	Reguła grupy była niezgodna
unableToApply	Nie można zastosować nieoczekiwanie reguły i powinna zostać ponowiona

GroupType

Enumeration

Typ grupy

Wartość	Opis
custom
projectAdministrator
projectContributor
projectReader
projectStakeholder

LicensingSource

Enumeration

Źródło licencjonowania (np. konto. MSDN itp.)

Wartość	Opis
account
auto
msdn
none
profile
trial

MsdnLicenseType

Enumeration

Typ licencji MSDN (np. Visual Studio Professional, Visual Studio Enterprise itp.)

Wartość	Opis
eligible
enterprise
none
platforms
premium
professional
testProfessional
ultimate

PagedGraphMemberList

Object

Strona użytkowników

Nazwa	Typ	Opis
members	UserEntitlement[]	Jednostka użytkownika z dodatkowymi właściwościami, w tym ich licencja, rozszerzenia i członkostwo w projekcie

ProjectEntitlement

Object

Relacja między projektem a skutecznymi uprawnieniami użytkownika w tym projekcie.

Nazwa	Typ	Opis
assignmentSource	AssignmentSource	Źródło przypisania (np. grupa lub nieznany).
group	Group	Grupa projektów (np. współautor, czytelnik itp.)
projectPermissionInherited	ProjectPermissionInherited	Niezależnie od tego, czy użytkownik dziedziczy uprawnienia do projektu za pośrednictwem członkostwa w grupie usługi Azure DevOps czy AAD.
projectRef	ProjectRef	Ref projektu
teamRefs	TeamRef[]	Team Ref.

ProjectPermissionInherited

Enumeration

Niezależnie od tego, czy użytkownik dziedziczy uprawnienia do projektu za pośrednictwem członkostwa w grupie usługi Azure DevOps czy AAD.

Wartość	Opis
inherited
notInherited
notSet

ProjectRef

Object

Odwołanie do projektu

Nazwa	Typ	Opis
id	string	Identyfikator projektu.
name	string	Nazwa projektu.

ReferenceLinks

Object

Klasa reprezentująca kolekcję linków referencyjnych REST.

Nazwa	Typ	Opis
links	object	Czytelny widok linków. Ponieważ linki referencyjne są czytelne, chcemy uwidocznić je tylko jako tylko do odczytu.

TeamRef

Object

Odwołanie do zespołu

Nazwa	Typ	Opis
id	string	Identyfikator zespołu
name	string	Nazwa zespołu