User Identities - List

Usługa:

API Management

Wersja interfejsu API:

2024-05-01

Lista wszystkich tożsamości użytkowników.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nazwa usługi API Management.
subscriptionId	path	True	string (uuid)	Identyfikator subskrypcji docelowej. Wartość musi być identyfikatorem UUID.
userId	path	True	string minLength: 1 maxLength: 80	Identyfikator użytkownika. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	UserIdentityCollection	Listy tożsamości użytkowników.
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory.

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

ApiManagementListUserIdentities

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:

200

{
  "value": [
    {
      "provider": "Microsoft",
      "id": "086cf9********55ab"
    }
  ],
  "nextLink": ""
}

Definicje

Nazwa	Opis
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
UserIdentityCollection	Lista reprezentacji listy tożsamości użytkowników.
UserIdentityContract	Szczegóły tożsamości użytkownika.

ErrorAdditionalInfo

Objekt

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Objekt

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

UserIdentityCollection

Objekt

Lista reprezentacji listy tożsamości użytkowników.

Nazwa	Typ	Opis
count	integer (int64)	Łączna liczba rekordów na wszystkich stronach.
nextLink	string	Jeśli istnieje, link następnej strony.
value	UserIdentityContract[]	Wartości tożsamości użytkownika.

UserIdentityContract

Objekt

Szczegóły tożsamości użytkownika.

Nazwa	Typ	Opis
id	string	Wartość identyfikatora w ramach dostawcy.
provider	string	Nazwa dostawcy tożsamości.