User - List By Service

Referenz

Dienst:: API Management

API-Version:: 2024-05-01

Listet eine Auflistung registrierter Benutzer in der angegebenen Dienstinstanz auf.

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

Mit optionalen Parametern:

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=2024-05-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Der Name des API-Verwaltungsdiensts.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.
$filter	query		string	\| Feld \| Nutzung \| Unterstützte Operatoren \| Unterstützte Funktionen \| \|-------------\|-------------\|-------------\|-------------\| \| Name \| filter \| ge, le, eq, ne, gt, lt \| teilstringof, contains, startswith, endswith \| \| firstName \| filter \| ge, le, eq, ne, gt, lt \| teilstringof, contains, startswith, endswith \| \| Nachname \| filter \| ge, le, eq, ne, gt, lt \| teilstringof, contains, startswith, endswith \| \| E-Mail \| filter \| ge, le, eq, ne, gt, lt \| teilstringof, contains, startswith, endswith \| \| Zustand \| filter \| eq \| \| \| registrationDate \| filter \| ge, le, eq, ne, gt, lt \| \| \| Hinweis \| filter \| ge, le, eq, ne, gt, lt \| teilstringof, contains, startswith, endswith \| \| Gruppen \| expand \| \| \|
$skip	query		integer (int32) minimum: 0	Anzahl der zu überspringenden Datensätze.
$top	query		integer (int32) minimum: 1	Anzahl der zurückzugebenden Datensätze.
expandGroups	query		boolean	Detaillierte Gruppe als Antwort.

Antworten

Name	Typ	Beschreibung
200 OK	UserCollection	Listet eine Auflistung von Benutzerentitäten auf.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Sicherheit

azure_auth

Azure Active Directory OAuth2-Fluss.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

ApiManagementListUsers

Beispielanforderung

HTTP

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

Beispiel für eine Antwort

Statuscode:: 200

{
  "value": [
    {
      "id": "/subscriptions/00000000-0000-0000-0000-000000000000/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/00000000-0000-0000-0000-000000000000/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/00000000-0000-0000-0000-000000000000/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

Name	Beschreibung
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
GroupContractProperties	Gruppenvertragseigenschaften.
GroupType	Gruppentyp.
UserCollection	Darstellung der Seitenbenutzerliste.
UserContract	Benutzerdetails.
UserIdentityContract	Benutzeridentitätsdetails.
UserState	Kontostatus. Gibt an, ob der Benutzer aktiv ist oder nicht. Blockierte Benutzer können sich nicht beim Entwicklerportal anmelden oder APIs von abonnierten Produkten aufrufen. Der Standardstatus ist "Aktiv".

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

GroupContractProperties

Objekt

Gruppenvertragseigenschaften.

Name	Typ	Beschreibung
builtIn	boolean	true, wenn die Gruppe eine der drei Systemgruppen ist (Administratoren, Entwickler oder Gäste); andernfalls "false".
description	string maxLength: 1000	Gruppenbeschreibung. Kann HTML-Formatierungstags enthalten.
displayName	string minLength: 1 maxLength: 300	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	GroupType	Gruppentyp.

GroupType

Enumeration

Gruppentyp.

Wert	Beschreibung
custom
external
system

UserCollection

Objekt

Darstellung der Seitenbenutzerliste.

Name	Typ	Beschreibung
count	integer (int64)	Gesamtzahl der Datensätze auf allen Seiten.
nextLink	string	Link zur nächsten Seite, falls vorhanden.
value	UserContract[]	Seitenwerte.

UserContract

Objekt

Benutzerdetails.

Name	Typ	Standardwert	Beschreibung
id	string		Vollqualifizierte Ressourcen-ID für die Ressource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		Der Name der Ressource
properties.email	string		E-Mail-Adresse.
properties.firstName	string		Vorname.
properties.groups	GroupContractProperties[]		Die Sammlung von Gruppenbenutzern ist Teil des Benutzers.
properties.identities	UserIdentityContract[]		Sammlung von Benutzeridentitäten.
properties.lastName	string		Nachname.
properties.note	string		Optionaler Hinweis zu einem vom Administrator festgelegten Benutzer.
properties.registrationDate	string (date-time)		Datum der Benutzerregistrierung. Das Datum entspricht dem folgenden Format: `yyyy-MM-ddTHH:mm:ssZ` gemäß der ISO 8601-Norm.
properties.state	UserState	active	Kontostatus. Gibt an, ob der Benutzer aktiv ist oder nicht. Blockierte Benutzer können sich nicht beim Entwicklerportal anmelden oder APIs von abonnierten Produkten aufrufen. Der Standardstatus ist "Aktiv".
type	string		Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

UserIdentityContract

Objekt

Benutzeridentitätsdetails.

Name	Typ	Beschreibung
id	string	Bezeichnerwert innerhalb des Anbieters.
provider	string	Identitätsanbietername.

UserState

Enumeration

Kontostatus. Gibt an, ob der Benutzer aktiv ist oder nicht. Blockierte Benutzer können sich nicht beim Entwicklerportal anmelden oder APIs von abonnierten Produkten aufrufen. Der Standardstatus ist "Aktiv".

Wert	Beschreibung
active	Der Benutzerstatus ist aktiv.
blocked	Der Benutzer wird blockiert. Blockierte Benutzer können sich nicht im Entwicklerportal oder in der Anruf-API authentifizieren.
deleted	Das Benutzerkonto wird geschlossen. Alle Identitäten und zugehörigen Entitäten werden entfernt.
pending	Das Benutzerkonto steht aus. Erfordert eine Identitätsbestätigung, bevor sie aktiv werden kann.

Freigeben über

User - List By Service

URI-Parameter

Antworten

Sicherheit

azure_auth

Bereiche

Beispiele

ApiManagementListUsers

Beispielanforderung

Beispiel für eine Antwort

Definitionen

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GroupContractProperties

GroupType

UserCollection

UserContract

UserIdentityContract

UserState

Zusätzliche Ressourcen