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 |
Synopsis
- data User = User' {
- apiAccess :: Maybe ApiAccess
- apiAccessPrincipalArn :: Maybe Text
- createTime :: Maybe Integer
- emailAddress :: Maybe (Sensitive Text)
- firstName :: Maybe (Sensitive Text)
- lastDisabledTime :: Maybe Integer
- lastEnabledTime :: Maybe Integer
- lastLoginTime :: Maybe Integer
- lastModifiedTime :: Maybe Integer
- lastName :: Maybe (Sensitive Text)
- status :: Maybe UserStatus
- type' :: Maybe UserType
- userId :: Maybe Text
- newUser :: User
- user_apiAccess :: Lens' User (Maybe ApiAccess)
- user_apiAccessPrincipalArn :: Lens' User (Maybe Text)
- user_createTime :: Lens' User (Maybe Integer)
- user_emailAddress :: Lens' User (Maybe Text)
- user_firstName :: Lens' User (Maybe Text)
- user_lastDisabledTime :: Lens' User (Maybe Integer)
- user_lastEnabledTime :: Lens' User (Maybe Integer)
- user_lastLoginTime :: Lens' User (Maybe Integer)
- user_lastModifiedTime :: Lens' User (Maybe Integer)
- user_lastName :: Lens' User (Maybe Text)
- user_status :: Lens' User (Maybe UserStatus)
- user_type :: Lens' User (Maybe UserType)
- user_userId :: Lens' User (Maybe Text)
Documentation
The details of the user account.
See: newUser
smart constructor.
User' | |
|
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:apiAccess:User'
, user_apiAccess
- Indicates whether the user can use the
GetProgrammaticAccessCredentials
API to obtain credentials that can
then be used to access other FinSpace Data API operations.
ENABLED
– The user has permissions to use the APIs.DISABLED
– The user does not have permissions to use any APIs.
$sel:apiAccessPrincipalArn:User'
, user_apiAccessPrincipalArn
- The ARN identifier of an AWS user or role that is allowed to call the
GetProgrammaticAccessCredentials
API to obtain a credentials token for
a specific FinSpace user. This must be an IAM role within your FinSpace
account.
$sel:createTime:User'
, user_createTime
- The timestamp at which the user account was created in FinSpace. The
value is determined as epoch time in milliseconds.
$sel:emailAddress:User'
, user_emailAddress
- The email address of the user. The email address serves as a uniquer
identifier for each user and cannot be changed after it's created.
$sel:firstName:User'
, user_firstName
- The first name of the user.
$sel:lastDisabledTime:User'
, user_lastDisabledTime
- Describes the last time the user account was disabled. The value is
determined as epoch time in milliseconds.
$sel:lastEnabledTime:User'
, user_lastEnabledTime
- Describes the last time the user account was enabled. The value is
determined as epoch time in milliseconds.
$sel:lastLoginTime:User'
, user_lastLoginTime
- Describes the last time that the user logged into their account. The
value is determined as epoch time in milliseconds.
$sel:lastModifiedTime:User'
, user_lastModifiedTime
- Describes the last time the user account was updated. The value is
determined as epoch time in milliseconds.
$sel:lastName:User'
, user_lastName
- The last name of the user.
$sel:status:User'
, user_status
- The current status of the user account.
CREATING
– The user account creation is in progress.ENABLED
– The user account is created and is currently active.DISABLED
– The user account is currently inactive.
$sel:type':User'
, user_type
- Indicates the type of user.
SUPER_USER
– A user with permission to all the functionality and data in FinSpace.APP_USER
– A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.
$sel:userId:User'
, user_userId
- The unique identifier for the user.
user_apiAccess :: Lens' User (Maybe ApiAccess) Source #
Indicates whether the user can use the
GetProgrammaticAccessCredentials
API to obtain credentials that can
then be used to access other FinSpace Data API operations.
ENABLED
– The user has permissions to use the APIs.DISABLED
– The user does not have permissions to use any APIs.
user_apiAccessPrincipalArn :: Lens' User (Maybe Text) Source #
The ARN identifier of an AWS user or role that is allowed to call the
GetProgrammaticAccessCredentials
API to obtain a credentials token for
a specific FinSpace user. This must be an IAM role within your FinSpace
account.
user_createTime :: Lens' User (Maybe Integer) Source #
The timestamp at which the user account was created in FinSpace. The value is determined as epoch time in milliseconds.
user_emailAddress :: Lens' User (Maybe Text) Source #
The email address of the user. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.
user_lastDisabledTime :: Lens' User (Maybe Integer) Source #
Describes the last time the user account was disabled. The value is determined as epoch time in milliseconds.
user_lastEnabledTime :: Lens' User (Maybe Integer) Source #
Describes the last time the user account was enabled. The value is determined as epoch time in milliseconds.
user_lastLoginTime :: Lens' User (Maybe Integer) Source #
Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.
user_lastModifiedTime :: Lens' User (Maybe Integer) Source #
Describes the last time the user account was updated. The value is determined as epoch time in milliseconds.
user_status :: Lens' User (Maybe UserStatus) Source #
The current status of the user account.
CREATING
– The user account creation is in progress.ENABLED
– The user account is created and is currently active.DISABLED
– The user account is currently inactive.