REST Resource: accounts.admins

Resource: Admin

An administrator of an Account or a location.

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

string

Immutable. The resource name. For account admins, this is in the form: accounts/{account_id}/admins/{admin_id}

For location admins, this is in the form: locations/{locationId}/admins/{admin_id}

This field will be ignored if set during admin creation.

admin

string

Optional. The name of the admin. When making the initial invitation, this is the invitee's email address. On GET calls, the user's email address is returned if the invitation is still pending. Otherwise, it contains the user's first and last names.

This field is only needed to be set during admin creation.

account

string

Immutable. The name of the Account resource that this Admin refers to. Used when calling locations.admins.create to invite a LocationGroup as an admin.

If both this field and admin are set on CREATE requests, this field takes precedence and the email address in admin will be ignored.

Format: accounts/{account}.

role

enum (AdminRole)

Required. Specifies the role that this admin uses with the specified Account or Location.

pendingInvitation

boolean

Output only. Indicates whether this admin has a pending invitation for the specified resource.

AdminRole

Indicates the access level that an admin has. For more information, see the help center article

Enums
ADMIN_ROLE_UNSPECIFIED Not specified.
PRIMARY_OWNER The admin has owner-level access and is the primary owner. (Displays as 'Primary Owner' in UI).
OWNER The admin has owner-level access. (Displays as 'Owner' in UI).
MANAGER The admin has managerial access.
SITE_MANAGER The admin can manage social (Google+) pages. (Displays as 'Site Manager' in UI). This API doesn't allow creating an account admin with a SITE_MANAGER role.

Methods

create

Invites the specified user to become an administrator for the specified account.

delete

Removes the specified admin from the specified account.

list

Lists the admins for the specified account.

patch

Updates the Admin for the specified Account Admin.