Method: Aws::WorkDocs::Client#update_user

Defined in:

lib/aws-sdk-workdocs/client.rb

#update_user(params = {}) ⇒ Types::UpdateUserResponse

Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.

Examples:

Request syntax with placeholder values

resp = client.update_user({
  authentication_token: "AuthenticationHeaderType",
  user_id: "IdType", # required
  given_name: "UserAttributeValueType",
  surname: "UserAttributeValueType",
  type: "USER", # accepts USER, ADMIN, POWERUSER, MINIMALUSER, WORKSPACESUSER
  storage_rule: {
    storage_allocated_in_bytes: 1,
    storage_type: "UNLIMITED", # accepts UNLIMITED, QUOTA
  },
  time_zone_id: "TimeZoneIdType",
  locale: "en", # accepts en, fr, ko, de, es, ja, ru, zh_CN, zh_TW, pt_BR, default
  grant_poweruser_privileges: "TRUE", # accepts TRUE, FALSE
})

Response structure

resp.user.id #=> String
resp.user.username #=> String
resp.user.email_address #=> String
resp.user.given_name #=> String
resp.user.surname #=> String
resp.user.organization_id #=> String
resp.user.root_folder_id #=> String
resp.user.recycle_bin_folder_id #=> String
resp.user.status #=> String, one of "ACTIVE", "INACTIVE", "PENDING"
resp.user.type #=> String, one of "USER", "ADMIN", "POWERUSER", "MINIMALUSER", "WORKSPACESUSER"
resp.user.created_timestamp #=> Time
resp.user.modified_timestamp #=> Time
resp.user.time_zone_id #=> String
resp.user.locale #=> String, one of "en", "fr", "ko", "de", "es", "ja", "ru", "zh_CN", "zh_TW", "pt_BR", "default"
resp.user.storage.storage_utilized_in_bytes #=> Integer
resp.user.storage.storage_rule.storage_allocated_in_bytes #=> Integer
resp.user.storage.storage_rule.storage_type #=> String, one of "UNLIMITED", "QUOTA"

Parameters:

• params (Hash) (defaults to: {}) —

  ({})

Options Hash (params):

• :authentication_token (String) —

  Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

• :user_id (required, String) —

  The ID of the user.

• :given_name (String) —

  The given name of the user.

• :surname (String) —

  The surname of the user.

• :type (String) —

  The type of the user.

• :storage_rule (Types::StorageRuleType) —

  The amount of storage for the user.

• :time_zone_id (String) —

  The time zone ID of the user.

• :locale (String) —

  The locale of the user.

• :grant_poweruser_privileges (String) —

  Boolean value to determine whether the user is granted Poweruser privileges.

Returns:

• (Types::UpdateUserResponse) —

  Returns a response object which responds to the following methods:

  • #user => Types::User

See Also:

• AWS API Documentation

# File 'lib/aws-sdk-workdocs/client.rb', line 2561

def update_user(params = {}, options = {})
  req = build_request(:update_user, params)
  req.send_request(options)
end