Compartir a través de

Users - List

  • Referencia
Servicio:
Graph
Versión de la API:
7.1-preview.1

Obtenga una lista de todos los usuarios de un ámbito determinado.

Dado que la lista de usuarios puede ser grande, los resultados se devuelven en páginas de usuarios. Si hay más resultados de los que se pueden devolver en una sola página, el conjunto de resultados contendrá un token de continuación para la recuperación del siguiente conjunto de resultados.

GET https://vssps.dev.azure.com/{organization}/_apis/graph/users?api-version=7.1-preview.1
Con parámetros opcionales: 
GET https://vssps.dev.azure.com/{organization}/_apis/graph/users?subjectTypes={subjectTypes}&continuationToken={continuationToken}&scopeDescriptor={scopeDescriptor}&api-version=7.1-preview.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-preview.1" para usar esta versión de la API.
continuationToken
 query

string

Blob de datos opaco que permite que la página siguiente de datos se reanude inmediatamente después de la finalización de la página anterior. La única manera confiable de saber si quedan más datos es la presencia de un token de continuación.
scopeDescriptor
 query

string

Especifique un ámbito no predeterminado (colección, proyecto) para buscar usuarios.
subjectTypes
 query

string (array (string))

Lista separada por comas de subtipos de asunto de usuario para reducir los resultados recuperados, por ejemplo, msa, "aad", "svc" (identidad de servicio), "imp" (identidad importada), etc.

Respuestas

Nombre Tipo Description
200 OK

GraphUser[]

operación correcta

Encabezados

X-MS-ContinuationToken: string

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.graph Concede la capacidad de leer la información de usuario, grupo, ámbito y pertenencia a grupos.

Ejemplos

Solicitud de ejemplo

GET https://vssps.dev.azure.com/{organization}/_apis/graph/users?api-version=7.1-preview.1

Respuesta de muestra

status code:
200 
{
  "count": 5,
  "value": [
    {
      "subjectKind": "user",
      "metaType": "member",
      "domain": "LOCAL AUTHORITY",
      "principalName": "TeamFoundationService (TEAM FOUNDATION)",
      "mailAddress": "",
      "origin": "vsts",
      "originId": "00ca946b-2fe9-4f2a-ae2f-40d5c48001bc",
      "displayName": "TeamFoundationService (TEAM FOUNDATION)",
      "_links": {
        "self": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Users/acs.Nzc4OWYwOWQtZTA1My00ZjJlLWJkZWUtMGM4Zjg0NzZhNGJj"
        },
        "memberships": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Memberships/acs.Nzc4OWYwOWQtZTA1My00ZjJlLWJkZWUtMGM4Zjg0NzZhNGJj"
        },
        "membershipState": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/MembershipStates/acs.Nzc4OWYwOWQtZTA1My00ZjJlLWJkZWUtMGM4Zjg0NzZhNGJj"
        },
        "storageKey": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/StorageKeys/acs.Nzc4OWYwOWQtZTA1My00ZjJlLWJkZWUtMGM4Zjg0NzZhNGJj"
        },
        "avatar": {
          "href": "https://dev.azure.com/Fabrikam/_apis/GraphProfile/MemberAvatars/acs.Nzc4OWYwOWQtZTA1My00ZjJlLWJkZWUtMGM4Zjg0NzZhNGJj"
        }
      },
      "url": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Users/acs.Nzc4OWYwOWQtZTA1My00ZjJlLWJkZWUtMGM4Zjg0NzZhNGJj",
      "descriptor": "acs.Nzc4OWYwOWQtZTA1My00ZjJlLWJkZWUtMGM4Zjg0NzZhNGJj"
    },
    {
      "subjectKind": "user",
      "metaType": "guest",
      "domain": "45aa3d2d-7442-473d-b4d3-3c670da9dd96",
      "principalName": "fabrikamfiber4@hotmail.com",
      "mailAddress": "fabrikamfiber4@hotmail.com",
      "origin": "aad",
      "originId": "ddddb7d1-2de3-4bab-98b6-ddcc994e964d",
      "displayName": "Jamal Hartnett",
      "_links": {
        "self": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Users/aad.YWZkMzM2ZGQtZTgwYy03MWViLThlYmQtODMzNjMxYmEwNWM2"
        },
        "memberships": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Memberships/aad.YWZkMzM2ZGQtZTgwYy03MWViLThlYmQtODMzNjMxYmEwNWM2"
        },
        "membershipState": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/MembershipStates/aad.YWZkMzM2ZGQtZTgwYy03MWViLThlYmQtODMzNjMxYmEwNWM2"
        },
        "storageKey": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/StorageKeys/aad.YWZkMzM2ZGQtZTgwYy03MWViLThlYmQtODMzNjMxYmEwNWM2"
        },
        "avatar": {
          "href": "https://dev.azure.com/Fabrikam/_apis/GraphProfile/MemberAvatars/aad.YWZkMzM2ZGQtZTgwYy03MWViLThlYmQtODMzNjMxYmEwNWM2"
        }
      },
      "url": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Users/aad.YWZkMzM2ZGQtZTgwYy03MWViLThlYmQtODMzNjMxYmEwNWM2",
      "descriptor": "aad.YWZkMzM2ZGQtZTgwYy03MWViLThlYmQtODMzNjMxYmEwNWM2"
    },
    {
      "subjectKind": "user",
      "metaType": "member",
      "domain": "45aa3d2d-7442-473d-b4d3-3c670da9dd96",
      "principalName": "ftotten@vscsi.us",
      "mailAddress": "ftotten@vscsi.us",
      "origin": "aad",
      "originId": "4be8f294-000d-4431-8506-57420b88e204",
      "displayName": "Francis Totten",
      "_links": {
        "self": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Users/aad.NjU5MDNmOTItNTNkYy03MWIzLWJiMGUtZTY5Y2ZhMWNiNzE5"
        },
        "memberships": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Memberships/aad.NjU5MDNmOTItNTNkYy03MWIzLWJiMGUtZTY5Y2ZhMWNiNzE5"
        },
        "membershipState": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/MembershipStates/aad.NjU5MDNmOTItNTNkYy03MWIzLWJiMGUtZTY5Y2ZhMWNiNzE5"
        },
        "storageKey": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/StorageKeys/aad.NjU5MDNmOTItNTNkYy03MWIzLWJiMGUtZTY5Y2ZhMWNiNzE5"
        },
        "avatar": {
          "href": "https://dev.azure.com/Fabrikam/_apis/GraphProfile/MemberAvatars/aad.NjU5MDNmOTItNTNkYy03MWIzLWJiMGUtZTY5Y2ZhMWNiNzE5"
        }
      },
      "url": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Users/aad.NjU5MDNmOTItNTNkYy03MWIzLWJiMGUtZTY5Y2ZhMWNiNzE5",
      "descriptor": "aad.NjU5MDNmOTItNTNkYy03MWIzLWJiMGUtZTY5Y2ZhMWNiNzE5"
    },
    {
      "subjectKind": "user",
      "metaType": "member",
      "domain": "45aa3d2d-7442-473d-b4d3-3c670da9dd96",
      "principalName": "jmarks@vscsi.us",
      "mailAddress": "jmarks@vscsi.us",
      "origin": "aad",
      "originId": "f867eff7-2024-49b4-9626-25777ae370f6",
      "displayName": "Justin VSCSI AAD",
      "_links": {
        "self": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Users/aad.NGRkODVlNDctOGM1MS03MTZlLTljZGUtZjA3Yjc0NDU0ZWFj"
        },
        "memberships": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Memberships/aad.NGRkODVlNDctOGM1MS03MTZlLTljZGUtZjA3Yjc0NDU0ZWFj"
        },
        "membershipState": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/MembershipStates/aad.NGRkODVlNDctOGM1MS03MTZlLTljZGUtZjA3Yjc0NDU0ZWFj"
        },
        "storageKey": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/StorageKeys/aad.NGRkODVlNDctOGM1MS03MTZlLTljZGUtZjA3Yjc0NDU0ZWFj"
        },
        "avatar": {
          "href": "https://dev.azure.com/Fabrikam/_apis/GraphProfile/MemberAvatars/aad.NGRkODVlNDctOGM1MS03MTZlLTljZGUtZjA3Yjc0NDU0ZWFj"
        }
      },
      "url": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Users/aad.NGRkODVlNDctOGM1MS03MTZlLTljZGUtZjA3Yjc0NDU0ZWFj",
      "descriptor": "aad.NGRkODVlNDctOGM1MS03MTZlLTljZGUtZjA3Yjc0NDU0ZWFj"
    },
    {
      "subjectKind": "user",
      "domain": "Build",
      "principalName": "10feb381-82c3-4902-8e1f-840299a48ae4",
      "mailAddress": "",
      "origin": "vsts",
      "originId": "ca261b38-d22b-4b13-b0d8-f6b8cbe16f90",
      "displayName": "Project Collection Build Service (Fabrikam)",
      "_links": {
        "self": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Users/svc.OWI0ZjczMzYtYzEzMC00MGJkLTg3ZjMtNDIwMTM2MWRkYmQxOkJ1aWxkOjEwZmViMzgxLTgyYzMtNDkwMi04ZTFmLTg0MDI5OWE0OGFlNA"
        },
        "memberships": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Memberships/svc.OWI0ZjczMzYtYzEzMC00MGJkLTg3ZjMtNDIwMTM2MWRkYmQxOkJ1aWxkOjEwZmViMzgxLTgyYzMtNDkwMi04ZTFmLTg0MDI5OWE0OGFlNA"
        },
        "membershipState": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/MembershipStates/svc.OWI0ZjczMzYtYzEzMC00MGJkLTg3ZjMtNDIwMTM2MWRkYmQxOkJ1aWxkOjEwZmViMzgxLTgyYzMtNDkwMi04ZTFmLTg0MDI5OWE0OGFlNA"
        },
        "storageKey": {
          "href": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/StorageKeys/svc.OWI0ZjczMzYtYzEzMC00MGJkLTg3ZjMtNDIwMTM2MWRkYmQxOkJ1aWxkOjEwZmViMzgxLTgyYzMtNDkwMi04ZTFmLTg0MDI5OWE0OGFlNA"
        },
        "avatar": {
          "href": "https://dev.azure.com/Fabrikam/_apis/GraphProfile/MemberAvatars/svc.OWI0ZjczMzYtYzEzMC00MGJkLTg3ZjMtNDIwMTM2MWRkYmQxOkJ1aWxkOjEwZmViMzgxLTgyYzMtNDkwMi04ZTFmLTg0MDI5OWE0OGFlNA"
        }
      },
      "url": "https://vssps.dev.azure.com/Fabrikam/_apis/Graph/Users/svc.OWI0ZjczMzYtYzEzMC00MGJkLTg3ZjMtNDIwMTM2MWRkYmQxOkJ1aWxkOjEwZmViMzgxLTgyYzMtNDkwMi04ZTFmLTg0MDI5OWE0OGFlNA",
      "descriptor": "svc.OWI0ZjczMzYtYzEzMC00MGJkLTg3ZjMtNDIwMTM2MWRkYmQxOkJ1aWxkOjEwZmViMzgxLTgyYzMtNDkwMi04ZTFmLTg0MDI5OWE0OGFlNA"
    }
  ]
}

Definiciones

Nombre Description
GraphUser
ReferenceLinks

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

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.
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.