REST Resource: enterprises

資源:Enterprise

套用至企業的設定。

JSON 表示法
{
  "name": string,
  "enabledNotificationTypes": [
    enum (NotificationType)
  ],
  "pubsubTopic": string,
  "primaryColor": integer,
  "logo": {
    object (ExternalData)
  },
  "enterpriseDisplayName": string,
  "termsAndConditions": [
    {
      object (TermsAndConditions)
    }
  ],
  "appAutoApprovalEnabled": boolean,
  "signinDetails": [
    {
      object (SigninDetail)
    }
  ],
  "contactInfo": {
    object (ContactInfo)
  },
  "googleAuthenticationSettings": {
    object (GoogleAuthenticationSettings)
  },
  "enterpriseType": enum (EnterpriseType),
  "managedGooglePlayAccountsEnterpriseType": enum (ManagedGooglePlayAccountsEnterpriseType),
  "managedGoogleDomainType": enum (ManagedGoogleDomainType)
}
欄位
name

string

企業名稱,由伺服器在建立時產生,格式為 enterprises/{enterpriseId}

enabledNotificationTypes[]

enum (NotificationType)

為企業啟用的 Google Pub/Sub 通知類型。

pubsubTopic

string

Pub/Sub 通知發布的主題,格式為 projects/{project}/topics/{topic}。只有在啟用 Pub/Sub 通知時,才需要填寫這個欄位。

primaryColor

integer

RGB 格式的顏色,表示要在裝置管理應用程式 UI 中顯示的主要顏色。顏色元件的儲存方式如下:(red << 16) | (green << 8) | blue,其中每個元件的值介於 0 到 255 (含頭尾)。

enterpriseDisplayName

string

向使用者顯示的企業名稱。這個欄位的長度上限為 100 個字元。

termsAndConditions[]

object (TermsAndConditions)

為這個企業佈建裝置時必須接受的條款及細則。系統會為這份清單中的每個值產生一頁字詞。

appAutoApprovalEnabled
(deprecated)

boolean

已淘汰且未使用。

signinDetails[]

object (SigninDetail)

企業的登入詳細資料。

contactInfo

object (ContactInfo)

EMM 管理企業的企業聯絡資訊。

googleAuthenticationSettings

object (GoogleAuthenticationSettings)

Google 提供的使用者驗證設定。

enterpriseType

enum (EnterpriseType)

僅供輸出。企業類型。

managedGooglePlayAccountsEnterpriseType

enum (ManagedGooglePlayAccountsEnterpriseType)

僅供輸出。Google Play 管理版帳戶企業的類型。

managedGoogleDomainType

enum (ManagedGoogleDomainType)

僅供輸出。受管理 Google 網域的類型。

NotificationType

裝置管理伺服器可能會透過 Google Pub/Sub 傳送的通知類型。

列舉
NOTIFICATION_TYPE_UNSPECIFIED 系統會忽略這個值。
ENROLLMENT 裝置註冊時傳送的通知。
COMPLIANCE_REPORT

已淘汰。

STATUS_REPORT 裝置發布狀態報告時傳送的通知。
COMMAND 裝置指令完成時傳送的通知。
USAGE_LOGS 裝置傳送 BatchUsageLogEvents 時,系統會傳送通知。
ENTERPRISE_UPGRADE 系統會傳送通知,告知您已升級至 Enterprise 版。企業升級程序可將 Google Play 管理版帳戶企業升級為受管理 Google 網域。

ExternalData

託管於外部位置的資料。Android Device Policy 會下載資料,並根據雜湊值進行驗證。

JSON 表示法
{
  "url": string,
  "sha256Hash": string
}
欄位
url

string

資料的絕對網址,必須使用 http 或 https 通訊協定。Android Device Policy 不會在 GET 要求中提供任何憑證,因此網址必須可供公開存取。在網址中加入隨機的長組件,可防止攻擊者發現網址。

sha256Hash

string

以 Base64 編碼的 SHA-256 雜湊,代表網址中託管的內容。如果內容與這個雜湊值不符,Android Device Policy 就不會使用該資料。

TermsAndConditions

佈建期間必須接受條款及細則的頁面。

JSON 表示法
{
  "header": {
    object (UserFacingMessage)
  },
  "content": {
    object (UserFacingMessage)
  }
}
欄位
header

object (UserFacingMessage)

HTML 內容上方的簡短標題。

content

object (UserFacingMessage)

格式正確的 HTML 字串。系統會在用戶端使用 android.text.Html#fromHtml 剖析這項資料。

SigninDetail

包含企業登入詳細資料的資源。使用 enterprises 管理特定企業的 SigninDetail

對於企業來說,我們可擁有任意數量的 SigninDetail,這些 SigninDetail 會透過下列三個欄位 (signinUrlallowPersonalUsagetokenTag) 的組合進行唯一識別。您無法建立兩個具有相同 (signinUrlallowPersonalUsagetokenTag) 的 SigninDetail。(tokenTag 為選填欄位)。

Patch:這項作業會使用新的 SigninDetails 清單更新目前的 SigninDetails 清單。

  • 如果傳遞儲存的 SigninDetail 設定,則會傳回相同的 signinEnrollmentTokenqrCode
  • 如果我們傳遞多個未儲存的相同 SigninDetail 設定,系統會儲存這些 SigninDetail 設定中的第一個。
  • 如果設定已存在,我們無法在特定修補程式 API 呼叫中要求設定超過一次,否則會發生重複鍵錯誤,且整個作業都會失敗。
  • 如果我們從要求中移除特定 SigninDetail 設定,該設定就會從儲存空間中移除。然後,我們就能針對相同的 SigninDetail 設定要求另一個 signinEnrollmentTokenqrCode
JSON 表示法
{
  "signinUrl": string,
  "signinEnrollmentToken": string,
  "qrCode": string,
  "allowPersonalUsage": enum (AllowPersonalUsage),
  "defaultStatus": enum (SigninDetailDefaultStatus),
  "tokenTag": string
}
欄位
signinUrl

string

裝置使用登入註冊權杖佈建時,用於驗證的登入網址。登入端點應以 https://enterprise.google.com/android/enroll?et= 形式的網址完成驗證流程 (登入成功),或以 https://enterprise.google.com/android/enroll/invalid 形式的網址完成驗證流程 (登入失敗)。

signinEnrollmentToken

string

用於觸發自訂登入流程的企業專用註冊權杖。這是伺服器產生的唯讀欄位。

qrCode

string

JSON 字串,其 UTF-8 表示法可用於產生 QR code,以便使用這個註冊權杖註冊裝置。如要使用 NFC 註冊裝置,NFC 記錄必須包含 JSON 中屬性的序列化 java.util.Properties 表示法。這是伺服器產生的唯讀欄位。

allowPersonalUsage

enum (AllowPersonalUsage)

控管是否允許在透過這組註冊權杖佈建的裝置上進行個人使用。

公司擁有的裝置:

  • 啟用個人用途後,使用者就能在裝置上設定工作資料夾。
  • 如要停用個人用途,使用者必須將裝置佈建為全代管裝置。

個人裝置:

  • 啟用個人用途後,使用者就能在裝置上設定工作資料夾。
  • 停用個人用途後,裝置就無法佈建。在個人裝置上無法停用個人用途。
defaultStatus

enum (SigninDetailDefaultStatus)

(選用步驟) 是否應預設使用企業的登入網址。系統會使用 defaultStatus 設為 SIGNIN_DETAIL_IS_DEFAULTSigninDetail,做為 Google 帳戶註冊方法。企業的 signinDetails 只能有一個將 defaultStatus 設為 SIGNIN_DETAIL_IS_DEFAULT。如果 Enterprise 至少有一個 signinDetails,且沒有任何一個 defaultStatus 設為 SIGNIN_DETAIL_IS_DEFAULT,系統會選取清單中的第一個 Enterprise,並將 defaultStatus 設為 SIGNIN_DETAIL_IS_DEFAULT。如果未指定 EnterprisesigninDetails,Google 帳戶裝置註冊就會失敗。

tokenTag

string

EMM 指定的中繼資料,用於區分 SigninDetail 的執行個體。

SigninDetailDefaultStatus

是否應預設使用企業的登入網址。

列舉
SIGNIN_DETAIL_DEFAULT_STATUS_UNSPECIFIED 等同於 SIGNIN_DETAIL_IS_NOT_DEFAULT
SIGNIN_DETAIL_IS_DEFAULT 系統預設會使用企業的登入網址。
SIGNIN_DETAIL_IS_NOT_DEFAULT 系統預設不會使用企業的登入網址。

ContactInfo

Google Play 管理版企業的聯絡資料。

JSON 表示法
{
  "contactEmail": string,
  "dataProtectionOfficerName": string,
  "dataProtectionOfficerEmail": string,
  "dataProtectionOfficerPhone": string,
  "euRepresentativeName": string,
  "euRepresentativeEmail": string,
  "euRepresentativePhone": string
}
欄位
contactEmail

string

聯絡人的電子郵件地址,用於傳送與受管理 Google Play 相關的重要公告。

dataProtectionOfficerName

string

資料保護長姓名。

dataProtectionOfficerEmail

string

資料保護長的電子郵件地址。電子郵件地址已通過驗證,但尚未驗證。

dataProtectionOfficerPhone

string

資料保護官的電話號碼。系統會驗證電話號碼,但不會進行驗證。

euRepresentativeName

string

歐盟代表的姓名。

euRepresentativeEmail

string

歐盟代表的電子郵件地址。電子郵件地址已通過驗證,但尚未驗證。

euRepresentativePhone

string

歐盟代表的電話號碼。電話號碼已通過驗證,但尚未驗證。

GoogleAuthenticationSettings

包含 Google 提供的使用者驗證設定。

JSON 表示法
{
  "googleAuthenticationRequired": enum (GoogleAuthenticationRequired)
}
欄位
googleAuthenticationRequired

enum (GoogleAuthenticationRequired)

僅供輸出。使用者在註冊過程中是否需要透過 Google 驗證。IT 管理員可以指定是否為企業啟用 Google 驗證,以供知識工作者裝置使用。您只能透過 Google 管理控制台設定這個值。Google 驗證可搭配 signinUrl 使用。如果需要 Google 驗證,且指定了 signinUrl,系統會先啟動 Google 驗證,再啟動 signinUrl

GoogleAuthenticationRequired

這個企業是否需要 Google 驗證的設定。

列舉
GOOGLE_AUTHENTICATION_REQUIRED_UNSPECIFIED 系統不會使用這個值。
NOT_REQUIRED 不需要 Google 驗證。
REQUIRED 使用者必須通過 Google 驗證。

EnterpriseType

企業類型。

列舉
ENTERPRISE_TYPE_UNSPECIFIED 系統不會使用這個值。
MANAGED_GOOGLE_DOMAIN 企業屬於受管理的 Google 網域
MANAGED_GOOGLE_PLAY_ACCOUNTS_ENTERPRISE 企業是 Google Play 管理版帳戶企業

ManagedGooglePlayAccountsEnterpriseType

Google Play 管理版帳戶企業的類型。

列舉
MANAGED_GOOGLE_PLAY_ACCOUNTS_ENTERPRISE_TYPE_UNSPECIFIED 未指定 Google Play 管理版帳戶企業類型。
CUSTOMER_MANAGED 企業由客戶自行管理
EMM_MANAGED 企業是由 EMM 管理 (已淘汰)。

ManagedGoogleDomainType

受管理 Google 網域的類型。

列舉
MANAGED_GOOGLE_DOMAIN_TYPE_UNSPECIFIED 未指定代管 Google 網域類型。
TYPE_TEAM 受管理 Google 網域是已驗證電子郵件的團隊。
TYPE_DOMAIN 受管理 Google 網域已通過網域驗證。

方法

create

建立企業。

delete

永久刪除企業,以及所有相關聯的帳戶和資料。

generateEnterpriseUpgradeUrl

產生企業升級網址,將現有的 Google Play 管理版帳戶企業升級為受管理 Google 網域。

get

取得企業。

list

列出 EMM 管理的企業。

patch

更新企業。