User - Get

Služba:

API Management

Verze rozhraní API:

2024-05-01

Získá podrobnosti uživatele určeného jeho identifikátorem.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Název skupiny prostředků. Název nerozlišuje malá a velká písmena.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Název služby API Management.
subscriptionId	path	True	string (uuid)	ID cílového předplatného. Hodnota musí být UUID.
userId	path	True	string minLength: 1 maxLength: 80	Identifikátor uživatele. V aktuální instanci služby API Management musí být jedinečné.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Odpovědi

Name	Typ	Description
200 OK	UserContract	Získá zadanou entitu uživatele. Hlavičky ETag: string
Other Status Codes	ErrorResponse	Chybová odpověď popisující, proč operace selhala.

Zabezpečení

azure_auth

Tok OAuth2 v Azure Active Directory

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

Name	Description
user_impersonation	zosobnění uživatelského účtu

Příklady

ApiManagementGetUser

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:

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

Definice

Name	Description
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Chybová odpověď
GroupContractProperties	Vlastnosti kontraktu skupiny
GroupType	Typ skupiny
UserContract	Podrobnosti o uživateli.
UserIdentityContract	Podrobnosti o identitě uživatele
UserState	Stav účtu Určuje, jestli je uživatel aktivní nebo ne. Blokovaní uživatelé se nemůžou přihlásit k portálu pro vývojáře nebo volat žádná rozhraní API předplacených produktů. Výchozí stav je Aktivní.

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Name	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Chybová odpověď

Name	Typ	Description
error	ErrorDetail	Objekt chyby.

GroupContractProperties

Objekt

Vlastnosti kontraktu skupiny

Name	Typ	Description
builtIn	boolean	true If the group is one of the three system groups (Administrators, Developers, or Guests); jinak nepravda.
description	string maxLength: 1000	Popis skupiny Může obsahovat značky formátování HTML.
displayName	string minLength: 1 maxLength: 300	Název skupiny
externalId	string	U externích skupin tato vlastnost obsahuje ID skupiny z externího zprostředkovatele identity, například pro službu Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; v opačném případě je hodnota null.
type	GroupType	Typ skupiny

GroupType

Výčet

Typ skupiny

Hodnota	Description
custom
external
system

UserContract

Objekt

Podrobnosti o uživateli.

Name	Typ	Default value	Description
id	string		Plně kvalifikované ID prostředku pro prostředek. Příklad : /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		Název prostředku
properties.email	string		E-mailová adresa
properties.firstName	string		Křestní jméno.
properties.groups	GroupContractProperties[]		Kolekce uživatelů skupin je součástí.
properties.identities	UserIdentityContract[]		Kolekce identit uživatelů
properties.lastName	string		Příjmení.
properties.note	string		Nepovinná poznámka o uživateli nastaveném správcem.
properties.registrationDate	string (date-time)		Datum registrace uživatele. Datum odpovídá následujícímu formátu: yyyy-MM-ddTHH:mm:ssZ podle normy ISO 8601.
properties.state	UserState	active	Stav účtu Určuje, jestli je uživatel aktivní nebo ne. Blokovaní uživatelé se nemůžou přihlásit k portálu pro vývojáře nebo volat žádná rozhraní API předplacených produktů. Výchozí stav je Aktivní.
type	string		Typ prostředku. Například Microsoft.Compute/virtualMachines nebo Microsoft.Storage/storageAccounts

UserIdentityContract

Objekt

Podrobnosti o identitě uživatele

Name	Typ	Description
id	string	Hodnota identifikátoru v rámci zprostředkovatele.
provider	string	Název zprostředkovatele identity.

UserState

Výčet

Stav účtu Určuje, jestli je uživatel aktivní nebo ne. Blokovaní uživatelé se nemůžou přihlásit k portálu pro vývojáře nebo volat žádná rozhraní API předplacených produktů. Výchozí stav je Aktivní.

Hodnota	Description
active	Stav uživatele je aktivní.
blocked	Uživatel je zablokovaný. Blokovaní uživatelé se nemůžou ověřovat na portálu pro vývojáře ani volat rozhraní API.
deleted	Uživatelský účet je zavřený. Odeberou se všechny identity a související entity.
pending	Uživatelský účet čeká na vyřízení. Vyžaduje potvrzení identity, než bude možné ji aktivovat.