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 を取得または設定します。