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 |
Provides information regarding the user.
Synopsis
- data DescribeUser = DescribeUser' {
- organizationId :: Text
- userId :: Text
- newDescribeUser :: Text -> Text -> DescribeUser
- describeUser_organizationId :: Lens' DescribeUser Text
- describeUser_userId :: Lens' DescribeUser Text
- data DescribeUserResponse = DescribeUserResponse' {}
- newDescribeUserResponse :: Int -> DescribeUserResponse
- describeUserResponse_disabledDate :: Lens' DescribeUserResponse (Maybe UTCTime)
- describeUserResponse_displayName :: Lens' DescribeUserResponse (Maybe Text)
- describeUserResponse_email :: Lens' DescribeUserResponse (Maybe Text)
- describeUserResponse_enabledDate :: Lens' DescribeUserResponse (Maybe UTCTime)
- describeUserResponse_name :: Lens' DescribeUserResponse (Maybe Text)
- describeUserResponse_state :: Lens' DescribeUserResponse (Maybe EntityState)
- describeUserResponse_userId :: Lens' DescribeUserResponse (Maybe Text)
- describeUserResponse_userRole :: Lens' DescribeUserResponse (Maybe UserRole)
- describeUserResponse_httpStatus :: Lens' DescribeUserResponse Int
Creating a Request
data DescribeUser Source #
See: newDescribeUser
smart constructor.
DescribeUser' | |
|
Instances
Create a value of DescribeUser
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:
DescribeUser
, describeUser_organizationId
- The identifier for the organization under which the user exists.
DescribeUser
, describeUser_userId
- The identifier for the user to be described.
Request Lenses
describeUser_organizationId :: Lens' DescribeUser Text Source #
The identifier for the organization under which the user exists.
describeUser_userId :: Lens' DescribeUser Text Source #
The identifier for the user to be described.
Destructuring the Response
data DescribeUserResponse Source #
See: newDescribeUserResponse
smart constructor.
DescribeUserResponse' | |
|
Instances
newDescribeUserResponse Source #
Create a value of DescribeUserResponse
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:
DescribeUserResponse
, describeUserResponse_disabledDate
- The date and time at which the user was disabled for WorkMail usage, in
UNIX epoch time format.
DescribeUserResponse
, describeUserResponse_displayName
- The display name of the user.
DescribeUserResponse
, describeUserResponse_email
- The email of the user.
DescribeUserResponse
, describeUserResponse_enabledDate
- The date and time at which the user was enabled for WorkMailusage, in
UNIX epoch time format.
DescribeUserResponse
, describeUserResponse_name
- The name for the user.
DescribeUserResponse
, describeUserResponse_state
- The state of a user: enabled (registered to WorkMail) or disabled
(deregistered or never registered to WorkMail).
DescribeUser
, describeUserResponse_userId
- The identifier for the described user.
DescribeUserResponse
, describeUserResponse_userRole
- In certain cases, other entities are modeled as users. If
interoperability is enabled, resources are imported into WorkMail as
users. Because different WorkMail organizations rely on different
directory types, administrators can distinguish between an unregistered
user (account is disabled and has a user role) and the directory
administrators. The values are USER, RESOURCE, and SYSTEM_USER.
$sel:httpStatus:DescribeUserResponse'
, describeUserResponse_httpStatus
- The response's http status code.
Response Lenses
describeUserResponse_disabledDate :: Lens' DescribeUserResponse (Maybe UTCTime) Source #
The date and time at which the user was disabled for WorkMail usage, in UNIX epoch time format.
describeUserResponse_displayName :: Lens' DescribeUserResponse (Maybe Text) Source #
The display name of the user.
describeUserResponse_email :: Lens' DescribeUserResponse (Maybe Text) Source #
The email of the user.
describeUserResponse_enabledDate :: Lens' DescribeUserResponse (Maybe UTCTime) Source #
The date and time at which the user was enabled for WorkMailusage, in UNIX epoch time format.
describeUserResponse_name :: Lens' DescribeUserResponse (Maybe Text) Source #
The name for the user.
describeUserResponse_state :: Lens' DescribeUserResponse (Maybe EntityState) Source #
The state of a user: enabled (registered to WorkMail) or disabled (deregistered or never registered to WorkMail).
describeUserResponse_userId :: Lens' DescribeUserResponse (Maybe Text) Source #
The identifier for the described user.
describeUserResponse_userRole :: Lens' DescribeUserResponse (Maybe UserRole) Source #
In certain cases, other entities are modeled as users. If interoperability is enabled, resources are imported into WorkMail as users. Because different WorkMail organizations rely on different directory types, administrators can distinguish between an unregistered user (account is disabled and has a user role) and the directory administrators. The values are USER, RESOURCE, and SYSTEM_USER.
describeUserResponse_httpStatus :: Lens' DescribeUserResponse Int Source #
The response's http status code.