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

デバイス管理アプリの UI に表示される主な色を示す RGB 形式の色。色のコンポーネントは (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)

出力専用。managed Google Play アカウント エンタープライズのタイプ。
managedGoogleDomainType

enum (ManagedGoogleDomainType)

出力専用。管理対象の Google ドメインのタイプ。

NotificationType

デバイス管理サーバーが Google Pub/Sub 経由で送信する通知の種類。

列挙型
NOTIFICATION_TYPE_UNSPECIFIED この値は無視されます。
ENROLLMENT デバイスが登録されたときに送信される通知。
COMPLIANCE_REPORT

サポート終了。
STATUS_REPORT デバイスがステータス レポートを発行したときに送信される通知。
COMMAND デバイス コマンドが完了したときに送信される通知。
USAGE_LOGS デバイスが BatchUsageLogEvents を送信したときに送信される通知。

ExternalData

外部ロケーションでホストされているデータ。データは Android Device Policy によってダウンロードされ、ハッシュと照合されます。

JSON 表現 
{
  "url": string,
  "sha256Hash": string
}
フィールド
url

string

データへの絶対 URL。http または https スキームを使用する必要があります。Android Device Policy は GET リクエストで認証情報を提供しないため、URL は一般公開されている必要があります。長くてランダムなコンポーネントを URL に含めることで、攻撃者が URL を見つけるのを防ぐことができます。
sha256Hash

string

URL でホストされているコンテンツの 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 を管理します。

企業では、次の 3 つのフィールド（signinUrl、allowPersonalUsage、tokenTag）の組み合わせによって一意に識別される SigninDetail を任意の数作成できます。同じ（signinUrl、allowPersonalUsage、tokenTag）の SigninDetail を 2 つ作成することはできません。（tokenTag は省略可能なフィールドです）。

Patch: このオペレーションは、現在の SigninDetails リストを新しい SigninDetails リストで更新します。

  • 保存された SigninDetail 構成が渡された場合、同じ signinEnrollmentToken と qrCode が返されます。
  • 保存されていない複数の同じ SigninDetail 構成を渡すと、それらの SigninDetail 構成の最初のものが保存されます。
  • 構成がすでに存在する場合、特定のパッチ API 呼び出しで構成を複数回リクエストすることはできません。リクエストすると、重複キーエラーが発生し、オペレーション全体が失敗します。
  • リクエストから特定の SigninDetail 構成を削除すると、ストレージからも削除されます。同じ SigninDetail 構成に対して別の signinEnrollmentToken と qrCode をリクエストできます。
JSON 表現 
{
  "signinUrl": string,
  "signinEnrollmentToken": string,
  "qrCode": string,
  "allowPersonalUsage": enum (AllowPersonalUsage),
  "defaultStatus": enum (SigninDetailDefaultStatus),
  "tokenTag": string
}
フィールド
signinUrl

string

デバイスがログイン登録トークンでプロビジョニングされている場合の認証用のログイン URL。ログイン エンドポイントは、ログインが成功した場合は https://enterprise.google.com/android/enroll?et= 、ログインが失敗した場合は https://enterprise.google.com/android/enroll/invalid の形式の URL で認証フローを終了する必要があります。
signinEnrollmentToken

string

カスタム ログイン フローをトリガーするために使用される、組織全体の登録トークン。サーバーで生成される読み取り専用フィールドです。
qrCode

string

UTF-8 表現を使用して QR コードを生成して、この登録トークンを使用してデバイスを登録できる JSON 文字列。NFC を使用してデバイスを登録するには、NFC レコードに JSON 内のプロパティのシリアル化された java.util.Properties 表現を含める必要があります。サーバーで生成される読み取り専用フィールドです。
allowPersonalUsage

enum (AllowPersonalUsage)

この登録トークンでプロビジョニングされたデバイスで個人使用を許可するかどうかを管理します。

会社所有デバイスの場合:

  • 個人での使用を有効にすると、ユーザーはデバイスで仕事用プロファイルを設定できます。
  • 個人での使用を無効にするには、ユーザーがデバイスを完全管理対象デバイスとしてプロビジョニングする必要があります。

個人所有のデバイスの場合:

  • 個人での使用を有効にすると、ユーザーはデバイスで仕事用プロファイルを設定できます。
  • 個人での使用を無効にすると、デバイスのプロビジョニングが停止します。個人所有のデバイスでは、個人での使用を無効にできません。
defaultStatus

enum (SigninDetailDefaultStatus)

省略可。企業でデフォルトでログイン URL を使用するかどうか。defaultStatus が SIGNIN_DETAIL_IS_DEFAULT に設定された SigninDetail は、Google アカウントの登録方法に使用されます。企業の signinDetails で defaultStatus を SIGNIN_DETAIL_IS_DEFAULT に設定できるのは 1 つのみです。Enterprise に signinDetails が 1 つ以上あり、いずれも defaultStatus が SIGNIN_DETAIL_IS_DEFAULT に設定されていない場合、リストの最初の signinDetails が選択され、defaultStatus が SIGNIN_DETAIL_IS_DEFAULT に設定されます。Enterprise に signinDetails が指定されていない場合、Google アカウントのデバイス登録は失敗します。
tokenTag

string

SigninDetail のインスタンスを区別するための EMM 指定のメタデータ。

SigninDetailDefaultStatus

企業でデフォルトでログイン URL を使用するかどうか。

列挙型
SIGNIN_DETAIL_DEFAULT_STATUS_UNSPECIFIED SIGNIN_DETAIL_IS_NOT_DEFAULT と同じです。
SIGNIN_DETAIL_IS_DEFAULT デフォルトでは、企業のログイン URL が使用されます。
SIGNIN_DETAIL_IS_NOT_DEFAULT ログイン URL は、デフォルトでは企業で使用されません。

ContactInfo

managed 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

EU 担当者の名前。
euRepresentativeEmail

string

EU 担当者のメールアドレス。メールアドレスは検証されていますが、確認されていません。
euRepresentativePhone

string

EU 担当者の電話番号。電話番号は検証されていますが、確認されていません。

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 エンタープライズが managed Google Play アカウント エンタープライズである。

ManagedGooglePlayAccountsEnterpriseType

managed Google Play アカウント エンタープライズのタイプ。

列挙型
MANAGED_GOOGLE_PLAY_ACCOUNTS_ENTERPRISE_TYPE_UNSPECIFIED managed Google Play アカウント エンタープライズのタイプが指定されていません。
CUSTOMER_MANAGED エンタープライズが顧客管理
EMM_MANAGED 企業が EMM で管理されている（非推奨）。

ManagedGoogleDomainType

管理対象の Google ドメインのタイプ。

列挙型
MANAGED_GOOGLE_DOMAIN_TYPE_UNSPECIFIED マネージド Google ドメインのタイプが指定されていません。
TYPE_TEAM マネージド Google ドメインはメールで確認済みのチームです。
TYPE_DOMAIN 管理対象の Google ドメインのドメイン所有権が確認済みである。

メソッド

create

 エンタープライズを作成します。

delete

 エンタープライズと、エンタープライズに関連付けられているすべてのアカウントとデータを完全に削除します。

get

 エンタープライズを取得します。

list

 EMM で管理されているエンタープライズを一覧表示します。

patch

 エンタープライズを更新します。