REST Resource: locations.admins

리소스: 관리자

계정 또는 위치의 관리자입니다.

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을 관리자로 초대할 때 사용됩니다.

이 필드와 admin이 모두 CREATE 요청에서 설정된 경우 이 필드가 우선하며 admin의 이메일 주소는 무시됩니다.

형식: accounts/{account}

role

enum (AdminRole)

필수 항목입니다. 이 관리자가 지정된 계정 또는 위치에 사용하는 역할을 지정합니다.

pendingInvitation

boolean

출력 전용입니다. 지정된 리소스에 대해 대기 중인 초대가 이 관리자에게 있는지 여부를 나타냅니다.

메서드

create

지정된 사용자를 지정된 위치의 관리자로 초대합니다.

delete

지정된 위치의 관리자로 지정된 관리자를 삭제합니다.

list

지정된 위치의 모든 관리자를 나열합니다.

patch

지정된 위치의 관리자를 업데이트합니다.