User Entitlements - Get User Entitlements

Referenz

Dienst:: Member Entitlement Management

API-Version:: 5.1-preview.2

Rufen Sie einen ausgelagerten Satz von Benutzerberechtigungen ab, die den Filterkriterien entsprechen. Wenn kein Filter übergeben wird, wird eine Seite aller Kontobenutzer zurückgegeben.

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

Mit optionalen Parametern:

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

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 "5.1-preview.2" festgelegt werden, um diese Version der API zu verwenden.
filter	query		string	Durch Kommas (",") getrennte Liste von Eigenschaften und deren Werten, nach der gefiltert werden soll. Derzeit unterstützt die API nur die Filterung nach ExtensionId. Ein Beispielparameter wäre filter=extensionId eq search.
skip	query		integer int32	Offset: Anzahl der zu überspringenden Datensätze. Der Standardwert ist 0.
sortOption	query		string	PropertyName und Order (getrennt durch ein Leerzeichen ( )) zum Sortieren (z. B. LastAccessDate Desc)
top	query		integer int32	Maximale Anzahl der zurückzugebenden Benutzerberechtigungen. Der maximale Wert ist 10000. Standardwert ist 100

Antworten

Name	Typ	Beschreibung
200 OK	PagedGraphMemberList	Erfolgreicher Vorgang

Sicherheit

oauth2

Typ: oauth2
Ablauf: accessCode
Autorisierungs-URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token-URL: 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

Bereiche

Name	Beschreibung
vso.memberentitlementmanagement	Ermöglicht das Lesen von Benutzern, deren Lizenzen sowie Projekten und Erweiterungen, auf die sie zugreifen können.

Definitionen

Name	Beschreibung
AccessLevel	Einem Benutzer zugewiesene Lizenz
AccountLicenseType	Art der Kontolizenz (z. B. Express, Stakeholder usw.)
AccountUserStatus	Benutzer status im Konto
AssignmentSource	Zuweisungsquelle der Lizenz (z. B. Gruppe, Unbekannt usw.)
Extension	Eine Erweiterung, die einem Benutzer zugewiesen ist
GraphGroup	Graphgruppenentität
GraphUser	Graph-Benutzerentität
Group	Projektgruppe (z.B. Mitwirkender, Leser usw.)
GroupEntitlement	Eine Gruppenentität mit zusätzlichen Eigenschaften, einschließlich Lizenz, Erweiterungen und Projektmitgliedschaft
GroupLicensingRuleStatus	Die status der Gruppenregel.
GroupType	Gruppentyp
LicensingSource	Lizenzierungsquelle (z. B. Konto. MSDN usw.)
MsdnLicenseType	Typ der MSDN-Lizenz (z. B. Visual Studio Professional, Visual Studio Enterprise usw.)
PagedGraphMemberList	Eine Seite mit Benutzern
ProjectEntitlement	Beziehung zwischen einem Projekt und den effektiven Berechtigungen des Benutzers in diesem Projekt.
ProjectPermissionInherited	Gibt an, ob der Benutzer Berechtigungen für ein Projekt über eine Azure DevOps- oder AAD-Gruppenmitgliedschaft erbt.
ProjectRef	Ein Verweis auf ein Projekt
ReferenceLinks	Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.
TeamRef	Ein Verweis auf ein Team
UserEntitlement	Eine Benutzerentität mit zusätzlichen Eigenschaften, einschließlich Lizenz, Erweiterungen und Projektmitgliedschaft

AccessLevel

Objekt

Einem Benutzer zugewiesene Lizenz

Name	Typ	Beschreibung
accountLicenseType	AccountLicenseType	Art der Kontolizenz (z. B. Express, Stakeholder usw.)
assignmentSource	AssignmentSource	Zuweisungsquelle der Lizenz (z. B. Gruppe, Unbekannt usw.)
licenseDisplayName	string	Anzeigename der Lizenz
licensingSource	LicensingSource	Lizenzierungsquelle (z. B. Konto. MSDN usw.)
msdnLicenseType	MsdnLicenseType	Typ der MSDN-Lizenz (z. B. Visual Studio Professional, Visual Studio Enterprise usw.)
status	AccountUserStatus	Benutzer status im Konto
statusMessage	string	Statusmeldung.

AccountLicenseType

Enumeration

Art der Kontolizenz (z. B. Express, Stakeholder usw.)

Wert	Beschreibung
advanced
earlyAdopter
express
none
professional
stakeholder

AccountUserStatus

Enumeration

Benutzer status im Konto

Wert	Beschreibung
active	Der Benutzer hat sich mindestens einmal beim VSTS-Konto angemeldet.
deleted	Der Benutzer wird vom VSTS-Kontoadministrator aus dem VSTS-Konto entfernt.
disabled	Der Benutzer kann sich nicht anmelden. Wird in erster Linie vom Administrator verwendet, um einen Benutzer vorübergehend zu entfernen, weil er nicht vorhanden ist oder die Lizenz neu zugewiesen wurde.
expired	Der Benutzer kann sich anmelden. wird hauptsächlich verwendet, wenn sich die Lizenz im abgelaufenen Zustand befindet und wir eine Nachfrist gewähren
none
pending	Der Benutzer wird vom VSTS-Kontoadministrator aufgefordert, dem VSTS-Konto beizutreten, hat sich aber noch nicht registriert bzw. angemeldet.
pendingDisabled	Der Benutzer ist deaktiviert; wenn sie erneut aktiviert werden, befinden sie sich weiterhin im Status Ausstehend.

AssignmentSource

Enumeration

Zuweisungsquelle der Lizenz (z. B. Gruppe, Unbekannt usw.)

Wert	Beschreibung
groupRule
none
unknown

Extension

Objekt

Eine Erweiterung, die einem Benutzer zugewiesen ist

Name	Typ	Beschreibung
assignmentSource	AssignmentSource	Zuweisungsquelle für diese Erweiterung. D.h. explizit zugewiesen oder aus einer Gruppenregel.
id	string	Katalog-ID der Erweiterung.
name	string	Anzeigename dieser Erweiterung.
source	LicensingSource	Quelle dieser Erweiterungszuweisung. Beispiel: msdn, account, none usw.

GraphGroup

Objekt

Graphgruppenentität

Name	Typ	Beschreibung
_links	ReferenceLinks	Dieses Feld enthält null oder interessantere Links zum Diagrammthema. Diese Links können aufgerufen werden, um zusätzliche Beziehungen oder ausführlichere Informationen zu diesem Graph-Thema zu erhalten.
description	string	Ein kurzer Begriff, der menschlichen Lesern hilft, Gruppen mit ähnlichen Namen zu disambiguieren
descriptor	string	Der Deskriptor ist die primäre Möglichkeit, auf den Graphengegenstand zu verweisen, während das System ausgeführt wird. In diesem Feld wird derselbe Graph-Betreff sowohl für Konten als auch für Organisationen eindeutig identifiziert.
displayName	string	Dies ist der nicht eindeutige Anzeigename des Diagrammsubjekts. Um dieses Feld zu ändern, müssen Sie seinen Wert im Quellanbieter ändern.
domain	string	Dies stellt den Namen des Ursprungscontainers für ein Graphmember dar. (Für MSA ist dies "Windows Live ID", für AD der Name der Domäne, für AAD die Mandanten-ID des Verzeichnisses, für VSTS-Gruppen die ScopeId usw.)
legacyDescriptor	string	[Nur interne Verwendung] Der Legacydeskriptor ist hier, falls Sie mithilfe des Identitätsdeskriptors auf IMS der alten Version zugreifen müssen.
mailAddress	string	Die E-Mail-Adresse des Datensatzes für ein bestimmtes Graphelement. Dies kann sich vom Prinzipalnamen unterscheiden.
origin	string	Der Typ des Quellanbieters für den Ursprungsbezeichner (z. B. AD, AAD, MSA)
originId	string	Der eindeutige Bezeichner aus dem Ursprungssystem. In der Regel eine Sid- oder Objekt-ID oder guid. Verknüpfungs- und Verknüpfungsvorgänge können dazu führen, dass sich dieser Wert für einen Benutzer ändert, da der Benutzer nicht von einem anderen Anbieter unterstützt wird und eine andere eindeutige ID im neuen Anbieter aufweist.
principalName	string	Dies ist der PrincipalName dieses Graphmembers vom Quellanbieter. Der Quellanbieter kann dieses Feld im Laufe der Zeit ändern, und es ist nicht garantiert, dass es für die Lebensdauer des Graphelements durch VSTS unveränderlich ist.
subjectKind	string	Dieses Feld identifiziert den Typ des Graph-Betreffs (z. B. Gruppe, Bereich, Benutzer).
url	string	Diese URL ist die vollständige Route zur Quellressource dieses Graph-Betreffs.

GraphUser

Objekt

Graph-Benutzerentität

Name	Typ	Beschreibung
_links	ReferenceLinks	Dieses Feld enthält null oder interessantere Links zum Diagrammthema. Diese Links können aufgerufen werden, um zusätzliche Beziehungen oder ausführlichere Informationen zu diesem Graph-Thema zu erhalten.
descriptor	string	Der Deskriptor ist die primäre Möglichkeit, auf den Graphengegenstand zu verweisen, während das System ausgeführt wird. In diesem Feld wird derselbe Graph-Betreff sowohl für Konten als auch für Organisationen eindeutig identifiziert.
directoryAlias	string	Der kurze, im Allgemeinen eindeutige Name für den Benutzer im Sicherungsverzeichnis. Für AAD-Benutzer entspricht dies dem E-Mail-Spitznamen, der oft, aber nicht unbedingt dem Teil der E-Mail-Adresse des Benutzers vor dem @-Zeichen ähnelt. Für GitHub-Benutzer entspricht dies dem GitHub-Benutzerhandle.
displayName	string	Dies ist der nicht eindeutige Anzeigename des Diagrammsubjekts. Um dieses Feld zu ändern, müssen Sie seinen Wert im Quellanbieter ändern.
domain	string	Dies stellt den Namen des Ursprungscontainers für ein Graphmember dar. (Für MSA ist dies "Windows Live ID", für AD der Name der Domäne, für AAD die Mandanten-ID des Verzeichnisses, für VSTS-Gruppen die ScopeId usw.)
isDeletedInOrigin	boolean	Wenn true, wurde die Gruppe im Identitätsanbieter gelöscht.
legacyDescriptor	string	[Nur interne Verwendung] Der Legacydeskriptor ist hier, falls Sie mithilfe des Identitätsdeskriptors auf IMS der alten Version zugreifen müssen.
mailAddress	string	Die E-Mail-Adresse des Datensatzes für ein bestimmtes Graphelement. Dies kann sich vom Prinzipalnamen unterscheiden.
metaType	string	Der Metatyp des Benutzers im Ursprung, z. B. "Member", "Guest" usw. Informationen zu den möglichen Werten finden Sie unter UserMetaType.
origin	string	Der Typ des Quellanbieters für den Ursprungsbezeichner (z. B. AD, AAD, MSA)
originId	string	Der eindeutige Bezeichner aus dem Ursprungssystem. In der Regel eine Sid- oder Objekt-ID oder guid. Verknüpfungs- und Verknüpfungsvorgänge können dazu führen, dass sich dieser Wert für einen Benutzer ändert, da der Benutzer nicht von einem anderen Anbieter unterstützt wird und eine andere eindeutige ID im neuen Anbieter aufweist.
principalName	string	Dies ist der PrincipalName dieses Graphmembers vom Quellanbieter. Der Quellanbieter kann dieses Feld im Laufe der Zeit ändern, und es ist nicht garantiert, dass es für die Lebensdauer des Graphelements durch VSTS unveränderlich ist.
subjectKind	string	Dieses Feld identifiziert den Typ des Graph-Betreffs (z. B. Gruppe, Bereich, Benutzer).
url	string	Diese URL ist die vollständige Route zur Quellressource dieses Graph-Betreffs.

Group

Objekt

Projektgruppe (z.B. Mitwirkender, Leser usw.)

Name	Typ	Beschreibung
displayName	string	Anzeigename der Gruppe
groupType	GroupType	Gruppentyp

GroupEntitlement

Objekt

Eine Gruppenentität mit zusätzlichen Eigenschaften, einschließlich Lizenz, Erweiterungen und Projektmitgliedschaft

Name	Typ	Beschreibung
extensionRules	Extension[]	Erweiterungsregeln.
group	GraphGroup	Memberreferenz.
id	string	Der eindeutige Bezeichner, der mit der ID des GraphMember übereinstimmt.
lastExecuted	string	[Readonly] Die letzte Ausführung der Gruppenlizenzierungsregel (unabhängig davon, ob Änderungen vorgenommen wurden).
licenseRule	AccessLevel	Lizenzregel.
members	UserEntitlement[]	Gruppenmitglieder. Wird nur beim Erstellen einer neuen Gruppe verwendet.
projectEntitlements	ProjectEntitlement[]	Beziehung zwischen einem Projekt und den effektiven Berechtigungen des Mitglieds in diesem Projekt.
status	GroupLicensingRuleStatus	Die status der Gruppenregel.

GroupLicensingRuleStatus

Enumeration

Die status der Gruppenregel.

Wert	Beschreibung
applied	Regel wird angewendet
applyPending	Regel wird erstellt oder aktualisiert, aber anwenden ist ausstehend
incompatible	Die Gruppenregel war inkompatibel.
unableToApply	Die Regel konnte nicht unerwartet angewendet werden und sollte erneut ausgeführt werden.

GroupType

Enumeration

Gruppentyp

Wert	Beschreibung
custom
projectAdministrator
projectContributor
projectReader
projectStakeholder

LicensingSource

Enumeration

Lizenzierungsquelle (z. B. Konto. MSDN usw.)

Wert	Beschreibung
account
auto
msdn
none
profile
trial

MsdnLicenseType

Enumeration

Typ der MSDN-Lizenz (z. B. Visual Studio Professional, Visual Studio Enterprise usw.)

Wert	Beschreibung
eligible
enterprise
none
platforms
premium
professional
testProfessional
ultimate

PagedGraphMemberList

Objekt

Eine Seite mit Benutzern

Name	Typ	Beschreibung
members	UserEntitlement[]	Eine Benutzerentität mit zusätzlichen Eigenschaften, einschließlich Lizenz, Erweiterungen und Projektmitgliedschaft

ProjectEntitlement

Objekt

Beziehung zwischen einem Projekt und den effektiven Berechtigungen des Benutzers in diesem Projekt.

Name	Typ	Beschreibung
assignmentSource	AssignmentSource	Zuweisungsquelle (z. B. Gruppe oder Unbekannt).
group	Group	Projektgruppe (z.B. Mitwirkender, Leser usw.)
projectPermissionInherited	ProjectPermissionInherited	Gibt an, ob der Benutzer Berechtigungen für ein Projekt über eine Azure DevOps- oder AAD-Gruppenmitgliedschaft erbt.
projectRef	ProjectRef	Projekt ref
teamRefs	TeamRef[]	Team Ref.

ProjectPermissionInherited

Enumeration

Gibt an, ob der Benutzer Berechtigungen für ein Projekt über eine Azure DevOps- oder AAD-Gruppenmitgliedschaft erbt.

Wert	Beschreibung
inherited
notInherited
notSet

ProjectRef

Objekt

Ein Verweis auf ein Projekt

Name	Typ	Beschreibung
id	string	Die Projekt-ID.
name	string	Projektname.

ReferenceLinks

Objekt

Die Klasse, die eine Auflistung von REST-Verweislinks darstellt.

Name	Typ	Beschreibung
links	object	Die schreibgeschützte Ansicht der Links. Da Verweislinks schreibgeschützt sind, möchten wir sie nur als schreibgeschützt verfügbar machen.

TeamRef

Objekt

Ein Verweis auf ein Team

Name	Typ	Beschreibung
id	string	Team-ID
name	string	Teamname