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 |
Creates a new user in FinSpace.
Synopsis
- data CreateUser = CreateUser' {}
- newCreateUser :: Text -> UserType -> CreateUser
- createUser_apiAccess :: Lens' CreateUser (Maybe ApiAccess)
- createUser_apiAccessPrincipalArn :: Lens' CreateUser (Maybe Text)
- createUser_clientToken :: Lens' CreateUser (Maybe Text)
- createUser_firstName :: Lens' CreateUser (Maybe Text)
- createUser_lastName :: Lens' CreateUser (Maybe Text)
- createUser_emailAddress :: Lens' CreateUser Text
- createUser_type :: Lens' CreateUser UserType
- data CreateUserResponse = CreateUserResponse' {
- userId :: Maybe Text
- httpStatus :: Int
- newCreateUserResponse :: Int -> CreateUserResponse
- createUserResponse_userId :: Lens' CreateUserResponse (Maybe Text)
- createUserResponse_httpStatus :: Lens' CreateUserResponse Int
Creating a Request
data CreateUser Source #
See: newCreateUser
smart constructor.
CreateUser' | |
|
Instances
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:
CreateUser
, createUser_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.
CreateUser
, createUser_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:CreateUser'
, createUser_clientToken
- A token that ensures idempotency. This token expires in 10 minutes.
CreateUser
, createUser_firstName
- The first name of the user that you want to register.
CreateUser
, createUser_lastName
- The last name of the user that you want to register.
CreateUser
, createUser_emailAddress
- The email address of the user that you want to register. The email
address serves as a uniquer identifier for each user and cannot be
changed after it's created.
CreateUser
, createUser_type
- The option to indicate the type of user. Use one of the following
options to specify this parameter:
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.
Request Lenses
createUser_apiAccess :: Lens' CreateUser (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.
createUser_apiAccessPrincipalArn :: Lens' CreateUser (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.
createUser_clientToken :: Lens' CreateUser (Maybe Text) Source #
A token that ensures idempotency. This token expires in 10 minutes.
createUser_firstName :: Lens' CreateUser (Maybe Text) Source #
The first name of the user that you want to register.
createUser_lastName :: Lens' CreateUser (Maybe Text) Source #
The last name of the user that you want to register.
createUser_emailAddress :: Lens' CreateUser Text Source #
The email address of the user that you want to register. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.
createUser_type :: Lens' CreateUser UserType Source #
The option to indicate the type of user. Use one of the following options to specify this parameter:
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.
Destructuring the Response
data CreateUserResponse Source #
See: newCreateUserResponse
smart constructor.
CreateUserResponse' | |
|
Instances
newCreateUserResponse Source #
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:
CreateUserResponse
, createUserResponse_userId
- The unique identifier for the user.
$sel:httpStatus:CreateUserResponse'
, createUserResponse_httpStatus
- The response's http status code.
Response Lenses
createUserResponse_userId :: Lens' CreateUserResponse (Maybe Text) Source #
The unique identifier for the user.
createUserResponse_httpStatus :: Lens' CreateUserResponse Int Source #
The response's http status code.