User Entitlements - Search User Entitlements

Referencia

Servicio:: Member Entitlement Management

Versión de la API:: 7.1

Obtenga un conjunto paginado de derechos de usuario que coincidan con los criterios de filtro y ordenación creados con propiedades que coincidan con la entrada de selección.

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

Con parámetros opcionales:

GET https://vsaex.dev.azure.com/{organization}/_apis/userentitlements?continuationToken={continuationToken}&select={select}&$filter={$filter}&$orderBy={$orderBy}&api-version=7.1

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
organization	path	True	string	Nombre de la organización de Azure DevOps.
api-version	query	True	string	Versión de la API que se va a usar. Debe establecerse en "7.1" para usar esta versión de la API.
$filter	query		string	Operadores de igualdad relacionados con la búsqueda de derechos de usuario separados por cláusulas y . Los filtros válidos incluyen: licenseId, licenseStatus, userType y name. licenseId: filtra en función de la asignación de licencias mediante nombres de licencia. Es decir, licenseId eq "Account-Stakeholders" o licenseId eq "Account-Express". licenseStatus: filtra según el estado de la licencia. actualmente solo admite deshabilitado. es decir, licenseStatus eq 'Disabled'. Para obtener licencias básicas deshabilitadas, pasaría (licenseId eq 'Account-Express' y licenseStatus eq 'Disabled'). userType: filtra el tipo de identidad. Los tipos admitidos son miembros o invitados, es decir, userType eq 'member'. name: filtra si el nombre para mostrar del usuario o el correo electrónico contiene una entrada determinada. Es decir, obtener todos los usuarios con "test" en el correo electrónico o displayname es "name eq 'test'". Una consulta válida podría ser: (licenseId eq 'Account-Stakeholders' o (licenseId eq 'Account-Express' and licenseStatus eq 'Disabled')) y name eq 'test' and userType eq 'guest'.
$orderBy	query		string	PropertyName y Order (separados por un espacio ( )) para ordenar (por ejemplo, lastAccessed desc). El orden predeterminado es ascendente. las propiedades válidas para ordenar por son dateCreated, lastAccessed y name
continuationToken	query		string	Token de continuación para obtener la página siguiente del conjunto de datos. Si se pasa null, obtiene la primera página.
select	query		UserEntitlementProperty	Lista separada por comas (",") de propiedades que se van a seleccionar en los derechos de resultado. los nombres de las propiedades son : "Projects, "Extensions" y "Grouprules".

Respuestas

Nombre	Tipo	Description
200 OK	PagedUserEntitlementsList	operación correcta

Seguridad

oauth2

Tipo: oauth2
Flujo: accessCode
Dirección URL de autorización: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Dirección URL del 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

Ámbitos

Nombre	Description
vso.memberentitlementmanagement	Concede la capacidad de leer usuarios, sus licencias, así como proyectos y extensiones a los que pueden acceder.

Definiciones

Nombre	Description
AccessLevel	Licencia asignada a un usuario
AccountLicenseType	Tipo de licencia de cuenta (por ejemplo, Express, Parte interesada, etc.). Para usar AccountLicenseType, LicensingSource debe definirse como "account" en el cuerpo de la solicitud.
AccountUserStatus	Estado del usuario en la cuenta
AssignmentSource	Origen de asignación de la licencia (por ejemplo, Grupo, Desconocido, etc.
GraphGroup	Entidad de grupo de grafos
GraphUser
Group	Grupo de proyectos (por ejemplo, Colaborador, Lector, etc.)
GroupEntitlement	Una entidad de grupo con propiedades adicionales, incluidas su licencia, extensiones y pertenencia a proyectos
GroupLicensingRuleStatus	Estado de la regla de grupo.
GroupType	Tipo de grupo
LicensingSource	Origen de licencias (por ejemplo, cuenta. MSDN, etc.)
MsdnLicenseType	Tipo de licencia de MSDN (por ejemplo, Visual Studio Professional, Visual Studio Enterprise, etc.). Para usar MsdnLicenseType, LicensingSource debe definirse como "msdn" en el cuerpo de la solicitud.
PagedUserEntitlementsList	Página de derechos de usuario
ProjectEntitlement	Relación entre un proyecto y los permisos efectivos del usuario en ese proyecto.
ProjectPermissionInherited	Si el usuario hereda permisos para un proyecto a través de una pertenencia a grupos de Azure DevOps o AAD.
ProjectRef	Referencia a un proyecto
ReferenceLinks	Clase que representa una colección de vínculos de referencia rest.
TeamRef	Referencia a un equipo
UserEntitlement	Una entidad de usuario con propiedades adicionales, incluidas su licencia, extensiones y pertenencia al proyecto
UserEntitlementProperty	Lista separada por comas (",") de propiedades que se van a seleccionar en los derechos de resultado. los nombres de las propiedades son : "Projects, "Extensions" y "Grouprules".

AccessLevel

Object

Licencia asignada a un usuario

Nombre	Tipo	Description
accountLicenseType	AccountLicenseType	Tipo de licencia de cuenta (por ejemplo, Express, Parte interesada, etc.). Para usar AccountLicenseType, LicensingSource debe definirse como "account" en el cuerpo de la solicitud.
assignmentSource	AssignmentSource	Origen de asignación de la licencia (por ejemplo, Grupo, Desconocido, etc.
licenseDisplayName	string	Nombre para mostrar de la licencia
licensingSource	LicensingSource	Origen de licencias (por ejemplo, cuenta. MSDN, etc.)
msdnLicenseType	MsdnLicenseType	Tipo de licencia de MSDN (por ejemplo, Visual Studio Professional, Visual Studio Enterprise, etc.). Para usar MsdnLicenseType, LicensingSource debe definirse como "msdn" en el cuerpo de la solicitud.
status	AccountUserStatus	Estado del usuario en la cuenta
statusMessage	string	Mensaje de estado.

AccountLicenseType

Enumeración

Tipo de licencia de cuenta (por ejemplo, Express, Parte interesada, etc.). Para usar AccountLicenseType, LicensingSource debe definirse como "account" en el cuerpo de la solicitud.

Valor	Description
advanced
earlyAdopter
express
none
professional
stakeholder

AccountUserStatus

Enumeración

Estado del usuario en la cuenta

Valor	Description
active	El usuario ha iniciado sesión al menos una vez en la cuenta de VSTS
deleted	El administrador de la cuenta de VSTS quita al usuario de la cuenta de VSTS.
disabled	El usuario no puede iniciar sesión; usado principalmente por el administrador para quitar temporalmente un usuario debido a ausencia o reasignación de licencias
expired	El usuario puede iniciar sesión; se usa principalmente cuando la licencia está en estado expirado y se proporciona un período de gracia.
none
pending	El administrador de la cuenta de VSTS invita al usuario a unirse a la cuenta de VSTS, pero aún no se ha registrado o iniciado sesión.
pendingDisabled	El usuario está deshabilitado; si se vuelve a habilitar, seguirán estando en estado Pendiente.

AssignmentSource

Enumeración

Origen de asignación de la licencia (por ejemplo, Grupo, Desconocido, etc.

Valor	Description
groupRule
none
unknown

GraphGroup

Object

Entidad de grupo de grafos

Nombre	Tipo	Description
_links	ReferenceLinks	Este campo contiene cero o más vínculos interesantes sobre el tema del grafo. Estos vínculos se pueden invocar para obtener relaciones adicionales o información más detallada sobre este tema del grafo.
description	string	Una frase corta para ayudar a los lectores humanos a desambiguar grupos con nombres similares
descriptor	string	El descriptor es la forma principal de hacer referencia al asunto del grafo mientras se ejecuta el sistema. Este campo identificará de forma única el mismo asunto del grafo en cuentas y organizaciones.
displayName	string	Este es el nombre para mostrar no único del asunto del grafo. Para cambiar este campo, debe modificar su valor en el proveedor de origen.
domain	string	Representa el nombre del contenedor de origen de un miembro de grafo. (Para MSA, este es "Windows Live ID", para AD el nombre del dominio, para AAD el tenantID del directorio, para los grupos de VSTS ScopeId, etc.)
legacyDescriptor	string	[Solo uso interno] El descriptor heredado está aquí en caso de que necesite acceder a IMS de versión anterior mediante el descriptor de identidad.
mailAddress	string	Dirección de correo electrónico del registro de un miembro de grafo determinado. Puede ser diferente del nombre principal.
origin	string	Tipo de proveedor de origen para el identificador de origen (por ejemplo: AD, AAD, MSA)
originId	string	Identificador único del sistema de origen. Normalmente un sid, id. de objeto o Guid. Las operaciones de vinculación y desvinculación pueden hacer que este valor cambie para un usuario porque el usuario no está respaldado por un proveedor diferente y tiene un identificador único diferente en el nuevo proveedor.
principalName	string	Este es el nombre principal de este miembro del grafo del proveedor de origen. El proveedor de origen puede cambiar este campo a lo largo del tiempo y no se garantiza que sea inmutable durante la vida del miembro del grafo por VSTS.
subjectKind	string	Este campo identifica el tipo del asunto del grafo (por ejemplo: Grupo, Ámbito, Usuario).
url	string	Esta dirección URL es la ruta completa al recurso de origen de este tema del grafo.

GraphUser

Object

Nombre	Tipo	Description
_links	ReferenceLinks	Este campo contiene cero o más vínculos interesantes sobre el tema del grafo. Estos vínculos se pueden invocar para obtener relaciones adicionales o información más detallada sobre este tema del grafo.
descriptor	string	El descriptor es la forma principal de hacer referencia al asunto del grafo mientras se ejecuta el sistema. Este campo identificará de forma única el mismo asunto del grafo en cuentas y organizaciones.
directoryAlias	string	Nombre corto, generalmente único para el usuario en el directorio de respaldo. Para los usuarios de AAD, esto corresponde al alias de correo, que suele ser similar a la parte de la dirección de correo del usuario antes del signo @ . Para los usuarios de GitHub, esto corresponde al identificador de usuario de GitHub.
displayName	string	Este es el nombre para mostrar no único del asunto del grafo. Para cambiar este campo, debe modificar su valor en el proveedor de origen.
domain	string	Representa el nombre del contenedor de origen de un miembro de grafo. (Para MSA, este es "Windows Live ID", para AD el nombre del dominio, para AAD el tenantID del directorio, para los grupos de VSTS ScopeId, etc.)
isDeletedInOrigin	boolean	Cuando es true, el grupo se ha eliminado en el proveedor de identidades.
legacyDescriptor	string	[Solo uso interno] El descriptor heredado está aquí en caso de que necesite acceder a IMS de versión anterior mediante el descriptor de identidad.
mailAddress	string	Dirección de correo electrónico del registro de un miembro de grafo determinado. Puede ser diferente del nombre principal.
metaType	string	Metatipo del usuario en el origen, como "miembro", "invitado", etc. Consulte UserMetaType para ver el conjunto de valores posibles.
origin	string	Tipo de proveedor de origen para el identificador de origen (por ejemplo: AD, AAD, MSA)
originId	string	Identificador único del sistema de origen. Normalmente un sid, id. de objeto o Guid. Las operaciones de vinculación y desvinculación pueden hacer que este valor cambie para un usuario porque el usuario no está respaldado por un proveedor diferente y tiene un identificador único diferente en el nuevo proveedor.
principalName	string	Este es el nombre principal de este miembro del grafo del proveedor de origen. El proveedor de origen puede cambiar este campo a lo largo del tiempo y no se garantiza que sea inmutable durante la vida del miembro del grafo por VSTS.
subjectKind	string	Este campo identifica el tipo del asunto del grafo (por ejemplo: Grupo, Ámbito, Usuario).
url	string	Esta dirección URL es la ruta completa al recurso de origen de este tema del grafo.

Group

Object

Grupo de proyectos (por ejemplo, Colaborador, Lector, etc.)

Nombre	Tipo	Description
displayName	string	Nombre para mostrar del grupo
groupType	GroupType	Tipo de grupo

GroupEntitlement

Object

Una entidad de grupo con propiedades adicionales, incluidas su licencia, extensiones y pertenencia a proyectos

Nombre	Tipo	Description
group	GraphGroup	Referencia de miembro.
id	string (uuid)	Identificador único que coincide con el identificador de GraphMember.
lastExecuted	string (date-time)	[Readonly] La última vez que se ejecutó la regla de licencias de grupo (independientemente de si se realizaron cambios).
licenseRule	AccessLevel	Regla de licencia.
members	UserEntitlement[]	Miembros del grupo. Solo se usa al crear un nuevo grupo.
projectEntitlements	ProjectEntitlement[]	Relación entre un proyecto y los permisos efectivos del miembro en ese proyecto.
status	GroupLicensingRuleStatus	Estado de la regla de grupo.

GroupLicensingRuleStatus

Enumeración

Estado de la regla de grupo.

Valor	Description
applied	Se aplica la regla
applyPending	La regla se crea o actualiza, pero la aplicación está pendiente
incompatible	La regla de grupo no era compatible
unableToApply	La regla no se pudo aplicar inesperadamente y se debe reintentar

GroupType

Enumeración

Tipo de grupo

Valor	Description
custom
projectAdministrator
projectContributor
projectReader
projectStakeholder

LicensingSource

Enumeración

Origen de licencias (por ejemplo, cuenta. MSDN, etc.)

Valor	Description
account
auto
msdn
none
profile
trial

MsdnLicenseType

Enumeración

Tipo de licencia de MSDN (por ejemplo, Visual Studio Professional, Visual Studio Enterprise, etc.). Para usar MsdnLicenseType, LicensingSource debe definirse como "msdn" en el cuerpo de la solicitud.

Valor	Description
eligible
enterprise
none
platforms
premium
professional
testProfessional
ultimate

PagedUserEntitlementsList

Object

Página de derechos de usuario

Nombre	Tipo	Description
continuationToken	string	Token de continuación para la página siguiente de datos. Puede ser NULL, si no existe más datos.
items	UserEntitlement[]	Elementos de derechos de usuario solicitados.
totalCount	integer (int32)	Recuento total de los elementos de derechos de usuario existentes.

ProjectEntitlement

Object

Relación entre un proyecto y los permisos efectivos del usuario en ese proyecto.

Nombre	Tipo	Description
assignmentSource	AssignmentSource	Origen de asignación (por ejemplo, Grupo o Desconocido).
group	Group	Grupo de proyectos (por ejemplo, Colaborador, Lector, etc.)
projectPermissionInherited	ProjectPermissionInherited	Si el usuario hereda permisos para un proyecto a través de una pertenencia a grupos de Azure DevOps o AAD.
projectRef	ProjectRef	Referencia del proyecto
teamRefs	TeamRef[]	Team Ref.

ProjectPermissionInherited

Enumeración

Si el usuario hereda permisos para un proyecto a través de una pertenencia a grupos de Azure DevOps o AAD.

Valor	Description
inherited
notInherited
notSet

ProjectRef

Object

Referencia a un proyecto

Nombre	Tipo	Description
id	string (uuid)	Id. de proyecto.
name	string	Nombre del proyecto.

ReferenceLinks

Object

Clase que representa una colección de vínculos de referencia rest.

Nombre	Tipo	Description
links	object	Vista de solo lectura de los vínculos. Dado que los vínculos de referencia son de solo lectura, solo queremos exponerlos como de solo lectura.

TeamRef

Object

Referencia a un equipo

Nombre	Tipo	Description
id	string (uuid)	Id. de equipo
name	string	Nombre del equipo