Buat Pengguna #

Membuat Pengguna baru yang ditetapkan ke penyewa Pelanggan.

POST /v1.0/pelanggan/{CUSTOMER_TENANT_ID}/pengguna

Komentar #

Setiap kali Pengguna baru dibuat, mereka akan diberikan peran "customer.user" yang memungkinkan mereka untuk masuk ke Portal pelanggan. Ini juga akan mengirimkan email aktivasi ke alamat yang diberikan segera setelah Pengguna dibuat.

Contoh #

Permintaan ini akan membuat Pengguna baru dengan detail berikut:

Pelanggan: Dalam penyewa Pelanggan dengan id {CUSTOMER_TENANT_ID}
Surel: [email protected]
Nama tampilan: "Pengguna Baru",
Peran:
- Administrator Pengguna (admin.user)
- Pengguna Situs Web (pelanggan.pengguna)
- Tingkat Supervisor Reporter (customer.user.supervisorl1)
- Setelan Pelanggan (customer.settings)

Minta #

POST <https://api.na.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/users> HTTP/1.1
Jenis Konten: aplikasi/json
Menerima biaya: benar
Otorisasi: Pembawa {TOKEN}
Koneksi: tetap hidup
{
	"email": "[[email protected]](mailto:[email protected])",
	"displayName": "Pengguna Baru",
	"Peran": [" admin.user", "customer.user", "customer.user.supervisorl1", "customer.settings"]["admin.user", "customer.user", "customer.user.supervisorl1", "customer.settings"]
}

Jawaban #

HTTP/1.1 201 Dibuat
Jenis Konten: aplikasi/json; Charset = UTF-8
Durasi Konten: xx
Lokasi: <https://api.na.myreports.cloud/api/v1.0/customers/{CUSTOMER_TENANT_ID}/users/{USER_ID}>
{
	"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"]
	},
	"status": "sukses",
	"stempel waktu": "2019-11-29T16:03:23.9251680Z"
}

Kesalahan #

Sah #

Ketika token tidak disediakan, tidak valid atau kedaluwarsa

HTTP/1.1 401 Tidak sah

Permintaan Buruk #

Ketika id penyewa 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 '<tenant id>' tidak valid.",
	"status": "kesalahan",
	"stempel waktu": "2020-02-06T12:45:27.5903465Z"
}

Ketika jumlah lisensi pengguna telah terlampaui

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": "Tidak cukup lisensi pengguna yang tersedia.",
	"status": "kesalahan",
	"stempel waktu": "2020-02-06T12:45:27.5903465Z"
}

Tidak Ditemukan #

Jika tidak ada Pelanggan yang memiliki id penyewa 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"
}

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"
}