Share via

User - List By Service

  • リファレンス
Service:
API Management
API Version:
2022-08-01

指定されたサービス インスタンスにおける登録ユーザーのコレクションを一覧表示します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users?api-version=2022-08-01
With optional parameters: 
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users?$filter={$filter}&$top={$top}&$skip={$skip}&expandGroups={expandGroups}&api-version=2022-08-01

URI パラメーター

名前 / 必須 型 説明
resourceGroupName
 path True

string

リソース グループの名前。 名前の大文字と小文字は区別されます。
serviceName
 path True

string

API Management サービスの名前。

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$
subscriptionId
 path True

string

ターゲット サブスクリプションの ID。
api-version
 query True

string

この操作に使用する 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 |
|email |filter |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswith |
|state |filter |eq | |
|registrationDate |filter |ge、le、eq、ne、gt、lt | |
|note |filter |ge、le、eq、ne、gt、lt |substringof、contains、startswith、endswith |
|groups |expand | | |
$skip
 query

integer

int32

スキップするレコードの数。
$top
 query

integer

int32

返されるレコードの数。
expandGroups
 query

boolean

応答の詳細なグループ。

応答

名前 型 説明
200 OK

UserCollection

User エンティティのコレクションを一覧表示します。
Other Status Codes

ErrorResponse

操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

名前 説明
user_impersonation ユーザー アカウントの借用

例

ApiManagementListUsers

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users?api-version=2022-08-01

Sample Response

Status code:
200 
{
  "value": [
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/1",
      "type": "Microsoft.ApiManagement/service/users",
      "name": "1",
      "properties": {
        "firstName": "Administrator",
        "lastName": "",
        "email": "admin@live.com",
        "state": "active",
        "registrationDate": "2015-09-22T01:57:39.677Z",
        "identities": [
          {
            "provider": "Azure",
            "id": "admin@live.com"
          }
        ]
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/56eaec62baf08b06e46d27fd",
      "type": "Microsoft.ApiManagement/service/users",
      "name": "56eaec62baf08b06e46d27fd",
      "properties": {
        "firstName": "foo",
        "lastName": "bar",
        "email": "foo.bar.83@gmail.com",
        "state": "active",
        "registrationDate": "2016-03-17T17:41:56.327Z",
        "identities": [
          {
            "provider": "Basic",
            "id": "foo.bar.83@gmail.com"
          }
        ]
      }
    },
    {
      "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512a88c680b",
      "type": "Microsoft.ApiManagement/service/users",
      "name": "5931a75ae4bbd512a88c680b",
      "properties": {
        "firstName": "foo",
        "lastName": "bar",
        "email": "foobar@outlook.com",
        "state": "active",
        "registrationDate": "2017-06-02T17:58:50.357Z",
        "identities": [
          {
            "provider": "Microsoft",
            "id": "*************"
          }
        ]
      }
    }
  ],
  "count": 3,
  "nextLink": ""
}

定義

名前 説明
ErrorFieldContract

エラー フィールド コントラクト。
ErrorResponse

エラー応答。
GroupContractProperties

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

[グループの種類]。
UserCollection

Paged Users リスト表現。
UserContract

ユーザーの詳細。
UserIdentityContract

ユーザー ID の詳細。
UserState

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

ErrorFieldContract

エラー フィールド コントラクト。

名前 型 説明
code

string

プロパティ レベルのエラー コード。
message

string

プロパティ レベルエラーの人間が判読できる表現。
target

string

プロパティ名。

ErrorResponse

エラー応答。

名前 型 説明
error.code

string

サービスによって定義されたエラー コード。 このコードは、応答に指定された HTTP エラー コードのサブステータスとして機能します。
error.details

ErrorFieldContract[]

検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。
error.message

string

人が判読できるエラーの表現。

GroupContractProperties

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

名前 型 説明
builtIn

boolean

グループが 3 つのシステム グループ (管理者、開発者、またはゲスト) のいずれかである場合は true。それ以外の場合は false。
description

string

グループの説明。 HTML 書式設定タグを含めることができます。
displayName

string

[グループ名]:

externalId

string

外部グループの場合、このプロパティには外部 ID プロバイダーのグループの ID (Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>の場合など) が含まれます。それ以外の場合、値は null です。
type

GroupType

[グループの種類]。

GroupType

[グループの種類]。

名前 型 説明
custom

string

external

string

system

string

UserCollection

Paged Users リスト表現。

名前 型 説明
count

integer

すべてのページの合計レコード数。
nextLink

string

次のページ リンク (存在する場合)。
value

UserContract[]

ページ値。

UserContract

ユーザーの詳細。

名前 型 既定値 説明
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

ユーザー登録の日付。 日付は、ISO 8601 標準で指定されている形式 yyyy-MM-ddTHH:mm:ssZ に準拠しています。
properties.state

UserState

active

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

string

リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

UserIdentityContract

ユーザー ID の詳細。

名前 型 説明
id

string

プロバイダー内の識別子の値。
provider

string

ID プロバイダー名。

UserState

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

名前 型 説明
active

string

ユーザーの状態がアクティブです。
blocked

string

ユーザーがブロックされています。 ブロックされたユーザーは、開発者ポータルで認証したり、API を呼び出したりすることはできません。
deleted

string

ユーザー アカウントが閉じられました。 すべての ID と関連エンティティが削除されます。
pending

string

ユーザー アカウントが保留中です。 アクティブにする前に ID の確認が必要です。