google_api_admin v0.21.0 GoogleApi.Admin.Directory_v1.Api.Chromeosdevices View Source
API calls for all endpoints tagged Chromeosdevices
.
Link to this section Summary
Functions
Take action on Chrome OS Device
directory_chromeosdevices_get(connection, customer_id, device_id, optional_params \\ [], opts \\ [])
Retrieve Chrome OS Device
Retrieve all Chrome OS Devices of a customer (paginated)
Move or insert multiple Chrome OS Devices to organizational unit
Patch Chrome OS Device
Link to this section Functions
Link to this function
directory_chromeosdevices_action(connection, customer_id, resource_id, optional_params \\ [], opts \\ [])
View SourceSpecs
directory_chromeosdevices_action( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, any()}
Take action on Chrome OS Device
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer_id
(type:String.t
) - Immutable ID of the G Suite account -
resource_id
(type:String.t
) - Immutable ID of Chrome OS Device -
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
Link to this function
directory_chromeosdevices_get(connection, customer_id, device_id, optional_params \\ [], opts \\ [])
View SourceSpecs
directory_chromeosdevices_get( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.ChromeOsDevice.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Retrieve Chrome OS Device
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer_id
(type:String.t
) - Immutable ID of the G Suite account -
device_id
(type:String.t
) - Immutable ID of Chrome OS Device -
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.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Admin.Directory_v1.Model.ChromeOsDevice{}}
on success -
{:error, info}
on failure
Link to this function
directory_chromeosdevices_list(connection, customer_id, optional_params \\ [], opts \\ [])
View SourceSpecs
directory_chromeosdevices_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.ChromeOsDevices.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Retrieve all Chrome OS Devices of a customer (paginated)
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer_id
(type:String.t
) - Immutable ID of the G Suite account -
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"). -
:maxResults
(type:integer()
) - Maximum number of results to return. -
:orderBy
(type:String.t
) - Column to use for sorting results -
:orgUnitPath
(type:String.t
) - Full path of the organizational unit or its ID -
:pageToken
(type:String.t
) - Token to specify next page in the list -
:projection
(type:String.t
) - Restrict information returned to a set of selected fields. -
:query
(type:String.t
) - Search string in the format given at http://support.google.com/chromeos/a/bin/answer.py?answer=1698333 -
:sortOrder
(type:String.t
) - Whether to return results in ascending or descending order. Only of use when orderBy is also used
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.Admin.Directory_v1.Model.ChromeOsDevices{}}
on success -
{:error, info}
on failure
Link to this function
directory_chromeosdevices_move_devices_to_ou(connection, customer_id, org_unit_path, optional_params \\ [], opts \\ [])
View SourceSpecs
directory_chromeosdevices_move_devices_to_ou( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, nil} | {:ok, Tesla.Env.t()} | {:error, any()}
Move or insert multiple Chrome OS Devices to organizational unit
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer_id
(type:String.t
) - Immutable ID of the G Suite 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
Link to this function
directory_chromeosdevices_patch(connection, customer_id, device_id, optional_params \\ [], opts \\ [])
View SourceSpecs
directory_chromeosdevices_patch( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.ChromeOsDevice.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Patch Chrome OS Device
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer_id
(type:String.t
) - Immutable ID of the G Suite account -
device_id
(type:String.t
) - Immutable ID of Chrome OS Device -
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
Link to this function
directory_chromeosdevices_update(connection, customer_id, device_id, optional_params \\ [], opts \\ [])
View SourceSpecs
directory_chromeosdevices_update( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Admin.Directory_v1.Model.ChromeOsDevice.t()} | {:ok, Tesla.Env.t()} | {:error, any()}
Update Chrome OS Device
Parameters
-
connection
(type:GoogleApi.Admin.Directory_v1.Connection.t
) - Connection to server -
customer_id
(type:String.t
) - Immutable ID of the G Suite account -
device_id
(type:String.t
) - Immutable ID of Chrome OS Device -
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