Skip to content

Creates a user in a Simple AD or Microsoft AD directory

Description

Creates a user in a Simple AD or Microsoft AD directory. The status of a newly created user is "ACTIVE". New users can access Amazon WorkDocs.

Usage

workdocs_create_user(OrganizationId, Username, EmailAddress, GivenName,
  Surname, Password, TimeZoneId, StorageRule, AuthenticationToken)

Arguments

  • OrganizationId

    The ID of the organization.

  • Username

    [required] The login name of the user.

  • EmailAddress

    The email address of the user.

  • GivenName

    [required] The given name of the user.

  • Surname

    [required] The surname of the user.

  • Password

    [required] The password of the user.

  • TimeZoneId

    The time zone ID of the user.

  • StorageRule

    The amount of storage for the user.

  • AuthenticationToken

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

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$create_user(
  OrganizationId = "string",
  Username = "string",
  EmailAddress = "string",
  GivenName = "string",
  Surname = "string",
  Password = "string",
  TimeZoneId = "string",
  StorageRule = list(
    StorageAllocatedInBytes = 123,
    StorageType = "UNLIMITED"|"QUOTA"
  ),
  AuthenticationToken = "string"
)