Partager via


User Entitlements - Get User Entitlements

Obtenez un ensemble paginé de droits d’utilisateur correspondant aux critères de filtre. Si aucun filtre n’est transmis, une page de tous les utilisateurs du compte est retournée.

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

Paramètres URI

Nom Dans Obligatoire Type Description
organization
path True

string

Nom de l’organisation Azure DevOps.

api-version
query True

string

Version de l’API à utiliser. Cette valeur doit être définie sur « 5.1-preview.2 » pour utiliser cette version de l’API.

filter
query

string

Liste séparée par des virgules (« , ») des propriétés et de leurs valeurs sur lesquelles filtrer. Actuellement, l’API prend uniquement en charge le filtrage par ExtensionId. Un exemple de paramètre serait la recherche eq filter=extensionId.

skip
query

integer

int32

Décalage : nombre d’enregistrements à ignorer. La valeur par défaut est 0

sortOption
query

string

PropertyName et Order (séparés par un espace ( )) à trier (par exemple, LastAccessDate Desc)

top
query

integer

int32

Nombre maximal de droits d’utilisateur à retourner. La valeur maximale est 10000. La valeur par défaut est 100

Réponses

Nom Type Description
200 OK

PagedGraphMemberList

opération réussie

Sécurité

oauth2

Type: oauth2
Flux: accessCode
URL d’autorisation: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
URL du jeton: 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

Étendues

Nom Description
vso.memberentitlementmanagement Accorde la possibilité de lire les utilisateurs, leurs licences ainsi que les projets et les extensions auxquels ils peuvent accéder

Définitions

Nom Description
AccessLevel

Licence affectée à un utilisateur

AccountLicenseType

Type de licence de compte (par exemple, Express, Partie prenante, etc.)

AccountUserStatus

Status utilisateur dans le compte

AssignmentSource

Source d’affectation de la licence (par exemple, Groupe, Inconnu, etc.

Extension

Une extension affectée à un utilisateur

GraphGroup

Entité de groupe de graphiques

GraphUser

Entité utilisateur graph

Group

Groupe de projets (par exemple, Contributeur, Lecteur, etc.)

GroupEntitlement

Entité de groupe avec des propriétés supplémentaires, notamment sa licence, ses extensions et son appartenance au projet

GroupLicensingRuleStatus

Status de la règle de groupe.

GroupType

Type de groupe

LicensingSource

Source de licence (par exemple, Compte. MSDN, etc.)

MsdnLicenseType

Type de licence MSDN (par exemple, Visual Studio Professional, Visual Studio Enterprise, etc.)

PagedGraphMemberList

Une page d’utilisateurs

ProjectEntitlement

Relation entre un projet et les autorisations effectives de l’utilisateur dans ce projet.

ProjectPermissionInherited

Indique si l’utilisateur hérite des autorisations sur un projet via une appartenance à un groupe Azure DevOps ou AAD.

ProjectRef

Référence à un projet

ReferenceLinks

Classe pour représenter une collection de liens de référence REST.

TeamRef

Référence à une équipe

UserEntitlement

Entité utilisateur avec des propriétés supplémentaires, notamment sa licence, ses extensions et son appartenance au projet

AccessLevel

Licence affectée à un utilisateur

Nom Type Description
accountLicenseType

AccountLicenseType

Type de licence de compte (par exemple, Express, Partie prenante, etc.)

assignmentSource

AssignmentSource

Source d’affectation de la licence (par exemple, Groupe, Inconnu, etc.

licenseDisplayName

string

Nom complet de la licence

licensingSource

LicensingSource

Source de licence (par exemple, Compte. MSDN, etc.)

msdnLicenseType

MsdnLicenseType

Type de licence MSDN (par exemple, Visual Studio Professional, Visual Studio Enterprise, etc.)

status

AccountUserStatus

Status utilisateur dans le compte

statusMessage

string

Message d’état.

AccountLicenseType

Type de licence de compte (par exemple, Express, Partie prenante, etc.)

Valeur Description
advanced
earlyAdopter
express
none
professional
stakeholder

AccountUserStatus

Status utilisateur dans le compte

Valeur Description
active

L’utilisateur s’est connecté au moins une fois au compte VSTS

deleted

L’utilisateur est supprimé du compte VSTS par l’administrateur du compte VSTS

disabled

L’utilisateur ne peut pas se connecter ; principalement utilisé par l’administrateur pour supprimer temporairement un utilisateur en raison d’une absence ou d’une réallocation de licence

expired

L’utilisateur peut se connecter ; principalement utilisé lorsque la licence est à l’état expiré et que nous accordons une période de grâce

none
pending

L’utilisateur est invité à rejoindre le compte VSTS par l’administrateur du compte VSTS, mais il ne s’est pas encore inscrit/connecté

pendingDisabled

L’utilisateur est désactivé ; s’ils sont réactivés, ils seront toujours dans l’état En attente

AssignmentSource

Source d’affectation de la licence (par exemple, Groupe, Inconnu, etc.

Valeur Description
groupRule
none
unknown

Extension

Une extension affectée à un utilisateur

Nom Type Description
assignmentSource

AssignmentSource

Source d’affectation pour cette extension. C’est-à-dire affecté explicitement ou à partir d’une règle de groupe.

id

string

ID de galerie de l’extension.

name

string

Nom convivial de cette extension.

source

LicensingSource

Source de cette attribution d’extension. Ex : msdn, account, none, etc.

GraphGroup

Entité de groupe de graphiques

Nom Type Description
_links

ReferenceLinks

Ce champ contient zéro ou plus de liens intéressants sur l’objet du graphique. Ces liens peuvent être appelés pour obtenir des relations supplémentaires ou des informations plus détaillées sur ce sujet de graphique.

description

string

Une courte phrase pour aider les lecteurs humains à lever l’ambiguïté des groupes avec des noms similaires

descriptor

string

Le descripteur est le principal moyen de référencer l’objet du graphique pendant l’exécution du système. Ce champ identifie de manière unique le même sujet de graphique dans les comptes et les organisations.

displayName

string

Il s’agit du nom d’affichage non unique de l’objet du graphique. Pour modifier ce champ, vous devez modifier sa valeur dans le fournisseur source.

domain

string

Représente le nom du conteneur d’origine pour un membre de graphique. (Pour MSA, il s’agit de « Windows Live ID », pour AD le nom du domaine, pour AAD le tenantID du répertoire, pour les groupes VSTS l’ScopeId, etc.)

legacyDescriptor

string

[Usage interne uniquement] Le descripteur hérité se trouve ici au cas où vous deviez accéder à l’ancienne version d’IMS à l’aide du descripteur d’identité.

mailAddress

string

Adresse e-mail de l’enregistrement d’un membre de graphique donné. Il peut être différent du nom du principal.

origin

string

Type de fournisseur source pour l’identificateur d’origine (ex:AD, AAD, MSA)

originId

string

Identificateur unique du système d’origine. Généralement un sid, un ID d’objet ou un GUID. Les opérations de liaison et de dissociation peuvent entraîner la modification de cette valeur pour un utilisateur, car l’utilisateur n’est pas soutenu par un autre fournisseur et a un ID unique différent dans le nouveau fournisseur.

principalName

string

Il s’agit du principalName de ce membre de graphe du fournisseur source. Le fournisseur source peut modifier ce champ au fil du temps et il n’est pas garanti qu’il soit immuable pendant la durée de vie du membre de graphique par VSTS.

subjectKind

string

Ce champ identifie le type de l’objet du graphique (par exemple, groupe, étendue, utilisateur).

url

string

Cette URL est l’itinéraire complet vers la ressource source de ce sujet de graphique.

GraphUser

Entité utilisateur graph

Nom Type Description
_links

ReferenceLinks

Ce champ contient zéro ou plus de liens intéressants sur l’objet du graphique. Ces liens peuvent être appelés pour obtenir des relations supplémentaires ou des informations plus détaillées sur ce sujet de graphique.

descriptor

string

Le descripteur est le principal moyen de référencer l’objet du graphique pendant l’exécution du système. Ce champ identifie de manière unique le même sujet de graphique dans les comptes et les organisations.

directoryAlias

string

Nom court et généralement unique de l’utilisateur dans le répertoire de stockage. Pour les utilisateurs AAD, cela correspond au surnom du courrier, qui est souvent mais pas nécessairement similaire à la partie de l’adresse de messagerie de l’utilisateur avant le signe @ . Pour les utilisateurs GitHub, cela correspond au handle utilisateur GitHub.

displayName

string

Il s’agit du nom d’affichage non unique de l’objet du graphique. Pour modifier ce champ, vous devez modifier sa valeur dans le fournisseur source.

domain

string

Représente le nom du conteneur d’origine pour un membre de graphique. (Pour MSA, il s’agit de « Windows Live ID », pour AD le nom du domaine, pour AAD le tenantID du répertoire, pour les groupes VSTS l’ScopeId, etc.)

isDeletedInOrigin

boolean

Lorsque la valeur est true, le groupe a été supprimé dans le fournisseur d’identité

legacyDescriptor

string

[Usage interne uniquement] Le descripteur hérité se trouve ici au cas où vous deviez accéder à l’ancienne version d’IMS à l’aide du descripteur d’identité.

mailAddress

string

Adresse e-mail de l’enregistrement d’un membre de graphique donné. Il peut être différent du nom du principal.

metaType

string

Type de méta de l’utilisateur dans l’origine, tel que « membre », « invité », etc. Consultez UserMetaType pour connaître l’ensemble des valeurs possibles.

origin

string

Type de fournisseur source pour l’identificateur d’origine (ex:AD, AAD, MSA)

originId

string

Identificateur unique du système d’origine. Généralement un sid, un ID d’objet ou un GUID. Les opérations de liaison et de dissociation peuvent entraîner la modification de cette valeur pour un utilisateur, car l’utilisateur n’est pas soutenu par un autre fournisseur et a un ID unique différent dans le nouveau fournisseur.

principalName

string

Il s’agit du principalName de ce membre de graphe du fournisseur source. Le fournisseur source peut modifier ce champ au fil du temps et il n’est pas garanti qu’il soit immuable pendant la durée de vie du membre de graphique par VSTS.

subjectKind

string

Ce champ identifie le type de l’objet du graphique (par exemple, groupe, étendue, utilisateur).

url

string

Cette URL est l’itinéraire complet vers la ressource source de ce sujet de graphique.

Group

Groupe de projets (par exemple, Contributeur, Lecteur, etc.)

Nom Type Description
displayName

string

Nom complet du groupe

groupType

GroupType

Type de groupe

GroupEntitlement

Entité de groupe avec des propriétés supplémentaires, notamment sa licence, ses extensions et son appartenance au projet

Nom Type Description
extensionRules

Extension[]

Règles d’extension.

group

GraphGroup

Référence de membre.

id

string

Identificateur unique qui correspond à l’ID du GraphMember.

lastExecuted

string

[En lecture seule] La dernière fois que la règle de gestion des licences de groupe a été exécutée (que des modifications aient été apportées ou non).

licenseRule

AccessLevel

Règle de licence.

members

UserEntitlement[]

Membres du groupe. Utilisé uniquement lors de la création d’un groupe.

projectEntitlements

ProjectEntitlement[]

Relation entre un projet et les autorisations effectives du membre dans ce projet.

status

GroupLicensingRuleStatus

Status de la règle de groupe.

GroupLicensingRuleStatus

Status de la règle de groupe.

Valeur Description
applied

La règle est appliquée

applyPending

La règle est créée ou mise à jour, mais l’application est en attente

incompatible

La règle de groupe était incompatible

unableToApply

La règle n’a pas pu s’appliquer de manière inattendue et doit être retentée

GroupType

Type de groupe

Valeur Description
custom
projectAdministrator
projectContributor
projectReader
projectStakeholder

LicensingSource

Source de licence (par exemple, Compte. MSDN, etc.)

Valeur Description
account
auto
msdn
none
profile
trial

MsdnLicenseType

Type de licence MSDN (par exemple, Visual Studio Professional, Visual Studio Enterprise, etc.)

Valeur Description
eligible
enterprise
none
platforms
premium
professional
testProfessional
ultimate

PagedGraphMemberList

Une page d’utilisateurs

Nom Type Description
members

UserEntitlement[]

Entité utilisateur avec des propriétés supplémentaires, notamment sa licence, ses extensions et son appartenance au projet

ProjectEntitlement

Relation entre un projet et les autorisations effectives de l’utilisateur dans ce projet.

Nom Type Description
assignmentSource

AssignmentSource

Source de l’affectation (par exemple, groupe ou inconnu).

group

Group

Groupe de projets (par exemple, Contributeur, Lecteur, etc.)

projectPermissionInherited

ProjectPermissionInherited

Indique si l’utilisateur hérite des autorisations d’accès à un projet par le biais d’une appartenance à un groupe Azure DevOps ou AAD.

projectRef

ProjectRef

Référence du projet

teamRefs

TeamRef[]

Référence de l’équipe.

ProjectPermissionInherited

Indique si l’utilisateur hérite des autorisations sur un projet via une appartenance à un groupe Azure DevOps ou AAD.

Valeur Description
inherited
notInherited
notSet

ProjectRef

Référence à un projet

Nom Type Description
id

string

ID de projet.

name

string

Nom du projet.

Classe pour représenter une collection de liens de référence REST.

Nom Type Description
links

object

Vue en lecture seule des liens. Étant donné que les liens de référence sont en lecture seule, nous voulons uniquement les exposer en lecture seule.

TeamRef

Référence à une équipe

Nom Type Description
id

string

ID de l’équipe

name

string

Nom de l'équipe

UserEntitlement

Entité utilisateur avec des propriétés supplémentaires, notamment sa licence, ses extensions et son appartenance au projet

Nom Type Description
accessLevel

AccessLevel

Niveau d’accès de l’utilisateur indiqué par une licence.

dateCreated

string

[En lecture seule] Date à laquelle l’utilisateur a été ajouté à la collection.

extensions

Extension[]

Extensions de l’utilisateur.

groupAssignments

GroupEntitlement[]

[En lecture seule] GroupEntitlements auxquels cet utilisateur appartient.

id

string

Identificateur unique qui correspond à l’ID de l’identité associée à GraphMember.

lastAccessedDate

string

[En lecture seule] Date du dernier accès de l’utilisateur à la collection.

projectEntitlements

ProjectEntitlement[]

Relation entre un projet et les autorisations effectives de l’utilisateur dans ce projet.

user

GraphUser

Référence utilisateur.