User - Get

Layanan:

API Management

Versi API:

2024-05-01

Mendapatkan detail pengguna yang ditentukan oleh pengidentifikasinya.

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

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Nama grup sumber daya. Nama ini tidak peka huruf besar/kecil.
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	Nama layanan API Management.
subscriptionId	path	True	string (uuid)	ID langganan target. Nilainya harus UUID.
userId	path	True	string minLength: 1 maxLength: 80	Pengidentifikasi pengguna. Harus unik dalam instans layanan API Management saat ini.
api-version	query	True	string minLength: 1	Versi API yang akan digunakan untuk operasi ini.

Respons

Nama	Jenis	Deskripsi
200 OK	UserContract	Mendapatkan entitas pengguna yang ditentukan. Header ETag: string
Other Status Codes	ErrorResponse	Respons kesalahan yang menjelaskan mengapa operasi gagal.

Keamanan

azure_auth

Alur OAuth2 Azure Active Directory.

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/authorize

Cakupan

Nama	Deskripsi
user_impersonation	meniru akun pengguna Anda

Contoh

ApiManagementGetUser

Permintaan sampel

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

Respon sampel

Kode status:

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

Definisi

Nama	Deskripsi
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Respons kesalahan
GroupContractProperties	Properti kontrak grup.
GroupType	Jenis grup.
UserContract	Detail pengguna.
UserIdentityContract	Detail identitas pengguna.
UserState	Status akun. Menentukan apakah pengguna aktif atau tidak. Pengguna yang diblokir tidak dapat masuk ke portal pengembang atau memanggil API produk berlangganan apa pun. Status default adalah Aktif.

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek

Respons kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.

GroupContractProperties

Objek

Properti kontrak grup.

Nama	Jenis	Deskripsi
builtIn	boolean	true jika grup adalah salah satu dari tiga grup sistem (Administrator, Pengembang, atau Tamu); jika tidak salah.
description	string maxLength: 1000	Deskripsi grup. Dapat berisi tag pemformatan HTML.
displayName	string minLength: 1 maxLength: 300	Nama grup.
externalId	string	Untuk grup eksternal, properti ini berisi id grup dari penyedia identitas eksternal, misalnya untuk Azure Active Directory aad://<tenant>.onmicrosoft.com/groups/<group object id>; jika tidak, nilainya null.
type	GroupType	Jenis grup.

GroupType

Enumeration

Jenis grup.

Nilai	Deskripsi
custom
system
external

UserContract

Objek

Detail pengguna.

Nama	Jenis	Nilai default	Deskripsi
id	string		ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Misalnya - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string		Nama sumber daya
properties.email	string		Alamat email.
properties.firstName	string		Nama depan.
properties.groups	GroupContractProperties[]		Kumpulan pengguna grup adalah bagian dari.
properties.identities	UserIdentityContract[]		Kumpulan identitas pengguna.
properties.lastName	string		Nama belakang.
properties.note	string		Catatan opsional tentang pengguna yang ditetapkan oleh administrator.
properties.registrationDate	string (date-time)		Tanggal pendaftaran pengguna. Tanggal sesuai dengan format berikut: yyyy-MM-ddTHH:mm:ssZ seperti yang ditentukan oleh standar ISO 8601.
properties.state	UserState	active	Status akun. Menentukan apakah pengguna aktif atau tidak. Pengguna yang diblokir tidak dapat masuk ke portal pengembang atau memanggil API produk berlangganan apa pun. Status default adalah Aktif.
type	string		Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts"

UserIdentityContract

Objek

Detail identitas pengguna.

Nama	Jenis	Deskripsi
id	string	Nilai pengidentifikasi dalam penyedia.
provider	string	Nama penyedia identitas.

UserState

Enumeration

Status akun. Menentukan apakah pengguna aktif atau tidak. Pengguna yang diblokir tidak dapat masuk ke portal pengembang atau memanggil API produk berlangganan apa pun. Status default adalah Aktif.

Nilai	Deskripsi
active	Status pengguna aktif.
blocked	Pengguna diblokir. Pengguna yang diblokir tidak dapat mengautentikasi di portal pengembang atau memanggil API.
pending	Akun pengguna tertunda. Memerlukan konfirmasi identitas sebelum dapat dibuat aktif.
deleted	Akun pengguna ditutup. Semua identitas dan entitas terkait dihapus.