Creates a new user in FinSpace.
post/user
Request body
emailAddressstring password required
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.
type'SUPER_USER' | 'APP_USER' required
<p>The option to indicate the type of user. Use one of the following options to specify this parameter:</p> <ul> <li> <p> <code>SUPER_USER</code> – A user with permission to all the functionality and data in FinSpace.</p> </li> <li> <p> <code>APP_USER</code> – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.</p> </li> </ul>
firstNamestring password
The first name of the user that you want to register.
lastNamestring password
The last name of the user that you want to register.
ApiAccess'ENABLED' | 'DISABLED'
<p>The option to indicate whether the user can use the <code>GetProgrammaticAccessCredentials</code> API to obtain credentials that can then be used to access other FinSpace Data API operations.</p> <ul> <li> <p> <code>ENABLED</code> – The user has permissions to use the APIs.</p> </li> <li> <p> <code>DISABLED</code> – The user does not have permissions to use any APIs.</p> </li> </ul>
apiAccessPrincipalArnstring
The ARN identifier of an AWS user or role that is allowed to call the <code>GetProgrammaticAccessCredentials</code> API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.
clientTokenstring
Idempotence Token for API operations
Response
Success
userIdstring
The unique identifier for the user.