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 を呼び出して LocationGroup を管理者として招待する際に使用します。

CREATE リクエストでこのフィールドと admin の両方を設定した場合、このフィールドが優先され、admin のメールアドレスは無視されます。

形式: accounts/{account}

role

enum (AdminRole)

必須。この管理者が指定したアカウントまたはビジネス情報で使用するロールを指定します。

pendingInvitation

boolean

出力専用。この管理者が、指定したリソースへの招待を保留にしているかどうかを表します。

メソッド

create

指定したユーザーを、指定したビジネスの管理者として招待します。

delete

指定したビジネスの管理者として指定した管理者を削除します。

list

指定したビジネスのすべての管理者の一覧を取得します。

patch

指定したビジネスのビジネス情報を管理者に通知します。