User - Get

Odwołanie

Usługa:: API Management

Wersja interfejsu API:: 2024-05-01

Pobiera szczegóły użytkownika określonego przez jego identyfikator.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}?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	UserContract	Pobiera określoną jednostkę użytkownika. Nagłówki ETag: string
Other Status Codes	ErrorResponse	Odpowiedź na błąd opisująca, dlaczego operacja nie powiodła się.

Nazwa

Typ

Opis

200 OK

UserContract

Pobiera określoną jednostkę użytkownika.

Nagłówki

ETag: string

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

ApiManagementGetUser

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 200

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

Definicje

Nazwa	Opis
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
GroupContractProperties	Właściwości kontraktu grupy.
GroupType	Typ grupy.
UserContract	Szczegóły użytkownika.
UserIdentityContract	Szczegóły tożsamości użytkownika.
UserState	Stan konta. Określa, czy użytkownik jest aktywny, czy nie. Zablokowani użytkownicy nie mogą zalogować się do portalu deweloperów ani wywoływać żadnych interfejsów API subskrybowanych produktów. Stan domyślny to Aktywny.

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.

GroupContractProperties

Objekt

Właściwości kontraktu grupy.

Nazwa	Typ	Opis
builtIn	boolean	wartość true, jeśli grupa jest jedną z trzech grup systemowych (Administratorzy, Deweloperzy lub Goście); w przeciwnym razie wartość false.
description	string maxLength: 1000	Opis grupy. Może zawierać tagi formatowania HTML.
displayName	string minLength: 1 maxLength: 300	Nazwa grupy.
externalId	string	W przypadku grup zewnętrznych ta właściwość zawiera identyfikator grupy od zewnętrznego dostawcy tożsamości, np. dla usługi Azure Active Directory `aad://<tenant>.onmicrosoft.com/groups/<group object id>`; w przeciwnym razie wartość ma wartość null.
type	GroupType	Typ grupy.

GroupType

Wyliczanie

Typ grupy.

Wartość	Opis
custom
external
system

UserContract

Objekt

Szczegóły użytkownika.

Nazwa	Typ	Domyślna wartość	Opis
id	string		W pełni kwalifikowany identyfikator zasobu dla zasobu. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		Nazwa zasobu
properties.email	string		Adres e-mail.
properties.firstName	string		Imię.
properties.groups	GroupContractProperties[]		Kolekcja użytkowników grup jest częścią.
properties.identities	UserIdentityContract[]		Kolekcja tożsamości użytkowników.
properties.lastName	string		Nazwisko.
properties.note	string		Opcjonalna uwaga dotycząca użytkownika ustawionego przez administratora.
properties.registrationDate	string (date-time)		Data rejestracji użytkownika. Data jest zgodna z następującym formatem: `yyyy-MM-ddTHH:mm:ssZ` określony przez standard ISO 8601.
properties.state	UserState	active	Stan konta. Określa, czy użytkownik jest aktywny, czy nie. Zablokowani użytkownicy nie mogą zalogować się do portalu deweloperów ani wywoływać żadnych interfejsów API subskrybowanych produktów. Stan domyślny to Aktywny.
type	string		Typ zasobu. Np. "Microsoft.Compute/virtualMachines" lub "Microsoft.Storage/storageAccounts"

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.

UserState

Wyliczanie

Stan konta. Określa, czy użytkownik jest aktywny, czy nie. Zablokowani użytkownicy nie mogą zalogować się do portalu deweloperów ani wywoływać żadnych interfejsów API subskrybowanych produktów. Stan domyślny to Aktywny.

Wartość	Opis
active	Stan użytkownika jest aktywny.
blocked	Użytkownik jest zablokowany. Zablokowani użytkownicy nie mogą uwierzytelniać się w portalu deweloperów ani wywoływać interfejsu API.
deleted	Konto użytkownika jest zamknięte. Wszystkie tożsamości i powiązane jednostki są usuwane.
pending	Konto użytkownika oczekuje. Wymaga potwierdzenia tożsamości, zanim będzie można go uaktywnić.

Udostępnij za pośrednictwem

User - Get

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

ApiManagementGetUser

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GroupContractProperties

GroupType

UserContract

UserIdentityContract

UserState

Dodatkowe zasoby