GoogleApi.CloudIdentity.V1.Api.Devices.cloudidentity_devices_device_users_client_states_get
You're seeing just the function
cloudidentity_devices_device_users_client_states_get
, go back to GoogleApi.CloudIdentity.V1.Api.Devices module for more information.
Link to this function
cloudidentity_devices_device_users_client_states_get(connection, name, optional_params \\ [], opts \\ [])
View SourceSpecs
cloudidentity_devices_device_users_client_states_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.CloudIdentity.V1.Model.GoogleAppsCloudidentityDevicesV1ClientState.t()} | {:ok, Tesla.Env.t()} | {:ok, list()} | {:error, any()}
Gets the client state for the device user
Parameters
-
connection
(type:GoogleApi.CloudIdentity.V1.Connection.t
) - Connection to server -
name
(type:String.t
) - Required. Resource name of the ClientState in format:devices/{device_id}/deviceUsers/{device_user_id}/clientStates/{partner_id}
, wheredevice_id
is the unique ID assigned to the Device,device_user_id
is the unique ID assigned to the User andpartner_id
identifies the partner storing the data. To get the client state for devices belonging to your own organization, thepartnerId
is in the format:customerId-*anystring*
. Where thecustomerId
is your organization's customer ID andanystring
is any suffix. This suffix is used in setting up Custom Access Levels in Context-Aware Access. You may usemy_customer
instead of the customer ID for devices managed by your own organization. You may specify-
in place of the{device_id}
, so the ClientState resource name can be:devices/-/deviceUsers/{device_user_resource_id}/clientStates/{partner_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"). -
:customer
(type:String.t
) - Optional. Resource name of the customer. If you're using this API for your own organization, usecustomers/my_customer
If you're using this API to manage another organization, usecustomers/{customer_id}
, where customer_id is the customer to whom the device belongs.
-
-
opts
(type:keyword()
) - Call options
Returns
-
{:ok, %GoogleApi.CloudIdentity.V1.Model.GoogleAppsCloudidentityDevicesV1ClientState{}}
on success -
{:error, info}
on failure