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 |
Modifies the details of the specified user account. You cannot update
the userId
for a user.
Synopsis
- data UpdateUser = UpdateUser' {}
- newUpdateUser :: Text -> UpdateUser
- updateUser_apiAccess :: Lens' UpdateUser (Maybe ApiAccess)
- updateUser_apiAccessPrincipalArn :: Lens' UpdateUser (Maybe Text)
- updateUser_clientToken :: Lens' UpdateUser (Maybe Text)
- updateUser_firstName :: Lens' UpdateUser (Maybe Text)
- updateUser_lastName :: Lens' UpdateUser (Maybe Text)
- updateUser_type :: Lens' UpdateUser (Maybe UserType)
- updateUser_userId :: Lens' UpdateUser Text
- data UpdateUserResponse = UpdateUserResponse' {
- userId :: Maybe Text
- httpStatus :: Int
- newUpdateUserResponse :: Int -> UpdateUserResponse
- updateUserResponse_userId :: Lens' UpdateUserResponse (Maybe Text)
- updateUserResponse_httpStatus :: Lens' UpdateUserResponse Int
Creating a Request
data UpdateUser Source #
See: newUpdateUser
smart constructor.
UpdateUser' | |
|
Instances
:: Text | |
-> UpdateUser |
Create a value of UpdateUser
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:
UpdateUser
, updateUser_apiAccess
- The option to indicate 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.
UpdateUser
, updateUser_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:clientToken:UpdateUser'
, updateUser_clientToken
- A token that ensures idempotency. This token expires in 10 minutes.
UpdateUser
, updateUser_firstName
- The first name of the user.
UpdateUser
, updateUser_lastName
- The last name of the user.
UpdateUser
, updateUser_type
- The option to indicate 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.
UpdateUser
, updateUser_userId
- The unique identifier for the user account to update.
Request Lenses
updateUser_apiAccess :: Lens' UpdateUser (Maybe ApiAccess) Source #
The option to indicate 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.
updateUser_apiAccessPrincipalArn :: Lens' UpdateUser (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.
updateUser_clientToken :: Lens' UpdateUser (Maybe Text) Source #
A token that ensures idempotency. This token expires in 10 minutes.
updateUser_firstName :: Lens' UpdateUser (Maybe Text) Source #
The first name of the user.
updateUser_lastName :: Lens' UpdateUser (Maybe Text) Source #
The last name of the user.
updateUser_type :: Lens' UpdateUser (Maybe UserType) Source #
The option to indicate 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.
updateUser_userId :: Lens' UpdateUser Text Source #
The unique identifier for the user account to update.
Destructuring the Response
data UpdateUserResponse Source #
See: newUpdateUserResponse
smart constructor.
UpdateUserResponse' | |
|
Instances
newUpdateUserResponse Source #
Create a value of UpdateUserResponse
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:
UpdateUser
, updateUserResponse_userId
- The unique identifier of the updated user account.
$sel:httpStatus:UpdateUserResponse'
, updateUserResponse_httpStatus
- The response's http status code.
Response Lenses
updateUserResponse_userId :: Lens' UpdateUserResponse (Maybe Text) Source #
The unique identifier of the updated user account.
updateUserResponse_httpStatus :: Lens' UpdateUserResponse Int Source #
The response's http status code.