User - List By Service

Listet eine Auflistung der in der angegebenen Dienstinstanz registrierten Benutzer auf

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users?api-version=2021-08-01
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=2021-08-01

URI-Parameter

Name In Required Type Description
resourceGroupName
path True
  • string

Der Name der Ressourcengruppe.

serviceName
path True
  • string

Der Name des API Management Diensts.

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

subscriptionId
path True
  • string

Abonnementanmeldeinformationen, die Microsoft Azure Abonnement eindeutig identifizieren. Die Abonnement-ID ist Teil des URI für jeden Dienstaufruf.

api-version
query True
  • string

Version der API, die mit der Clientanforderung verwendet werden soll.

$filter
query
  • string

| Feld | Verwendung | Unterstützte Operatoren | Unterstützte Funktionen |
|-------------|-------------|-------------|-------------|
| Name | filtern | ge, le, eq, ne, gt, lt | Teilzeichenfolge, enthält, beginnt mit |
| firstName | filtern | ge, le, eq, ne, gt, lt | Teilzeichenfolge, enthält, beginnt mit |
| nachname | filtern | ge, le, eq, ne, gt, lt | Teilzeichenfolge, enthält, beginnt mit |
| E-Mail-| filtern | ge, le, eq, ne, gt, lt | Teilzeichenfolge, enthält, beginnt mit |
| Zustand | filtern | eq | |
| registrationDate | filtern | ge, le, eq, ne, gt, lt | |
| Hinweis | filtern | ge, le, eq, ne, gt, lt | Teilzeichenfolge, enthält, beginnt mit |
| Gruppen | erweitern | | |

$skip
query
  • integer
int32

Die Anzahl der zu überspringenden Datensätze.

$top
query
  • integer
int32

Die Anzahl der zurückzugebenden Datensätze.

expandGroups
query
  • boolean

Detaillierte Gruppe als Antwort.

Antworten

Name Type Description
200 OK

Listet eine Sammlung von Benutzerentitäten auf.

Other Status Codes

Fehlerantwort mit Beschreibung des Grunds für den Fehler.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Flow.

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

Scopes

Name Description
user_impersonation Identitätswechsel Ihres Benutzerkontos

Beispiele

ApiManagementListUsers

Sample Request

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

Sample Response

{
  "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": ""
}

Definitionen

ErrorFieldContract

Fehlerfeldvertrag.

ErrorResponse

Fehlerantwort.

GroupContractProperties

Gruppenvertragseigenschaften.

GroupType

Gruppentyp.

UserCollection

Darstellung der Seitenbenutzerliste.

UserContract

Benutzerdetails.

UserIdentityContract

Details zur Benutzeridentität.

UserState

Kontostatus. Gibt an, ob der Benutzer aktiv ist. Gesperrte Benutzer können sich nicht im Entwicklerportal anmelden und keine APIs von abonnierten Produkten aufrufen. Der Standardzustand ist aktiv.

ErrorFieldContract

Fehlerfeldvertrag.

Name Type Description
code
  • string

Fehlercode auf Eigenschaftsebene.

message
  • string

Humanlesbare Darstellung des Fehlers auf Eigenschaftsebene.

target
  • string

Der Eigenschaftsname.

ErrorResponse

Fehlerantwort.

Name Type Description
error.code
  • string

Der vom Dienst definierte Fehlercode. Dieser Code dient als Unterstatus für den in der Antwort angegebenen HTTP-Fehlercode.

error.details

Die Liste der ungültigen Felder, die in Anforderung gesendet werden, im Falle eines Überprüfungsfehlers.

error.message
  • string

Lesbare Darstellung des Fehlers.

GroupContractProperties

Gruppenvertragseigenschaften.

Name Type Description
builtIn
  • boolean

true, wenn die Gruppe einer der drei Systemgruppen ist (Administratoren, Entwickler oder Gäste); andernfalls false.

description
  • string

Beschreibung der Gruppe. Darf HTML-Formatierungstags enthalten.

displayName
  • string

Gruppenname.

externalId
  • string

Bei externen Gruppen enthält diese Eigenschaft die ID der Gruppe vom externen Identitätsanbieter, z. B. für Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; andernfalls ist der Wert null.

type

Gruppentyp.

GroupType

Gruppentyp.

Name Type Description
custom
  • string
external
  • string
system
  • string

UserCollection

Darstellung der Seitenbenutzerliste.

Name Type Description
count
  • integer

Gesamtzahl der Datensatzanzahl über alle Seiten hinweg.

nextLink
  • string

Link "Nächste Seite" falls vorhanden.

value

Seitenwerte.

UserContract

Benutzerdetails.

Name Type Default Value Description
id
  • string

Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptionId}/resourceGroups/{resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

Der Name der Ressource

properties.email
  • string

E-Mail-Adresse.

properties.firstName
  • string

Vorname.

properties.groups

Die Sammlung von Gruppenbenutzern ist Teil von.

properties.identities

Sammlung von Benutzeridentitäten.

properties.lastName
  • string

Nachname.

properties.note
  • string

Optionale, vom Administrator eingegebene Notiz über einen Benutzer.

properties.registrationDate
  • string

Datum der Benutzerregistrierung. Das Datum entspricht dem folgenden Format: yyyy-MM-ddTHH:mm:ssZ wie durch den ISO 8601-Standard angegeben.

properties.state active

Kontostatus. Gibt an, ob der Benutzer aktiv ist. Gesperrte Benutzer können sich nicht im Entwicklerportal anmelden und keine APIs von abonnierten Produkten aufrufen. Der Standardzustand ist aktiv.

type
  • string

Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft. Storage/storageAccounts"

UserIdentityContract

Details zur Benutzeridentität.

Name Type Description
id
  • string

Bezeichnerwert innerhalb des Anbieters.

provider
  • string

Identitätsanbietername.

UserState

Kontostatus. Gibt an, ob der Benutzer aktiv ist. Gesperrte Benutzer können sich nicht im Entwicklerportal anmelden und keine APIs von abonnierten Produkten aufrufen. Der Standardzustand ist aktiv.

Name Type Description
active
  • string

Der Benutzerstatus ist aktiv.

blocked
  • string

Der Benutzer wird blockiert. Blockierte Benutzer können sich nicht beim Entwicklerportal oder bei der Aufruf-API authentifizieren.

deleted
  • string

Das Benutzerkonto wird geschlossen. Alle Identitäten und verwandte Entitäten werden entfernt.

pending
  • string

Das Benutzerkonto ist ausstehend. Erfordert eine Identitätsbestätigung, bevor sie aktiv gemacht werden kann.