Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1431163144.6 KB

Modifies the details of the specified user account. You cannot update the <code>userId</code> for a user.

put/user/{userId}

Path parameters

userIdstring required

The unique identifier for the user account to update.

Request body

type'SUPER_USER' | 'APP_USER'
<p>The option to indicate the type of user.</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.

lastNamestring password

The last name of the user.

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 of the updated user account.