View Source GoogleApi.Admin.Directory_v1.Api.Chromeosdevices (google_api_admin v0.40.0)
API calls for all endpoints tagged Chromeosdevices
.
Summary
Functions
Use BatchChangeChromeOsDeviceStatus instead. Takes an action that affects a Chrome OS Device. This includes deprovisioning, disabling, and re-enabling devices. Warning: Deprovisioning a device will stop device policy syncing and remove device-level printers. After a device is deprovisioned, it must be wiped before it can be re-enrolled. Lost or stolen devices should use the disable action. * Re-enabling a disabled device will consume a device license. If you do not have sufficient licenses available when completing the re-enable action, you will receive an error. For more information about deprovisioning and disabling devices, visit the help center.
Retrieves a Chrome OS device's properties.
Retrieves a paginated list of Chrome OS devices within an account.
Moves or inserts multiple Chrome OS devices to an organizational unit. You can move up to 50 devices at once.
Updates a device's updatable properties, such as annotatedUser
, annotatedLocation
, notes
, orgUnitPath
, or annotatedAssetId
. This method supports patch semantics.
Updates a device's updatable properties, such as annotatedUser
, annotatedLocation
, notes
, orgUnitPath
, or annotatedAssetId
.
Functions
directory_chromeosdevices_action(connection, customer_id, resource_id, optional_params \\ [], opts \\ [])
View Source@spec directory_chromeosdevices_action( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Use BatchChangeChromeOsDeviceStatus instead. Takes an action that affects a Chrome OS Device. This includes deprovisioning, disabling, and re-enabling devices. Warning: Deprovisioning a device will stop device policy syncing and remove device-level printers. After a device is deprovisioned, it must be wiped before it can be re-enrolled. Lost or stolen devices should use the disable action. * Re-enabling a disabled device will consume a device license. If you do not have sufficient licenses available when completing the re-enable action, you will receive an error. For more information about deprovisioning and disabling devices, visit the help center.
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer_id
(type:String.t
) - The unique ID for the customer's Google Workspace account. As an account administrator, you can also use themy_customer
alias to represent your account'scustomerId
. ThecustomerId
is also returned as part of the Users resource. -
resource_id
(type:String.t
) - The unique ID of the device. TheresourceId
s are returned in the response from the chromeosdevices.list method. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Admin.Directory_v1.Model.ChromeOsDeviceAction.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %{}}
on success -
{:error, info}
on failure
directory_chromeosdevices_get(connection, customer_id, device_id, optional_params \\ [], opts \\ [])
View Source@spec directory_chromeosdevices_get( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.ChromeOsDevice.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves a Chrome OS device's properties.
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer_id
(type:String.t
) - The unique ID for the customer's Google Workspace account. As an account administrator, you can also use themy_customer
alias to represent your account'scustomerId
. ThecustomerId
is also returned as part of the Users resource. -
device_id
(type:String.t
) - The unique ID of the device. ThedeviceId
s are returned in the response from the chromeosdevices.list method. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:projection
(type:String.t
) - Determines whether the response contains the full list of properties or only a subset.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Admin.Directory_v1.Model.ChromeOsDevice{}}
on success -
{:error, info}
on failure
directory_chromeosdevices_list(connection, customer_id, optional_params \\ [], opts \\ [])
View Source@spec directory_chromeosdevices_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.ChromeOsDevices.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Retrieves a paginated list of Chrome OS devices within an account.
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer_id
(type:String.t
) - The unique ID for the customer's Google Workspace account. As an account administrator, you can also use themy_customer
alias to represent your account'scustomerId
. ThecustomerId
is also returned as part of the Users resource. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:includeChildOrgunits
(type:boolean()
) - Return devices from all child orgunits, as well as the specified org unit. If this is set to true, 'orgUnitPath' must be provided. -
:maxResults
(type:integer()
) - Maximum number of results to return. -
:orderBy
(type:String.t
) - Device property to use for sorting results. -
:orgUnitPath
(type:String.t
) - The full path of the organizational unit (minus the leading/
) or its unique ID. -
:pageToken
(type:String.t
) - ThepageToken
query parameter is used to request the next page of query results. The follow-on request'spageToken
query parameter is thenextPageToken
from your previous response. -
:projection
(type:String.t
) - Restrict information returned to a set of selected fields. -
:query
(type:String.t
) - Search string in the format given at https://developers.google.com/admin-sdk/directory/v1/list-query-operators -
:sortOrder
(type:String.t
) - Whether to return results in ascending or descending order. Must be used with theorderBy
parameter.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Admin.Directory_v1.Model.ChromeOsDevices{}}
on success -
{:error, info}
on failure
directory_chromeosdevices_move_devices_to_ou(connection, customer_id, org_unit_path, optional_params \\ [], opts \\ [])
View Source@spec directory_chromeosdevices_move_devices_to_ou( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Moves or inserts multiple Chrome OS devices to an organizational unit. You can move up to 50 devices at once.
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer_id
(type:String.t
) - Immutable. ID of the Google Workspace account -
org_unit_path
(type:String.t
) - Full path of the target organizational unit or its ID -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:body
(type:GoogleApi.Admin.Directory_v1.Model.ChromeOsMoveDevicesToOu.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %{}}
on success -
{:error, info}
on failure
directory_chromeosdevices_patch(connection, customer_id, device_id, optional_params \\ [], opts \\ [])
View Source@spec directory_chromeosdevices_patch( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.ChromeOsDevice.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates a device's updatable properties, such as annotatedUser
, annotatedLocation
, notes
, orgUnitPath
, or annotatedAssetId
. This method supports patch semantics.
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer_id
(type:String.t
) - The unique ID for the customer's Google Workspace account. As an account administrator, you can also use themy_customer
alias to represent your account'scustomerId
. ThecustomerId
is also returned as part of the Users resource. -
device_id
(type:String.t
) - The unique ID of the device. ThedeviceId
s are returned in the response from the chromeosdevices.list method. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:projection
(type:String.t
) - Restrict information returned to a set of selected fields. -
:body
(type:GoogleApi.Admin.Directory_v1.Model.ChromeOsDevice.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Admin.Directory_v1.Model.ChromeOsDevice{}}
on success -
{:error, info}
on failure
directory_chromeosdevices_update(connection, customer_id, device_id, optional_params \\ [], opts \\ [])
View Source@spec directory_chromeosdevices_update( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.ChromeOsDevice.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Updates a device's updatable properties, such as annotatedUser
, annotatedLocation
, notes
, orgUnitPath
, or annotatedAssetId
.
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer_id
(type:String.t
) - The unique ID for the customer's Google Workspace account. As an account administrator, you can also use themy_customer
alias to represent your account'scustomerId
. ThecustomerId
is also returned as part of the Users resource. -
device_id
(type:String.t
) - The unique ID of the device. ThedeviceId
s are returned in the response from the chromeosdevices.list method. -
optional_params
(type:keyword()
) - Optional parameters-
:"$.xgafv"
(type:String.t
) - V1 error format. -
:access_token
(type:String.t
) - OAuth access token. -
:alt
(type:String.t
) - Data format for response. -
:callback
(type:String.t
) - JSONP -
:fields
(type:String.t
) - Selector specifying which fields to include in a partial response. -
:key
(type:String.t
) - 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. -
:oauth_token
(type:String.t
) - OAuth 2.0 token for the current user. -
:prettyPrint
(type:boolean()
) - Returns response with indentations and line breaks. -
:quotaUser
(type:String.t
) - 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. -
:uploadType
(type:String.t
) - Legacy upload protocol for media (e.g. "media", "multipart"). -
:upload_protocol
(type:String.t
) - Upload protocol for media (e.g. "raw", "multipart"). -
:projection
(type:String.t
) - Restrict information returned to a set of selected fields. -
:body
(type:GoogleApi.Admin.Directory_v1.Model.ChromeOsDevice.t
) -
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Admin.Directory_v1.Model.ChromeOsDevice{}}
on success -
{:error, info}
on failure