Access Control - List Users

Service:

Azure Sphere Public API

API Version:

v2

获取 (用户) 在租户范围内分配了角色的所有主体。

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

URI 参数

名称	在	必需	类型	说明
tenantId	path	True	string uuid	要在其中获取角色的租户 ID。

响应

名称	类型	说明
200 OK	AccessControlPrincipalsResponse	成功。

示例

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

定义

名称	说明
AccessControlPrincipal
AccessControlPrincipalsResponse

AccessControlPrincipal

名称	类型	说明
DisplayName	string	获取或设置用户的关联显示名称。
Mail	string	获取或设置用户的关联电子邮件。
PrincipalId	string	获取或设置用户/服务主体的主体 ID。
Roles	string[]	获取或设置分配给其他 PrincipalId 的角色

AccessControlPrincipalsResponse

名称	类型	说明
Principals	AccessControlPrincipal[]	获取或设置在此租户中分配了角色的主体集合。
TenantId	string	获取或设置 Azure Sphere 租户的 ID。