Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.WorkDocs.CreateUser

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

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

data CreateUser = CreateUser' {
- authenticationToken :: Maybe (Sensitive Text)
- emailAddress :: Maybe (Sensitive Text)
- organizationId :: Maybe Text
- storageRule :: Maybe StorageRuleType
- timeZoneId :: Maybe Text
- username :: Text
- givenName :: Text
- surname :: Text
- password :: Sensitive Text
}
newCreateUser :: Text -> Text -> Text -> Text -> CreateUser
createUser_authenticationToken :: Lens' CreateUser (Maybe Text)
createUser_emailAddress :: Lens' CreateUser (Maybe Text)
createUser_organizationId :: Lens' CreateUser (Maybe Text)
createUser_storageRule :: Lens' CreateUser (Maybe StorageRuleType)
createUser_timeZoneId :: Lens' CreateUser (Maybe Text)
createUser_username :: Lens' CreateUser Text
createUser_givenName :: Lens' CreateUser Text
createUser_surname :: Lens' CreateUser Text
createUser_password :: Lens' CreateUser Text
data CreateUserResponse = CreateUserResponse' {
- user :: Maybe User
- httpStatus :: Int
}
newCreateUserResponse :: Int -> CreateUserResponse
createUserResponse_user :: Lens' CreateUserResponse (Maybe User)
createUserResponse_httpStatus :: Lens' CreateUserResponse Int

Creating a Request

data CreateUser Source #

See: newCreateUser smart constructor.

Constructors

CreateUser'

Fields

authenticationToken :: Maybe (Sensitive Text)
Amazon WorkDocs authentication token. Not required when using AWS administrator credentials to access the API.
emailAddress :: Maybe (Sensitive Text)
The email address of the user.
organizationId :: Maybe Text
The ID of the organization.
storageRule :: Maybe StorageRuleType
The amount of storage for the user.
timeZoneId :: Maybe Text
The time zone ID of the user.
username :: Text
The login name of the user.
givenName :: Text
The given name of the user.
surname :: Text
The surname of the user.
password :: Sensitive Text
The password of the user.

Instances

Instances details

ToJSON CreateUser Source #
Instance details Defined in Amazonka.WorkDocs.CreateUser Methods toJSON :: CreateUser -> Value # toEncoding :: CreateUser -> Encoding # toJSONList :: [CreateUser] -> Value # toEncodingList :: [CreateUser] -> Encoding #
ToHeaders CreateUser Source #
Instance details Defined in Amazonka.WorkDocs.CreateUser Methods toHeaders :: CreateUser -> [Header] #
ToPath CreateUser Source #
Instance details Defined in Amazonka.WorkDocs.CreateUser Methods toPath :: CreateUser -> ByteString #
ToQuery CreateUser Source #
Instance details Defined in Amazonka.WorkDocs.CreateUser Methods toQuery :: CreateUser -> QueryString #
AWSRequest CreateUser Source #
Instance details Defined in Amazonka.WorkDocs.CreateUser Associated Types type AWSResponse CreateUser # Methods request :: (Service -> Service) -> CreateUser -> Request CreateUser # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateUser -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateUser))) #
Generic CreateUser Source #
Instance details Defined in Amazonka.WorkDocs.CreateUser Associated Types type Rep CreateUser :: Type -> Type # Methods from :: CreateUser -> Rep CreateUser x # to :: Rep CreateUser x -> CreateUser #
Show CreateUser Source #
Instance details Defined in Amazonka.WorkDocs.CreateUser Methods showsPrec :: Int -> CreateUser -> ShowS # show :: CreateUser -> String # showList :: [CreateUser] -> ShowS #
NFData CreateUser Source #
Instance details Defined in Amazonka.WorkDocs.CreateUser Methods rnf :: CreateUser -> () #
Eq CreateUser Source #
Instance details Defined in Amazonka.WorkDocs.CreateUser Methods (==) :: CreateUser -> CreateUser -> Bool # (/=) :: CreateUser -> CreateUser -> Bool #
Hashable CreateUser Source #
Instance details Defined in Amazonka.WorkDocs.CreateUser Methods hashWithSalt :: Int -> CreateUser -> Int # hash :: CreateUser -> Int #
type AWSResponse CreateUser Source #
Instance details Defined in Amazonka.WorkDocs.CreateUser type AWSResponse CreateUser = CreateUserResponse
type Rep CreateUser Source #
Instance details Defined in Amazonka.WorkDocs.CreateUser type Rep CreateUser = D1 ('MetaData "CreateUser" "Amazonka.WorkDocs.CreateUser" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" 'False) (C1 ('MetaCons "CreateUser'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "authenticationToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text))) :: S1 ('MetaSel ('Just "emailAddress") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (Sensitive Text)))) :: (S1 ('MetaSel ('Just "organizationId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "storageRule") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StorageRuleType)))) :: ((S1 ('MetaSel ('Just "timeZoneId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "username") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)) :: (S1 ('MetaSel ('Just "givenName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: (S1 ('MetaSel ('Just "surname") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :: S1 ('MetaSel ('Just "password") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Sensitive Text)))))))

newCreateUser Source #

Arguments

:: Text	`CreateUser`
-> Text	`CreateUser`
-> Text	`CreateUser`
-> Text	`$sel:password:CreateUser'`
-> CreateUser

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.

CreateUser, createUser_emailAddress - The email address of the user.

CreateUser, createUser_organizationId - The ID of the organization.

CreateUser, createUser_storageRule - The amount of storage for the user.

CreateUser, createUser_timeZoneId - The time zone ID of the user.

CreateUser, createUser_username - The login name of the user.

CreateUser, createUser_givenName - The given name of the user.

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_emailAddress :: Lens' CreateUser (Maybe Text) Source #

The email address of the user.

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

The ID of the organization.

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

The amount of storage for the user.

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

The time zone ID of the user.

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 user :: Maybe User The user information. httpStatus :: Int The response's http status code.

Instances

Instances details

Generic CreateUserResponse Source #
Instance details Defined in Amazonka.WorkDocs.CreateUser Associated Types type Rep CreateUserResponse :: Type -> Type # Methods from :: CreateUserResponse -> Rep CreateUserResponse x # to :: Rep CreateUserResponse x -> CreateUserResponse #
Show CreateUserResponse Source #
Instance details Defined in Amazonka.WorkDocs.CreateUser Methods showsPrec :: Int -> CreateUserResponse -> ShowS # show :: CreateUserResponse -> String # showList :: [CreateUserResponse] -> ShowS #
NFData CreateUserResponse Source #
Instance details Defined in Amazonka.WorkDocs.CreateUser Methods rnf :: CreateUserResponse -> () #
Eq CreateUserResponse Source #
Instance details Defined in Amazonka.WorkDocs.CreateUser Methods (==) :: CreateUserResponse -> CreateUserResponse -> Bool # (/=) :: CreateUserResponse -> CreateUserResponse -> Bool #
type Rep CreateUserResponse Source #
Instance details Defined in Amazonka.WorkDocs.CreateUser type Rep CreateUserResponse = D1 ('MetaData "CreateUserResponse" "Amazonka.WorkDocs.CreateUser" "amazonka-workdocs-2.0-2rElYnFvcad3yrUkWYMHCU" '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 #

Arguments

:: Int	`$sel:httpStatus:CreateUserResponse'`
-> CreateUserResponse

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

createUserResponse_user :: Lens' CreateUserResponse (Maybe User) Source #

The user information.

createUserResponse_httpStatus :: Lens' CreateUserResponse Int Source #

The response's http status code.