REST Resource: locations.admins

資源:Admin

帳戶管理員或地點的管理員。

JSON 表示法
{
  "name": string,
  "admin": string,
  "account": string,
  "role": enum (AdminRole),
  "pendingInvitation": boolean
}
欄位
name

string

不可變動。資源名稱。如果您是帳戶管理員,請填寫下方表單:accounts/{account_id}/admins/{admin_id}

如果是營業地點管理員,請使用下列格式:locations/{locationId}/admins/{admin_id}

如果在管理員建立過程中設定,系統會忽略這個欄位。

admin

string

選用設定。管理員的名稱。最初發出邀請時,這是邀請對象的電子郵件地址。在 GET 呼叫中,如果邀請仍待處理,系統會傳回使用者的電子郵件地址。否則會包含使用者的姓名。

只有在管理員建立時,才需要設定這個欄位。

account

string

不可變動。管理員參照的帳戶資源名稱。呼叫 location.admins.create 以邀請 LocationGroup 為管理員。

如果 CREATE 要求中同時設定這個欄位和 admin,則系統會優先採用這個欄位,並忽略 admin 中的電子郵件地址。

格式:accounts/{account}

role

enum (AdminRole)

必要欄位。指定這位管理員用於指定帳戶或位置的角色。

pendingInvitation

boolean

僅供輸出。指出此管理員是否有待處理的指定資源的邀請。

方法

create

邀請指定使用者成為指定地點的管理員。

delete

移除指定位置的管理員。

list

列出指定位置的所有管理員。

patch

更新指定位置的管理員。