REST Resource: customers.configurations

リソース: Configuration

構成では、Android デバイスのプロビジョニング オプションを収集します。各設定の構成は次のとおりです。

  • デバイスにインストールされている EMM Device Policy Controller(DPC)
  • デバイスに適用される EMM ポリシー。
  • セットアップ中にユーザーをサポートするためにデバイスに表示されるメタデータ。

構成は必要な数だけ追加できます。ただし、ゼロタッチ登録が最適に機能するのは、組織が購入する新しいデバイスに適用されるデフォルト設定をお客様が設定している場合です。

JSON 表現
{
  "name": string,
  "configurationId": string,
  "configurationName": string,
  "dpcResourcePath": string,
  "dpcExtras": string,
  "companyName": string,
  "contactEmail": string,
  "contactPhone": string,
  "customMessage": string,
  "isDefault": boolean,
  "forcedResetTime": string
}
フィールド
name

string

出力専用。customers/[CUSTOMER_ID]/configurations/[CONFIGURATION_ID] 形式の API リソース名。サーバーによって割り当てられます。

configurationId

string (int64 format)

出力専用。構成の ID。サーバーによって割り当てられます。

configurationName

string

必須。構成の目的を説明する短い名前。たとえば、「営業チーム」や「臨時従業員」などです。ゼロタッチ登録ポータルでは、この名前が IT 管理者に表示されます。

dpcResourcePath

string

必須。選択した DPC(Device Policy Controller)のリソース名(customers/[CUSTOMER_ID]/dpcs/* 形式)。サポートされている DPC を一覧表示するには、customers.dpcs.list を呼び出します。

dpcExtras

string

DPC に渡される JSON 形式の EMM プロビジョニング エクストラ。

companyName

string

必須。組織の名前。ゼロタッチ登録では、デバイスのプロビジョニング時にデバイスのユーザーにこの組織名が表示されます。

contactEmail

string

必須。デバイスのユーザーからのサポート リクエストを受け付けるメールアドレスです。ゼロタッチ登録では、端末のプロビジョニング前に端末のユーザーにこのメールアドレスが表示されます。値は入力時に検証されます。

contactPhone

string

必須。デバイス ユーザーが別のデバイスを使用してサポートを受けることができる電話番号。ゼロタッチ登録では、デバイスのプロビジョニング前にデバイスのユーザーにこの番号が表示されます。使用できるのは、数字、スペース、プラス記号、ハイフン、丸かっこです。

customMessage

string

デバイスのユーザーがサポートを受けたり、デバイスの状況について詳しい情報を提供したりする際に役立つ、1 ~ 2 文のメッセージ。ゼロタッチ登録では、デバイスのプロビジョニング前にこのメッセージが表示されます。

isDefault

boolean

必須。これが、今後組織が購入する新しいデバイスにゼロタッチ登録を適用するデフォルト設定であるかどうかを示します。デフォルトにできる顧客設定は 1 つのみです。この値を true に設定すると、以前のデフォルト構成の isDefault 値が false に変更されます。

forcedResetTime

string (Duration format)

省略可。デバイスが設定ウィザードでプロビジョニングされない場合に、デバイスを強制的に出荷時設定にリセットする前のタイムアウト。通常は、設定ウィザードでネットワーク接続がないことが原因です。値の範囲は 0 ~ 6 時間で、設定しなかった場合のデフォルトは 2 時間です。

s で終わる小数 9 桁までの秒単位の期間。例: "3.5s"

メソッド

create

新しい構成を作成します。

delete

未使用の構成を削除します。

get

構成の詳細を取得します。

list

お客様の構成を一覧表示します。

patch

構成のフィールド値を更新します。