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

不可变。此管理员所指的账号资源的名称。在调用 locations.admins.create 以邀请营业地点组作为管理员时使用。

如果在 CREATE 请求中同时设置了此字段和 admin,则此字段的优先级更高,admin 中的电子邮件地址将被忽略。

格式:accounts/{account}

role

enum (AdminRole)

必需。指定此管理员在指定账号或位置使用的角色。

pendingInvitation

boolean

仅限输出。指明此管理员是否有对指定资源的待处理邀请。

方法

create

邀请指定用户担任指定营业地点的管理员。

delete

移除担任指定营业地点管理员的指定管理员。

list

列出指定营业地点的所有管理员。

patch

更新指定营业地点的管理员。