Update User
workdocs_update_user | R Documentation |
Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site¶
Description¶
Updates the specified attributes of the specified user, and grants or revokes administrative privileges to the Amazon WorkDocs site.
Usage¶
workdocs_update_user(AuthenticationToken, UserId, GivenName, Surname,
Type, StorageRule, TimeZoneId, Locale, GrantPoweruserPrivileges)
Arguments¶
AuthenticationToken
Amazon WorkDocs authentication token. Not required when using Amazon Web Services administrator credentials to access the API.
UserId
[required] The ID of the user.
GivenName
The given name of the user.
Surname
The surname of the user.
Type
The type of the user.
StorageRule
The amount of storage for the user.
TimeZoneId
The time zone ID of the user.
Locale
The locale of the user.
GrantPoweruserPrivileges
Boolean value to determine whether the user is granted Power user privileges.
Value¶
A list with the following syntax:
list(
User = list(
Id = "string",
Username = "string",
EmailAddress = "string",
GivenName = "string",
Surname = "string",
OrganizationId = "string",
RootFolderId = "string",
RecycleBinFolderId = "string",
Status = "ACTIVE"|"INACTIVE"|"PENDING",
Type = "USER"|"ADMIN"|"POWERUSER"|"MINIMALUSER"|"WORKSPACESUSER",
CreatedTimestamp = as.POSIXct(
"2015-01-01"
),
ModifiedTimestamp = as.POSIXct(
"2015-01-01"
),
TimeZoneId = "string",
Locale = "en"|"fr"|"ko"|"de"|"es"|"ja"|"ru"|"zh_CN"|"zh_TW"|"pt_BR"|"default",
Storage = list(
StorageUtilizedInBytes = 123,
StorageRule = list(
StorageAllocatedInBytes = 123,
StorageType = "UNLIMITED"|"QUOTA"
)
)
)
)
Request syntax¶
svc$update_user(
AuthenticationToken = "string",
UserId = "string",
GivenName = "string",
Surname = "string",
Type = "USER"|"ADMIN"|"POWERUSER"|"MINIMALUSER"|"WORKSPACESUSER",
StorageRule = list(
StorageAllocatedInBytes = 123,
StorageType = "UNLIMITED"|"QUOTA"
),
TimeZoneId = "string",
Locale = "en"|"fr"|"ko"|"de"|"es"|"ja"|"ru"|"zh_CN"|"zh_TW"|"pt_BR"|"default",
GrantPoweruserPrivileges = "TRUE"|"FALSE"
)