Share via

Access Control - List Users

  • Reference
Service:
Azure Sphere Public API
API Version:
v2

Get all of the principals (user) which have roles assigned to them within the scope of a tenant.

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

URI Parameters

Name In Required Type Description
tenantId
 path True

string

uuid

The tenant ID in which to get roles.

Responses

Name Type Description
200 OK

AccessControlPrincipalsResponse

Success.

Examples

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

Definitions

Name Description
AccessControlPrincipal
AccessControlPrincipalsResponse

AccessControlPrincipal

Name Type Description
DisplayName

string

Gets or sets the associated display name of the user.
Mail

string

Gets or sets the associated email of the user.
PrincipalId

string

Gets or sets the principal ID of the user/service principal.
Roles

string[]

Gets or sets the roles assigned other PrincipalId

AccessControlPrincipalsResponse

Name Type Description
Principals

AccessControlPrincipal[]

Gets or sets the collection of principals with roles assigned in this tenant.
TenantId

string

Gets or sets the ID of the Azure Sphere tenant.