User - Create Or Update
Membuat atau Memperbarui pengguna.
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}?api-version=2022-08-01
PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{userId}?notify={notify}&api-version=2022-08-01
Parameter URI
Nama | Dalam | Diperlukan | Jenis | Deskripsi |
---|---|---|---|---|
resource
|
path | True |
string |
Nama grup sumber daya. Nama tidak peka huruf besar/kecil. |
service
|
path | True |
string |
Nama layanan API Management. Regex pattern: |
subscription
|
path | True |
string |
ID langganan target. |
user
|
path | True |
string |
Pengidentifikasi pengguna. Harus unik dalam instans layanan API Management saat ini. |
api-version
|
query | True |
string |
Versi API yang digunakan untuk operasi ini. |
notify
|
query |
boolean |
Kirim pemberitahuan Email ke Pengguna. |
Header Permintaan
Nama | Diperlukan | Jenis | Deskripsi |
---|---|---|---|
If-Match |
string |
ETag Entitas. Tidak diperlukan saat membuat entitas, tetapi diperlukan saat memperbarui entitas. |
Isi Permintaan
Nama | Diperlukan | Jenis | Deskripsi |
---|---|---|---|
properties.email | True |
string |
Alamat Email. Tidak boleh kosong dan harus unik dalam instans layanan. |
properties.firstName | True |
string |
Nama depan. |
properties.lastName | True |
string |
Nama belakang. |
properties.appType |
Menentukan jenis aplikasi yang mengirim permintaan buat pengguna. Defaultnya adalah portal warisan. |
||
properties.confirmation |
Menentukan jenis email konfirmasi yang akan dikirim ke pengguna yang baru dibuat. |
||
properties.identities |
Kumpulan identitas pengguna. |
||
properties.note |
string |
Catatan opsional tentang pengguna yang ditetapkan oleh administrator. |
|
properties.password |
string |
Kata Sandi Pengguna. Jika tidak ada nilai yang disediakan, kata sandi default akan dibuat. |
|
properties.state |
Status akun. Menentukan apakah pengguna aktif atau tidak. Pengguna yang diblokir tidak dapat masuk ke portal pengembang atau memanggil API apa pun dari produk langganan. Status default adalah Aktif. |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
200 OK |
Pengguna berhasil diperbarui. Headers ETag: string |
|
201 Created |
Pengguna berhasil dibuat. Headers ETag: string |
|
Other Status Codes |
Respons kesalahan yang menjelaskan mengapa operasi gagal. |
Keamanan
azure_auth
Alur OAuth2 Azure Active Directory.
Type:
oauth2
Flow:
implicit
Authorization URL:
https://login.microsoftonline.com/common/oauth2/authorize
Scopes
Nama | Deskripsi |
---|---|
user_impersonation | meniru akun pengguna Anda |
Contoh
ApiManagementCreateUser
Sample Request
PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512288c680b?api-version=2022-08-01
{
"properties": {
"firstName": "foo",
"lastName": "bar",
"email": "foobar@outlook.com",
"confirmation": "signup"
}
}
Sample Response
{
"id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512288c680b",
"type": "Microsoft.ApiManagement/service/users",
"name": "5931a75ae4bbd512288c680b",
"properties": {
"firstName": "foo",
"lastName": "bar",
"email": "foobar@outlook.com",
"state": "active",
"registrationDate": "2018-01-07T21:21:29.16Z",
"groups": [],
"identities": [
{
"provider": "Basic",
"id": "foobar@outlook.com"
}
]
}
}
{
"id": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/users/5931a75ae4bbd512288c680b",
"type": "Microsoft.ApiManagement/service/users",
"name": "5931a75ae4bbd512288c680b",
"properties": {
"firstName": "foo",
"lastName": "bar",
"email": "foobar@outlook.com",
"state": "active",
"registrationDate": "2018-01-07T21:21:29.16Z",
"groups": [],
"identities": [
{
"provider": "Basic",
"id": "foobar@outlook.com"
}
]
}
}
Definisi
Nama | Deskripsi |
---|---|
App |
Menentukan jenis aplikasi yang mengirim permintaan buat pengguna. Defaultnya adalah portal warisan. |
Confirmation |
Menentukan jenis email konfirmasi yang akan dikirim ke pengguna yang baru dibuat. |
Error |
Kontrak Bidang Kesalahan. |
Error |
Respons Kesalahan. |
Group |
Properti kontrak grup. |
Group |
Jenis grup. |
User |
Detail pengguna. |
User |
Detail pembuatan pengguna. |
User |
Detail identitas pengguna. |
User |
Status akun. Menentukan apakah pengguna aktif atau tidak. Pengguna yang diblokir tidak dapat masuk ke portal pengembang atau memanggil API apa pun dari produk langganan. Status default adalah Aktif. |
AppType
Menentukan jenis aplikasi yang mengirim permintaan buat pengguna. Defaultnya adalah portal warisan.
Nama | Jenis | Deskripsi |
---|---|---|
developerPortal |
string |
Permintaan pembuatan pengguna dikirim oleh portal pengembang baru. |
portal |
string |
Permintaan pembuatan pengguna dikirim oleh portal pengembang warisan. |
Confirmation
Menentukan jenis email konfirmasi yang akan dikirim ke pengguna yang baru dibuat.
Nama | Jenis | Deskripsi |
---|---|---|
invite |
string |
Kirim email yang mengundang pengguna untuk mendaftar dan menyelesaikan pendaftaran. |
signup |
string |
Kirim email ke pengguna yang mengonfirmasi bahwa mereka telah berhasil mendaftar. |
ErrorFieldContract
Kontrak Bidang Kesalahan.
Nama | Jenis | Deskripsi |
---|---|---|
code |
string |
Kode kesalahan tingkat properti. |
message |
string |
Representasi kesalahan tingkat properti yang dapat dibaca manusia. |
target |
string |
Nama properti. |
ErrorResponse
Respons Kesalahan.
Nama | Jenis | Deskripsi |
---|---|---|
error.code |
string |
Kode kesalahan yang ditentukan layanan. Kode ini berfungsi sebagai sub-status untuk kode kesalahan HTTP yang ditentukan dalam respons. |
error.details |
Daftar bidang yang tidak valid dikirim dalam permintaan, jika terjadi kesalahan validasi. |
|
error.message |
string |
Representasi kesalahan yang dapat dibaca manusia. |
GroupContractProperties
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 |
Deskripsi grup. Dapat berisi tag pemformatan HTML. |
displayName |
string |
Nama Grup. |
externalId |
string |
Untuk grup eksternal, properti ini berisi id grup dari penyedia identitas eksternal, misalnya untuk Azure Active Directory |
type |
Jenis grup. |
GroupType
Jenis grup.
Nama | Jenis | Deskripsi |
---|---|---|
custom |
string |
|
external |
string |
|
system |
string |
UserContract
Detail pengguna.
Nama | Jenis | Nilai Default | Deskripsi |
---|---|---|---|
id |
string |
ID sumber daya yang sepenuhnya memenuhi syarat untuk sumber daya. Ex - /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 |
Kumpulan pengguna grup adalah bagian dari. |
||
properties.identities |
Kumpulan identitas pengguna. |
||
properties.lastName |
string |
Nama belakang. |
|
properties.note |
string |
Catatan opsional tentang pengguna yang ditetapkan oleh administrator. |
|
properties.registrationDate |
string |
Tanggal pendaftaran pengguna. Tanggal sesuai dengan format berikut: |
|
properties.state | active |
Status akun. Menentukan apakah pengguna aktif atau tidak. Pengguna yang diblokir tidak dapat masuk ke portal pengembang atau memanggil API apa pun dari produk langganan. Status default adalah Aktif. |
|
type |
string |
Jenis sumber daya. Misalnya, "Microsoft.Compute/virtualMachines" atau "Microsoft.Storage/storageAccounts" |
UserCreateParameters
Detail pembuatan pengguna.
Nama | Jenis | Nilai Default | Deskripsi |
---|---|---|---|
properties.appType |
Menentukan jenis aplikasi yang mengirim permintaan buat pengguna. Defaultnya adalah portal warisan. |
||
properties.confirmation |
Menentukan jenis email konfirmasi yang akan dikirim ke pengguna yang baru dibuat. |
||
properties.email |
string |
Alamat Email. Tidak boleh kosong dan harus unik dalam instans layanan. |
|
properties.firstName |
string |
Nama depan. |
|
properties.identities |
Kumpulan identitas pengguna. |
||
properties.lastName |
string |
Nama belakang. |
|
properties.note |
string |
Catatan opsional tentang pengguna yang ditetapkan oleh administrator. |
|
properties.password |
string |
Kata Sandi Pengguna. Jika tidak ada nilai yang disediakan, kata sandi default akan dibuat. |
|
properties.state | active |
Status akun. Menentukan apakah pengguna aktif atau tidak. Pengguna yang diblokir tidak dapat masuk ke portal pengembang atau memanggil API apa pun dari produk langganan. Status default adalah Aktif. |
UserIdentityContract
Detail identitas pengguna.
Nama | Jenis | Deskripsi |
---|---|---|
id |
string |
Nilai pengidentifikasi dalam penyedia. |
provider |
string |
Nama Penyedia Identitas. |
UserState
Status akun. Menentukan apakah pengguna aktif atau tidak. Pengguna yang diblokir tidak dapat masuk ke portal pengembang atau memanggil API apa pun dari produk langganan. Status default adalah Aktif.
Nama | Jenis | Deskripsi |
---|---|---|
active |
string |
Status pengguna aktif. |
blocked |
string |
Pengguna diblokir. Pengguna yang diblokir tidak dapat mengautentikasi di portal pengembang atau memanggil API. |
deleted |
string |
Akun pengguna ditutup. Semua identitas dan entitas terkait dihapus. |
pending |
string |
Akun pengguna tertunda. Memerlukan konfirmasi identitas sebelum dapat dibuat aktif. |