GoogleApi.Admin.Directory_v1.Api.Users.directory_users_update

You're seeing just the function directory_users_update, go back to GoogleApi.Admin.Directory_v1.Api.Users module for more information.
Link to this function

directory_users_update(connection, user_key, optional_params \\ [], opts \\ [])

View Source

Specs

directory_users_update(Tesla.Env.client(), String.t(), keyword(), keyword()) ::
  {:ok, GoogleApi.Admin.Directory_v1.Model.User.t()}
  | {:ok, Tesla.Env.t()}
  | {:ok, list()}
  | {:error, any()}

Updates a user. This method supports patch semantics, meaning you only need to include the fields you wish to update. Fields that are not present in the request will be preserved, and fields set to null will be cleared.

Parameters

  • connection (type: GoogleApi.Admin.Directory_v1.Connection.t) - Connection to server
  • user_key (type: String.t) - Identifies the user in the API request. The value can be the user's primary email address, alias email address, or unique user 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.User.t) -
  • opts (type: keyword()) - Call options

Returns

  • {:ok, %GoogleApi.Admin.Directory_v1.Model.User{}} on success
  • {:error, info} on failure