REST Resource: locations.admins

Referensi: Admin

Administrator Akun atau lokasi.

Representasi JSON
{
  "name": string,
  "admin": string,
  "account": string,
  "role": enum (AdminRole),
  "pendingInvitation": boolean
}
Kolom
name

string

Tidak dapat diubah. Nama resource. Untuk admin akun, ini dalam bentuk: accounts/{account_id}/admins/{admin_id}

Untuk admin lokasi, ini dalam bentuk: locations/{locationId}/admins/{admin_id}

Kolom ini akan diabaikan jika ditetapkan selama pembuatan admin.

admin

string

Opsional. Nama admin. Saat membuat undangan awal, ini adalah alamat email pengguna yang diundang. Pada panggilan GET, alamat email pengguna akan ditampilkan jika undangan masih menunggu keputusan. Jika tidak, kolom ini berisi nama depan dan nama belakang pengguna.

Kolom ini hanya perlu ditetapkan selama pembuatan admin.

account

string

Tidak dapat diubah. Nama resource Akun yang dirujuk Admin ini. Digunakan saat memanggil locations.admins.create untuk mengundang LocationGroup sebagai admin.

Jika kolom ini dan admin ditetapkan pada permintaan CREATE, kolom ini akan diprioritaskan dan alamat email di admin akan diabaikan.

Format accounts/{account}.

role

enum (AdminRole)

Wajib. Menentukan peran yang digunakan admin ini dengan Akun atau Lokasi yang ditentukan.

pendingInvitation

boolean

Hanya output. Menunjukkan apakah admin ini memiliki undangan yang masih menunggu keputusan untuk resource yang ditentukan.

Metode

create

Mengundang pengguna tertentu agar menjadi administrator untuk lokasi tertentu.

delete

Menghapus admin tertentu sebagai pengelola lokasi tertentu.

list

Menampilkan daftar semua admin untuk lokasi yang ditentukan.

patch

Memperbarui Admin untuk lokasi yang ditentukan.