Access Control - List Users

Service:

Azure Sphere Public API

API Version:

v2

Obtenga todas las entidades de seguridad (usuario) que tienen roles asignados dentro del ámbito de un inquilino.

GET https://prod.core.sphere.azure.net/v2/tenants/{tenantId}/users

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
tenantId	path	True	string uuid	Identificador de inquilino en el que se van a obtener roles.

Respuestas

Nombre	Tipo	Description
200 OK	AccessControlPrincipalsResponse	Correcto.

Ejemplos

List users

Sample Request

GET https://prod.core.sphere.azure.net/v2/tenants/768c2cd6-1bf0-4521-9f53-084a331d81cb/users

Sample Response

Status code:

200

{
  "TenantId": "768c2cd6-1bf0-4521-9f53-084a331d81cb",
  "Principals": [
    {
      "PrincipalId": "474dfa25-a681-4bda-9932-7d42354c944d",
      "DisplayName": "Avery Howard",
      "Mail": "avery@contoso.com",
      "Roles": [
        "Administrator",
        "Contributor"
      ]
    },
    {
      "PrincipalId": "599c0db8-e54a-4ccf-9c39-67cc22038597",
      "DisplayName": "Parker Jones",
      "Mail": "parker@contoso.com",
      "Roles": [
        "Contributor"
      ]
    }
  ]
}

Definiciones

Nombre	Description
AccessControlPrincipal
AccessControlPrincipalsResponse

AccessControlPrincipal

Nombre	Tipo	Description
DisplayName	string	Obtiene o establece el nombre para mostrar asociado del usuario.
Mail	string	Obtiene o establece el correo electrónico asociado del usuario.
PrincipalId	string	Obtiene o establece el identificador de entidad de seguridad de la entidad de servicio o usuario.
Roles	string[]	Obtiene o establece los roles asignados a otro PrincipalId.

AccessControlPrincipalsResponse

Nombre	Tipo	Description
Principals	AccessControlPrincipal[]	Obtiene o establece la colección de entidades de seguridad con roles asignados en este inquilino.
TenantId	string	Obtiene o establece el identificador del inquilino de Azure Sphere.