| 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.IdentityStore.Types.User
Description
Synopsis
- data User = User' {
- addresses :: Maybe (NonEmpty Address)
- displayName :: Maybe (Sensitive Text)
- emails :: Maybe (NonEmpty Email)
- externalIds :: Maybe (NonEmpty ExternalId)
- locale :: Maybe (Sensitive Text)
- name :: Maybe Name
- nickName :: Maybe (Sensitive Text)
- phoneNumbers :: Maybe (NonEmpty PhoneNumber)
- preferredLanguage :: Maybe (Sensitive Text)
- profileUrl :: Maybe (Sensitive Text)
- timezone :: Maybe (Sensitive Text)
- title :: Maybe (Sensitive Text)
- userName :: Maybe (Sensitive Text)
- userType :: Maybe (Sensitive Text)
- userId :: Text
- identityStoreId :: Text
- newUser :: Text -> Text -> User
- user_addresses :: Lens' User (Maybe (NonEmpty Address))
- user_displayName :: Lens' User (Maybe Text)
- user_emails :: Lens' User (Maybe (NonEmpty Email))
- user_externalIds :: Lens' User (Maybe (NonEmpty ExternalId))
- user_locale :: Lens' User (Maybe Text)
- user_name :: Lens' User (Maybe Name)
- user_nickName :: Lens' User (Maybe Text)
- user_phoneNumbers :: Lens' User (Maybe (NonEmpty PhoneNumber))
- user_preferredLanguage :: Lens' User (Maybe Text)
- user_profileUrl :: Lens' User (Maybe Text)
- user_timezone :: Lens' User (Maybe Text)
- user_title :: Lens' User (Maybe Text)
- user_userName :: Lens' User (Maybe Text)
- user_userType :: Lens' User (Maybe Text)
- user_userId :: Lens' User Text
- user_identityStoreId :: Lens' User Text
Documentation
A user object that contains a specified user’s metadata and attributes.
See: newUser smart constructor.
Constructors
| User' | |
Fields
| |
Instances
Create a value of User 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:addresses:User', user_addresses - A list of Address objects containing addresses associated with the
user.
$sel:displayName:User', user_displayName - A string containing the user's name that's formatted for display when
the user is referenced. For example, "John Doe."
$sel:emails:User', user_emails - A list of Email objects containing email addresses associated with the
user.
$sel:externalIds:User', user_externalIds - A list of ExternalId objects that contains the identifiers issued to
this resource by an external identity provider.
$sel:locale:User', user_locale - A string containing the user's geographical region or location.
$sel:name:User', user_name - An object containing the user's name.
$sel:nickName:User', user_nickName - A string containing an alternate name for the user.
$sel:phoneNumbers:User', user_phoneNumbers - A list of PhoneNumber objects containing phone numbers associated with
the user.
$sel:preferredLanguage:User', user_preferredLanguage - A string containing the preferred language of the user. For example,
"American English" or "en-us."
$sel:profileUrl:User', user_profileUrl - A string containing a URL that may be associated with the user.
$sel:timezone:User', user_timezone - A string containing the user's time zone.
$sel:title:User', user_title - A string containing the user's title. Possible values depend on each
customer's specific needs, so they are left unspecified.
$sel:userName:User', user_userName - A unique string used to identify the user. The length limit is 128
characters. This value can consist of letters, accented characters,
symbols, numbers, and punctuation. This value is specified at the time
the user is created and stored as an attribute of the user object in the
identity store.
$sel:userType:User', user_userType - A string indicating the user's type. Possible values depend on each
customer's specific needs, so they are left unspecified.
$sel:userId:User', user_userId - The identifier for a user in the identity store.
$sel:identityStoreId:User', user_identityStoreId - The globally unique identifier for the identity store.
user_addresses :: Lens' User (Maybe (NonEmpty Address)) Source #
A list of Address objects containing addresses associated with the
user.
user_displayName :: Lens' User (Maybe Text) Source #
A string containing the user's name that's formatted for display when the user is referenced. For example, "John Doe."
user_emails :: Lens' User (Maybe (NonEmpty Email)) Source #
A list of Email objects containing email addresses associated with the
user.
user_externalIds :: Lens' User (Maybe (NonEmpty ExternalId)) Source #
A list of ExternalId objects that contains the identifiers issued to
this resource by an external identity provider.
user_locale :: Lens' User (Maybe Text) Source #
A string containing the user's geographical region or location.
user_nickName :: Lens' User (Maybe Text) Source #
A string containing an alternate name for the user.
user_phoneNumbers :: Lens' User (Maybe (NonEmpty PhoneNumber)) Source #
A list of PhoneNumber objects containing phone numbers associated with
the user.
user_preferredLanguage :: Lens' User (Maybe Text) Source #
A string containing the preferred language of the user. For example, "American English" or "en-us."
user_profileUrl :: Lens' User (Maybe Text) Source #
A string containing a URL that may be associated with the user.
user_title :: Lens' User (Maybe Text) Source #
A string containing the user's title. Possible values depend on each customer's specific needs, so they are left unspecified.
user_userName :: Lens' User (Maybe Text) Source #
A unique string used to identify the user. The length limit is 128 characters. This value can consist of letters, accented characters, symbols, numbers, and punctuation. This value is specified at the time the user is created and stored as an attribute of the user object in the identity store.