Access Control - List Users

Referenz

Service:: Azure Sphere Public API

API Version:: v2

Rufen Sie alle Prinzipale (Benutzer) ab, denen rollen innerhalb des Bereichs eines Mandanten zugewiesen sind.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
tenantId	path	True	string uuid	Die Mandanten-ID, in der Rollen abgerufen werden sollen.

Antworten

Name	Typ	Beschreibung
200 OK	AccessControlPrincipalsResponse	Erfolg.

Beispiele

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"
      ]
    }
  ]
}

Definitionen

Name	Beschreibung
AccessControlPrincipal
AccessControlPrincipalsResponse

AccessControlPrincipal

Name	Typ	Beschreibung
DisplayName	string	Ruft den zugeordneten Anzeigenamen des Benutzers ab oder legt diese fest.
Mail	string	Ruft die zugeordnete E-Mail des Benutzers ab oder legt sie fest.
PrincipalId	string	Ruft die Prinzipal-ID des Benutzer-/Dienstprinzipals ab oder legt diese fest.
Roles	string[]	Ruft die Rollen ab, die anderen PrincipalId zugewiesen sind, oder legt sie fest.

AccessControlPrincipalsResponse

Name	Typ	Beschreibung
Principals	AccessControlPrincipal[]	Ruft die Auflistung von Prinzipalen ab, deren Rollen in diesem Mandanten zugewiesen sind, oder legt diese fest.
TenantId	string	Ruft die ID des Azure Sphere-Mandanten ab oder legt sie fest.