Pengguna Patch #

Memperbarui serangkaian properti tertentu dari Pengguna. Ini menggunakan JSON Format tambalan untuk setiap perubahan.

PATCH /v1.0/pelanggan/{CUSTOMER_TENANT_ID}/pengguna/{USER_ID}

warning
Saat menambal peran terhadap pengguna, berhati-hatilah jika menggunakan operasi SUBSTITUSI.
Dengan operasi penggantian, peran pengguna saat ini akan diganti dengan nilai yang disediakan dalam permintaan tambalan.
Peran apa pun yang tidak disediakan dalam permintaan patch akan dihapus dari pengguna (dengan pengecualian PBX peran pengguna yang disinkronkan dari PBX).

Contoh 1 #

Permintaan ini akan memperbarui Nama Tampilan Pengguna.

Minta #

PATCH <https://api.na.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}> HTTP/1.1
Jenis Konten: aplikasi/json
Menerima biaya: benar
Otorisasi: Pembawa {TOKEN}
Koneksi: tetap hidup
[ {
	"op": "mengganti",
	"jalur": "/displayName",
	"value": "Nama Baru Saya"
}][{
	"op": "replace",
	"path": "/displayName",
	"value": "My New Name"
}]

Jawaban #

HTTP/1.1 200 OK
Jenis Konten: aplikasi/json; Charset = UTF-8
Durasi Konten: xx
Konteks Permintaan: appId=cid-v1:d24f4c80-0a0a-432e-85aa-a6f91f13a038
{
	"status": "sukses",
	"stempel waktu": "2019-11-29T15:16:54.2586208Z"
}

Contoh 2 #

Permintaan ini akan MENAMBAHKAN peran customer.user.supervisorl1 ke Pengguna, menjaga peran yang ada tetap utuh.

Minta #

PATCH <https://api.na.myreports.cloud/api/v1.0/customers/{TENANT_ID}/users/{USER_ID}> HTTP/1.1
Jenis Konten: aplikasi/json
Menerima biaya: benar
Otorisasi: Pembawa {TOKEN}
Koneksi: tetap hidup
[ {
	"op": "tambahkan",
	"jalur": "/peran/-",
	"value": "customer.user.supervisorl1"
}][{
	"op": "add",
	"path": "/roles/-",
	"value": "customer.user.supervisorl1"
}]

Jawaban #

HTTP/1.1 200 OK
Jenis Konten: aplikasi/json; Charset = UTF-8
Durasi Konten: xx
Konteks Permintaan: appId=cid-v1:d24f4c80-0a0a-432e-85aa-a6f91f13a038
{
	"status": "sukses",
	"stempel waktu": "2019-11-29T15:16:54.2586208Z"
}

Contoh 3 #

Permintaan ini akan menggantikan SEMUA peran yang diberikan kepada Pengguna dengan dua yang disediakan.

Minta #

PATCH <https://api.na.myreports.cloud/api/v1.0/customers/{TENANT_ID}/users/{USER_ID}> HTTP/1.1
Jenis Konten: aplikasi/json
Menerima biaya: benar
Otorisasi: Pembawa {TOKEN}
Koneksi: tetap hidup
\[{
	"op": "mengganti",
	"jalur": "/peran",
	"nilai": [" pengguna.admin", "pelanggan.pengguna"]["user.admin", "customer.user"]
}]

Jawaban #

HTTP/1.1 200 OK
Jenis Konten: aplikasi/json; Charset = UTF-8
Durasi Konten: xx
Konteks Permintaan: appId=cid-v1:d24f4c80-0a0a-432e-85aa-a6f91f13a038
{
	"status": "sukses",
	"stempel waktu": "2019-11-29T15:16:54.2586208Z"
}

Kesalahan #

Sah #

Ketika token tidak disediakan, tidak valid atau kedaluwarsa

HTTP/1.1 401 Tidak sah

Permintaan Buruk (1) #

Ketika penyewa atau id pengguna yang diberikan tidak dalam format yang benar

HTTP/1.1 400 Permintaan Buruk
Tanggal: Thu, 06 Feb 2020 12:45:27 GMT
Jenis Konten: aplikasi/json; Charset = UTF-8
Panjang Konten: 149
{
	"kesalahan": 400,
	"message": "Nilai '\< ID penyewa/pengguna>' tidak valid.",
	"status": "kesalahan",
	"stempel waktu": "2020-02-06T12:45:27.5903465Z"
}

Permintaan Buruk (2) #

Ketika Pengguna terakhir dengan peran "user.admin" dan "customer.user" di Pelanggan ini mencoba menghapus peran ini.

warning
Selalu harus ada Pengguna di penyewa Pelanggan dengan peran "user.admin" dan "customer.user".

HTTP/1.1 400 Permintaan Buruk
Tanggal: Thu, 06 Feb 2020 13:12:06 GMT
Jenis Konten: aplikasi/json; Charset = UTF-8
Panjang-Konten: 132
{
	"kesalahan": 400,
	"message": "Harus ada setidaknya satu administrator pengguna.",
	"status": "kesalahan",
	"stempel waktu": "2020-02-06T13:12:06.9741515Z"
}

Permintaan Buruk (3) #

Saat mencoba menambal properti yang tidak valid.

HTTP/1.1 400 Permintaan Buruk
Tanggal: Thu, 06 Feb 2020 12:45:27 GMT
Jenis Konten: aplikasi/json; Charset = UTF-8
Panjang Konten: 149
{
	"kesalahan": 400,
	"message": "Lokasi target yang ditentukan oleh segmen jalur '<invalid property>' tidak ditemukan.",
	"status": "kesalahan",
	"stempel waktu": "2020-02-06T12:45:27.5903465Z"
}

Perselisihan #

Jika alamat email untuk pengguna baru ini sudah keluar untuk pengguna lain di penyewa Pelanggan ini

HTTP/1.1 409 Konflik
Tanggal: Thu, 06 Feb 2020 13:05:39 GMT
Jenis Konten: aplikasi/json; Charset = UTF-8
Panjang-Konten: 178
{
	"kesalahan": 409,
	"errorCode": "EmailConflict",
	"message": "Pengguna dengan alamat email [[email protected]](mailto:[email protected]) sudah ada.",
	"status": "kesalahan",
	"stempel waktu": "2020-02-06T13:05:39.5486342Z"
}

Tidak Ditemukan #

Ketika tidak ada Pelanggan yang memiliki id penyewa yang cocok, atau Pengguna dalam penyewa ini yang memiliki id pengguna yang cocok

HTTP/1.1 404 Tidak Ditemukan
Tanggal: Thu, 06 Feb 2020 12:46:58 GMT
Jenis Konten: aplikasi/json; Charset = UTF-8
Panjang Konten: 95
{
	"kesalahan": 404,
	"message": "Tidak Ditemukan",
	"status": "kesalahan",
	"stempel waktu": "2020-02-06T12:46:58.7669535Z"
}

Pembayaran Diperlukan #

Jika permintaan ini mungkin dikenakan biaya tambahan, lihat Biaya.

HTTP/1.1 402 Pembayaran Diperlukan
Tanggal: Thu, 06 Feb 2020 13:01:00 GMT
Jenis Konten: aplikasi/json; Charset = UTF-8
Panjang Konten: 274
{
	"data": {
		"id": "{USER_ID}",
		"displayName": "Pengguna Baru",
		"email": "[[email protected]](mailto:[email protected])",
		"primaryTenant": "{CUSTOMER_TENANT_ID}",
		"Peran": [" admin.user", "customer.user", "customer.user.supervisorl1", "customer.settings"]["admin.user", "customer.user", "customer.user.supervisorl1", "customer.settings"]
	},
	"kesalahan": 402,
	"message": "dikenakan biaya tambahan",
	"status": "kesalahan",
	"stempel waktu": "2020-02-06T13:01:01.1302340Z"
}