mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-26 19:58:50 +01:00
610 lines
22 KiB
HTML
610 lines
22 KiB
HTML
<!DOCTYPE html>
|
|
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
|
|
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
|
|
<head>
|
|
<meta charset="utf-8">
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0">
|
|
|
|
<title>Create - Cloud Identity v3.0.0+20220301</title>
|
|
|
|
|
|
|
|
<link href='https://fonts.googleapis.com/css?family=Lato:400,700|Roboto+Slab:400,700|Inconsolata:400,700' rel='stylesheet' type='text/css'>
|
|
|
|
<link rel="stylesheet" href="../css/theme.css" type="text/css" />
|
|
<link rel="stylesheet" href="../css/theme_extra.css" type="text/css" />
|
|
<link rel="stylesheet" href="../css/highlight.css">
|
|
|
|
<script src="//cdnjs.cloudflare.com/ajax/libs/jquery/2.1.1/jquery.min.js"></script>
|
|
<script src="//cdnjs.cloudflare.com/ajax/libs/modernizr/2.8.3/modernizr.min.js"></script>
|
|
<script type="text/javascript" src="../js/highlight.pack.js"></script>
|
|
<script src="../js/theme.js"></script>
|
|
|
|
<style>
|
|
body {font-size: 90%;}
|
|
pre, code {font-size: 100%;}
|
|
h3, h4, h5, h6 {color: #2980b9; font-weight: 300}
|
|
</style>
|
|
</head>
|
|
|
|
<body class="wy-body-for-nav" role="document">
|
|
|
|
<div class="wy-grid-for-nav">
|
|
|
|
|
|
<nav data-toggle="wy-nav-shift" class="wy-nav-side stickynav">
|
|
<div class="wy-side-nav-search">
|
|
<a href=".." class="icon icon-home"> Cloud Identity v3.0.0+20220301</a>
|
|
|
|
</div>
|
|
|
|
<div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
|
|
<ul class="current">
|
|
|
|
|
|
<span>Devices</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../devices_cancel-wipe">Cancel Wipe</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 current">
|
|
<a class="current" href=".">Create</a>
|
|
|
|
<ul>
|
|
|
|
<li class="toctree-l2"><a href="#scopes">Scopes</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#required-request-value">Required Request Value</a></li>
|
|
|
|
<li><a class="toctree-l3" href="#about-cursors">About Cursors</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#optional-output-flags">Optional Output Flags</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#optional-method-properties">Optional Method Properties</a></li>
|
|
|
|
|
|
<li class="toctree-l2"><a href="#optional-general-properties">Optional General Properties</a></li>
|
|
|
|
|
|
</ul>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../devices_delete">Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../devices_device-users-approve">Device Users Approve</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../devices_device-users-block">Device Users Block</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../devices_device-users-cancel-wipe">Device Users Cancel Wipe</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../devices_device-users-client-states-get">Device Users Client States Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../devices_device-users-client-states-list">Device Users Client States List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../devices_device-users-client-states-patch">Device Users Client States Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../devices_device-users-delete">Device Users Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../devices_device-users-get">Device Users Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../devices_device-users-list">Device Users List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../devices_device-users-lookup">Device Users Lookup</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../devices_device-users-wipe">Device Users Wipe</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../devices_get">Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../devices_list">List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../devices_wipe">Wipe</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
|
|
<span>Groups</span>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../groups_create">Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../groups_delete">Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../groups_get">Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../groups_get-security-settings">Get Security Settings</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../groups_list">List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../groups_lookup">Lookup</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../groups_memberships-check-transitive-membership">Memberships Check Transitive Membership</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../groups_memberships-create">Memberships Create</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../groups_memberships-delete">Memberships Delete</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../groups_memberships-get">Memberships Get</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../groups_memberships-get-membership-graph">Memberships Get Membership Graph</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../groups_memberships-list">Memberships List</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../groups_memberships-lookup">Memberships Lookup</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../groups_memberships-modify-membership-roles">Memberships Modify Membership Roles</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../groups_memberships-search-transitive-groups">Memberships Search Transitive Groups</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../groups_memberships-search-transitive-memberships">Memberships Search Transitive Memberships</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../groups_patch">Patch</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../groups_search">Search</a>
|
|
|
|
</li>
|
|
|
|
<li class="toctree-l1 ">
|
|
<a class="" href="../groups_update-security-settings">Update Security Settings</a>
|
|
|
|
</li>
|
|
|
|
|
|
|
|
|
|
</ul>
|
|
|
|
</div>
|
|
|
|
</nav>
|
|
|
|
<section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
|
|
|
|
|
|
<nav class="wy-nav-top" role="navigation" aria-label="top navigation">
|
|
<i data-toggle="wy-nav-top" class="icon icon-reorder"></i>
|
|
<a href=".."></a>
|
|
</nav>
|
|
|
|
|
|
<div class="wy-nav-content">
|
|
<div class="rst-content">
|
|
<div role="navigation" aria-label="breadcrumbs navigation">
|
|
<ul class="wy-breadcrumbs">
|
|
<li><a href="..">Docs</a> »</li>
|
|
<li>Create</li>
|
|
<li class="wy-breadcrumbs-aside">
|
|
|
|
|
|
<a href="https://github.com/Byron/google-apis-rs/tree/main/gen/cloudidentity1-cli" class="icon icon-github"> Edit on GitHub</a>
|
|
|
|
|
|
</li>
|
|
</ul>
|
|
<hr/>
|
|
</div>
|
|
<div role="main">
|
|
<div class="section">
|
|
<p>Creates a device. Only company-owned device may be created. <strong>Note</strong>: This method is available only to customers who have one of the following SKUs: Enterprise Standard, Enterprise Plus, Enterprise for Education, and Cloud Identity Premium</p>
|
|
<h1 id="scopes">Scopes</h1>
|
|
<p>You will need authorization for the <em>https://www.googleapis.com/auth/cloud-identity.devices</em> scope to make a valid call.</p>
|
|
<p>If unset, the scope for this method defaults to <em>https://www.googleapis.com/auth/cloud-identity.devices</em>.
|
|
You can set the scope for this method like this: <code>cloudidentity1 --scope <scope> devices create ...</code></p>
|
|
<h1 id="required-request-value">Required Request Value</h1>
|
|
<p>The request value is a data-structure with various fields. Each field may be a simple scalar or another data-structure.
|
|
In the latter case it is advised to set the field-cursor to the data-structure's field to specify values more concisely.</p>
|
|
<p>For example, a structure like this:</p>
|
|
<pre><code>GoogleAppsCloudidentityDevicesV1Device:
|
|
android-specific-attributes:
|
|
enabled-unknown-sources: boolean
|
|
owner-profile-account: boolean
|
|
ownership-privilege: string
|
|
supports-work-profile: boolean
|
|
asset-tag: string
|
|
baseband-version: string
|
|
bootloader-version: string
|
|
brand: string
|
|
build-number: string
|
|
compromised-state: string
|
|
create-time: string
|
|
device-type: string
|
|
enabled-developer-options: boolean
|
|
enabled-usb-debugging: boolean
|
|
encryption-state: string
|
|
imei: string
|
|
kernel-version: string
|
|
last-sync-time: string
|
|
management-state: string
|
|
manufacturer: string
|
|
meid: string
|
|
model: string
|
|
name: string
|
|
network-operator: string
|
|
os-version: string
|
|
other-accounts: [string]
|
|
owner-type: string
|
|
release-version: string
|
|
security-patch-time: string
|
|
serial-number: string
|
|
wifi-mac-addresses: [string]
|
|
|
|
</code></pre>
|
|
|
|
<p>can be set completely with the following arguments which are assumed to be executed in the given order. Note how the cursor position is adjusted to the respective structures, allowing simple field names to be used most of the time.</p>
|
|
<ul>
|
|
<li><code>-r .android-specific-attributes enabled-unknown-sources=true</code><ul>
|
|
<li>Whether applications from unknown sources can be installed on device.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>owner-profile-account=false</code><ul>
|
|
<li>Whether this account is on an owner/primary profile. For phones, only true for owner profiles. Android 4+ devices can have secondary or restricted user profiles.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>ownership-privilege=amet.</code><ul>
|
|
<li>Ownership privileges on device.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>supports-work-profile=true</code></p>
|
|
<ul>
|
|
<li>Whether device supports Android work profiles. If false, this service will not block access to corp data even if an administrator turns on the "Enforce Work Profile" policy.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><code>.. asset-tag=amet.</code></p>
|
|
<ul>
|
|
<li>Asset tag of the device.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>baseband-version=duo</code><ul>
|
|
<li>Output only. Baseband version of the device.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>bootloader-version=ipsum</code><ul>
|
|
<li>Output only. Device bootloader version. Example: 0.6.7.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>brand=gubergren</code><ul>
|
|
<li>Output only. Device brand. Example: Samsung.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>build-number=lorem</code><ul>
|
|
<li>Output only. Build number of the device.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>compromised-state=gubergren</code><ul>
|
|
<li>Output only. Represents whether the Device is compromised.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>create-time=eos</code><ul>
|
|
<li>Output only. When the Company-Owned device was imported. This field is empty for BYOD devices.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>device-type=dolor</code><ul>
|
|
<li>Output only. Type of device.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>enabled-developer-options=true</code><ul>
|
|
<li>Output only. Whether developer options is enabled on device.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>enabled-usb-debugging=false</code><ul>
|
|
<li>Output only. Whether USB debugging is enabled on device.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>encryption-state=amet</code><ul>
|
|
<li>Output only. Device encryption state.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>imei=duo</code><ul>
|
|
<li>Output only. IMEI number of device if GSM device; empty otherwise.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>kernel-version=ipsum</code><ul>
|
|
<li>Output only. Kernel version of the device.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>last-sync-time=sed</code><ul>
|
|
<li>Most recent time when device synced with this service.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>management-state=ut</code><ul>
|
|
<li>Output only. Management state of the device</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>manufacturer=gubergren</code><ul>
|
|
<li>Output only. Device manufacturer. Example: Motorola.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>meid=rebum.</code><ul>
|
|
<li>Output only. MEID number of device if CDMA device; empty otherwise.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>model=est</code><ul>
|
|
<li>Output only. Model name of device. Example: Pixel 3.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>name=ipsum</code><ul>
|
|
<li>Output only. <a href="https://cloud.google.com/apis/design/resource_names">Resource name</a> of the Device in format: <code>devices/{device}</code>, where device is the unique id assigned to the Device.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>network-operator=ipsum</code><ul>
|
|
<li>Output only. Mobile or network operator of device, if available.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>os-version=est</code><ul>
|
|
<li>Output only. OS version of the device. Example: Android 8.1.0.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>other-accounts=gubergren</code><ul>
|
|
<li>Output only. Domain name for Google accounts on device. Type for other accounts on device. On Android, will only be populated if |ownership_privilege| is |PROFILE_OWNER| or |DEVICE_OWNER|. Does not include the account signed in to the device policy app if that account's domain has only one account. Examples: "com.example", "xyz.com".</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>owner-type=ea</code><ul>
|
|
<li>Output only. Whether the device is owned by the company or an individual</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>release-version=dolor</code><ul>
|
|
<li>Output only. OS release version. Example: 6.0.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>security-patch-time=lorem</code><ul>
|
|
<li>Output only. OS security patch update time on device.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>serial-number=eos</code><ul>
|
|
<li>Serial Number of device. Example: HT82V1A01076.</li>
|
|
</ul>
|
|
</li>
|
|
<li><code>wifi-mac-addresses=labore</code><ul>
|
|
<li>WiFi MAC addresses of device.</li>
|
|
<li>Each invocation of this argument appends the given value to the array.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h3 id="about-cursors">About Cursors</h3>
|
|
<p>The cursor position is key to comfortably set complex nested structures. The following rules apply:</p>
|
|
<ul>
|
|
<li>The cursor position is always set relative to the current one, unless the field name starts with the <code>.</code> character. Fields can be nested such as in <code>-r f.s.o</code> .</li>
|
|
<li>The cursor position is set relative to the top-level structure if it starts with <code>.</code>, e.g. <code>-r .s.s</code></li>
|
|
<li>You can also set nested fields without setting the cursor explicitly. For example, to set a value relative to the current cursor position, you would specify <code>-r struct.sub_struct=bar</code>.</li>
|
|
<li>You can move the cursor one level up by using <code>..</code>. Each additional <code>.</code> moves it up one additional level. E.g. <code>...</code> would go three levels up.</li>
|
|
</ul>
|
|
<h1 id="optional-output-flags">Optional Output Flags</h1>
|
|
<p>The method's return value a JSON encoded structure, which will be written to standard output by default.</p>
|
|
<ul>
|
|
<li><strong>-o out</strong><ul>
|
|
<li><em>out</em> specifies the <em>destination</em> to which to write the server's result to.
|
|
It will be a JSON-encoded structure.
|
|
The <em>destination</em> may be <code>-</code> to indicate standard output, or a filepath that is to contain the received bytes.
|
|
If unset, it defaults to standard output.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="optional-method-properties">Optional Method Properties</h1>
|
|
<p>You may set the following properties to further configure the call. Please note that <code>-p</code> is followed by one
|
|
or more key-value-pairs, and is called like this <code>-p k1=v1 k2=v2</code> even though the listing below repeats the
|
|
<code>-p</code> for completeness.</p>
|
|
<ul>
|
|
<li><strong>-p customer=string</strong><ul>
|
|
<li>Optional. <a href="https://cloud.google.com/apis/design/resource_names">Resource name</a> of the customer. If you're using this API for your own organization, use <code>customers/my_customer</code> If you're using this API to manage another organization, use <code>customers/{customer}</code>, where customer is the customer to whom the device belongs.</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
<h1 id="optional-general-properties">Optional General Properties</h1>
|
|
<p>The following properties can configure any call, and are not specific to this method.</p>
|
|
<ul>
|
|
<li>
|
|
<p><strong>-p $-xgafv=string</strong></p>
|
|
<ul>
|
|
<li>V1 error format.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p access-token=string</strong></p>
|
|
<ul>
|
|
<li>OAuth access token.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p alt=string</strong></p>
|
|
<ul>
|
|
<li>Data format for response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p callback=string</strong></p>
|
|
<ul>
|
|
<li>JSONP</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p fields=string</strong></p>
|
|
<ul>
|
|
<li>Selector specifying which fields to include in a partial response.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p key=string</strong></p>
|
|
<ul>
|
|
<li>API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p oauth-token=string</strong></p>
|
|
<ul>
|
|
<li>OAuth 2.0 token for the current user.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p pretty-print=boolean</strong></p>
|
|
<ul>
|
|
<li>Returns response with indentations and line breaks.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p quota-user=string</strong></p>
|
|
<ul>
|
|
<li>Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-type=string</strong></p>
|
|
<ul>
|
|
<li>Legacy upload protocol for media (e.g. "media", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
<li>
|
|
<p><strong>-p upload-protocol=string</strong></p>
|
|
<ul>
|
|
<li>Upload protocol for media (e.g. "raw", "multipart").</li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
|
|
</div>
|
|
</div>
|
|
<footer>
|
|
|
|
<div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
|
|
|
|
<a href="../devices_delete" class="btn btn-neutral float-right" title="Delete"/>Next <span class="icon icon-circle-arrow-right"></span></a>
|
|
|
|
|
|
<a href="../devices_cancel-wipe" class="btn btn-neutral" title="Cancel Wipe"><span class="icon icon-circle-arrow-left"></span> Previous</a>
|
|
|
|
</div>
|
|
|
|
|
|
<hr/>
|
|
|
|
<div role="contentinfo">
|
|
<p>
|
|
<!-- Copyright etc -->
|
|
</p>
|
|
</div>
|
|
|
|
Built with <a href="http://www.mkdocs.org">MkDocs</a>, using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>.
|
|
</footer>
|
|
|
|
</div>
|
|
</div>
|
|
|
|
</section>
|
|
|
|
</div>
|
|
|
|
<div class="rst-versions" role="note" style="cursor: pointer">
|
|
<span class="rst-current-version" data-toggle="rst-current-version">
|
|
|
|
<a class="icon icon-github" style="float: left; color: #fcfcfc"> GitHub</a>
|
|
|
|
<span><a href="../devices_cancel-wipe" style="color: #fcfcfc;">« Previous</a></span>
|
|
<span style="margin-left: 15px"><a href="../devices_delete" style="color: #fcfcfc">Next »</a></span>
|
|
</span>
|
|
</div>
|
|
</body>
|
|
</html> |