Group User - List

リファレンス

サービス:: API Management

API バージョン:: 2024-05-01

グループに関連付けられているユーザーエンティティのコレクションを一覧表示します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users?api-version=2024-05-01

省略可能なパラメーターを含む:

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users?$filter={$filter}&$top={$top}&$skip={$skip}&api-version=2024-05-01

URI パラメーター

名前	/	必須	型	説明
groupId	path	True	string minLength: 1 maxLength: 256	グループ識別子。現在の API Management サービスインスタンスで一意である必要があります。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前では大文字と小文字が区別されません。
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API Management サービスの名前。
subscriptionId	path	True	string (uuid)	ターゲットサブスクリプションの ID。値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。
$filter	query		string	\|フィールド \|使用法 \|サポートされる演算子 \|サポートされている関数 \| \|-------------\|-------------\|-------------\|-------------\| \|name \|filter \|ge、le、eq、ne、gt、lt \|substringof、contains、startswith、endswith \| \|firstName \|filter \|ge、le、eq、ne、gt、lt \|substringof、contains、startswith、endswith \| \|lastName \|filter \|ge、le、eq、ne、gt、lt \|substringof、contains、startswith、endswith \| \|電子メール \|filter \|ge、le、eq、ne、gt、lt \|substringof、contains、startswith、endswith \| \|registrationDate \|filter \|ge、le、eq、ne、gt、lt \| \| \|note \|filter \|ge、le、eq、ne、gt、lt \|substringof、contains、startswith、endswith \|
$skip	query		integer (int32) minimum: 0	スキップするレコードの数。
$top	query		integer (int32) minimum: 1	返されるレコードの数。

応答

名前	型	説明
200 OK	UserCollection	グループに関連付けられているユーザーエンティティのコレクションを一覧表示します。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前	説明
user_impersonation	ユーザーアカウントを偽装する

例

ApiManagementListGroupUsers

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/groups/57d2ef278aa04f0888cba3f3/users?api-version=2024-05-01

応答のサンプル

状態コード:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/kjoshiarmTemplateUser1",
      "type": "Microsoft.ApiManagement/service/groups/users",
      "name": "armTemplateUser1",
      "properties": {
        "firstName": "user1",
        "lastName": "lastname1",
        "email": "user1@live.com",
        "state": "active",
        "registrationDate": "2017-05-31T18:54:41.447Z",
        "note": "note for user 1",
        "identities": [
          {
            "provider": "Basic",
            "id": "user1@live.com"
          }
        ]
      }
    }
  ],
  "count": 1,
  "nextLink": ""
}

定義

名前	説明
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
GroupContractProperties	グループコントラクトのプロパティ。
GroupType	グループの種類。
UserCollection	[Paged Users]$ページングされたユーザー$ リストの表現。
UserContract	ユーザーの詳細。
UserIdentityContract	ユーザー ID の詳細。
UserState	アカウントの状態。ユーザーがアクティブかどうかを指定します。ブロックされたユーザーは、開発者ポータルにサインインしたり、サブスクライブされた製品の API を呼び出したりできません。既定の状態はアクティブです。

ErrorAdditionalInfo

Object

リソース管理エラーの追加情報。

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

GroupContractProperties

Object

グループコントラクトのプロパティ。

名前	型	説明
builtIn	boolean	グループが 3 つのシステムグループ (管理者、開発者、ゲスト) のいずれかである場合は true。それ以外の場合は false。
description	string maxLength: 1000	グループの説明。 HTML 書式設定タグを含めることができます。
displayName	string minLength: 1 maxLength: 300	グループ名。
externalId	string	外部グループの場合、このプロパティには、Azure Active Directory `aad://<tenant>.onmicrosoft.com/groups/<group object id>`の場合など、外部 ID プロバイダーのグループの ID が含まれます。それ以外の場合、値は null です。
type	GroupType	グループの種類。

GroupType

列挙

グループの種類。

値	説明
custom
external
system

UserCollection

Object

[Paged Users]$ページングされたユーザー$ リストの表現。

名前	型	説明
count	integer (int64)	すべてのページの合計レコード数。
nextLink	string	次のページリンク (ある場合)。
value	UserContract[]	ページ値。

UserContract

Object

ユーザーの詳細。

名前	型	規定値	説明
id	string		リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		リソースの名前
properties.email	string		アドレス。
properties.firstName	string		名前。
properties.groups	GroupContractProperties[]		ユーザーが含まれるグループのコレクション。
properties.identities	UserIdentityContract[]		ユーザー ID のコレクション。
properties.lastName	string		名字。
properties.note	string		管理者によって設定されたユーザーに関する省略可能な注意事項。
properties.registrationDate	string (date-time)		ユーザー登録の日付。日付は、ISO 8601 標準で指定された `yyyy-MM-ddTHH:mm:ssZ` 形式に準拠しています。
properties.state	UserState	active	アカウントの状態。ユーザーがアクティブかどうかを指定します。ブロックされたユーザーは、開発者ポータルにサインインしたり、サブスクライブされた製品の API を呼び出したりできません。既定の状態はアクティブです。
type	string		リソースの種類。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

UserIdentityContract

Object

ユーザー ID の詳細。

名前	型	説明
id	string	プロバイダー内の識別子の値。
provider	string	ID プロバイダー名。

UserState

列挙

アカウントの状態。ユーザーがアクティブかどうかを指定します。ブロックされたユーザーは、開発者ポータルにサインインしたり、サブスクライブされた製品の API を呼び出したりできません。既定の状態はアクティブです。

値	説明
active	ユーザーの状態がアクティブです。
blocked	ユーザーがブロックされています。ブロックされたユーザーは、開発者ポータルで認証したり、API を呼び出したりできません。
deleted	ユーザーアカウントが閉じられました。すべての ID と関連エンティティが削除されます。
pending	ユーザーアカウントが保留中です。アクティブにする前に、ID の確認が必要です。

次の方法で共有

Group User - List

URI パラメーター

応答

セキュリティ

azure_auth

スコープ

例

ApiManagementListGroupUsers

要求のサンプル

応答のサンプル

定義

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GroupContractProperties

GroupType

UserCollection

UserContract

UserIdentityContract

UserState

その他のリソース