libZSservicesZSamazonka-workdocsZSamazonka-workdocs
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.WorkDocs.CreateUser

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.

Synopsis

Creating a Request

data CreateUser Source #

See: newCreateUser smart constructor.

Constructors

CreateUser' 

Fields

Instances

Instances details
Eq CreateUser Source # 
Instance details

Defined in Amazonka.WorkDocs.CreateUser

Show CreateUser Source # 
Instance details

Defined in Amazonka.WorkDocs.CreateUser

Generic CreateUser Source # 
Instance details

Defined in Amazonka.WorkDocs.CreateUser

Associated Types

type Rep CreateUser :: Type -> Type #

NFData CreateUser Source # 
Instance details

Defined in Amazonka.WorkDocs.CreateUser

Methods

rnf :: CreateUser -> () #

Hashable CreateUser Source # 
Instance details

Defined in Amazonka.WorkDocs.CreateUser

ToJSON CreateUser Source # 
Instance details

Defined in Amazonka.WorkDocs.CreateUser

AWSRequest CreateUser Source # 
Instance details

Defined in Amazonka.WorkDocs.CreateUser

Associated Types

type AWSResponse CreateUser #

ToHeaders CreateUser Source # 
Instance details

Defined in Amazonka.WorkDocs.CreateUser

Methods

toHeaders :: CreateUser -> [Header] #

ToPath CreateUser Source # 
Instance details

Defined in Amazonka.WorkDocs.CreateUser

ToQuery CreateUser Source # 
Instance details

Defined in Amazonka.WorkDocs.CreateUser

type Rep CreateUser Source # 
Instance details

Defined in Amazonka.WorkDocs.CreateUser

type AWSResponse CreateUser Source # 
Instance details

Defined in Amazonka.WorkDocs.CreateUser

newCreateUser Source #

Create a value of CreateUser with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:authenticationToken:CreateUser', createUser_authenticationToken - Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.

$sel:storageRule:CreateUser', createUser_storageRule - The amount of storage for the user.

$sel:emailAddress:CreateUser', createUser_emailAddress - The email address of the user.

$sel:timeZoneId:CreateUser', createUser_timeZoneId - The time zone ID of the user.

$sel:organizationId:CreateUser', createUser_organizationId - The ID of the organization.

$sel:username:CreateUser', createUser_username - The login name of the user.

$sel:givenName:CreateUser', createUser_givenName - The given name of the user.

$sel:surname:CreateUser', createUser_surname - The surname of the user.

$sel:password:CreateUser', createUser_password - The password of the user.

Request Lenses

createUser_authenticationToken :: Lens' CreateUser (Maybe Text) Source #

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

createUser_storageRule :: Lens' CreateUser (Maybe StorageRuleType) Source #

The amount of storage for the user.

createUser_emailAddress :: Lens' CreateUser (Maybe Text) Source #

The email address of the user.

createUser_timeZoneId :: Lens' CreateUser (Maybe Text) Source #

The time zone ID of the user.

createUser_organizationId :: Lens' CreateUser (Maybe Text) Source #

The ID of the organization.

createUser_username :: Lens' CreateUser Text Source #

The login name of the user.

createUser_givenName :: Lens' CreateUser Text Source #

The given name of the user.

createUser_surname :: Lens' CreateUser Text Source #

The surname of the user.

createUser_password :: Lens' CreateUser Text Source #

The password of the user.

Destructuring the Response

data CreateUserResponse Source #

See: newCreateUserResponse smart constructor.

Constructors

CreateUserResponse' 

Fields

Instances

Instances details
Eq CreateUserResponse Source # 
Instance details

Defined in Amazonka.WorkDocs.CreateUser

Read CreateUserResponse Source # 
Instance details

Defined in Amazonka.WorkDocs.CreateUser

Show CreateUserResponse Source # 
Instance details

Defined in Amazonka.WorkDocs.CreateUser

Generic CreateUserResponse Source # 
Instance details

Defined in Amazonka.WorkDocs.CreateUser

Associated Types

type Rep CreateUserResponse :: Type -> Type #

NFData CreateUserResponse Source # 
Instance details

Defined in Amazonka.WorkDocs.CreateUser

Methods

rnf :: CreateUserResponse -> () #

type Rep CreateUserResponse Source # 
Instance details

Defined in Amazonka.WorkDocs.CreateUser

type Rep CreateUserResponse = D1 ('MetaData "CreateUserResponse" "Amazonka.WorkDocs.CreateUser" "libZSservicesZSamazonka-workdocsZSamazonka-workdocs" 'False) (C1 ('MetaCons "CreateUserResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "user") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe User)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)))

newCreateUserResponse Source #

Create a value of CreateUserResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:user:CreateUserResponse', createUserResponse_user - The user information.

$sel:httpStatus:CreateUserResponse', createUserResponse_httpStatus - The response's http status code.

Response Lenses