GoogleApi.CloudIdentity.V1.Api.Devices.cloudidentity_devices_device_users_client_states_list

You're seeing just the function cloudidentity_devices_device_users_client_states_list, go back to GoogleApi.CloudIdentity.V1.Api.Devices module for more information.
Link to this function

cloudidentity_devices_device_users_client_states_list(connection, parent, optional_params \\ [], opts \\ [])

View Source

Specs

cloudidentity_devices_device_users_client_states_list(
  Tesla.Env.client(),
  String.t(),
  keyword(),
  keyword()
) ::
  {:ok,
   GoogleApi.CloudIdentity.V1.Model.GoogleAppsCloudidentityDevicesV1ListClientStatesResponse.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Lists the client states for the given search query.

Parameters

  • connection (type: GoogleApi.CloudIdentity.V1.Connection.t) - Connection to server
  • parent (type: String.t) - Required. To list all ClientStates, set this to "devices/-/deviceUsers/-". To list all ClientStates owned by a DeviceUser, set this to the resource name of the DeviceUser. Format: devices/{device}/deviceUsers/{deviceUser}
  • 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, use customers/my_customer If you're using this API to manage another organization, use customers/{customer_id}, where customer_id is the customer to whom the device belongs.
    • :filter (type: String.t) - Optional. Additional restrictions when fetching list of client states.
    • :orderBy (type: String.t) - Optional. Order specification for client states in the response.
    • :pageToken (type: String.t) - Optional. A page token, received from a previous ListClientStates call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListClientStates must match the call that provided the page token.
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.CloudIdentity.V1.Model.GoogleAppsCloudidentityDevicesV1ListClientStatesResponse{}} on success
  • {:error, info} on failure