Access Control - List Users

Service:

Azure Sphere Public API

API Version:

v2

Hämta alla huvudkonton (användare) som har tilldelats roller inom omfånget för en klientorganisation.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
tenantId	path	True	string uuid	Det klientorganisations-ID som roller ska hämtas i.

Svar

Name	Typ	Description
200 OK	AccessControlPrincipalsResponse	Åtgärden lyckades.

Exempel

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

Definitioner

Name	Description
AccessControlPrincipal
AccessControlPrincipalsResponse

AccessControlPrincipal

Name	Typ	Description
DisplayName	string	Hämtar eller anger användarens associerade visningsnamn.
Mail	string	Hämtar eller anger användarens associerade e-post.
PrincipalId	string	Hämtar eller anger huvudkonto-ID för användarens/tjänstens huvudnamn.
Roles	string[]	Hämtar eller anger rollerna som tilldelats annat PrincipalId

AccessControlPrincipalsResponse

Name	Typ	Description
Principals	AccessControlPrincipal[]	Hämtar eller anger en samling huvudkonton med roller som tilldelats i den här klientorganisationen.
TenantId	string	Hämtar eller anger ID för Azure Sphere-klientorganisationen.