PUT

/user/{userId}

http://finspace-api.{region}.amazonaws.com/user/{userId}

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

Access Token Required: API Key

Path Parameters

userIdstringrequired

The unique identifier for the user account to update.

Body Params

typestring

The option to indicate the type of user. <ul> <li> <code>SUPER_USER</code>– A user with permission to all the functionality and data in FinSpace. </li> <li> <code>APP_USER</code> – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group. </li> </ul>

lastNamestring

The last name of the user.

apiAccessstring

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. <ul> <li> <code>ENABLED</code> – The user has permissions to use the APIs. </li> <li> <code>DISABLED</code> – The user does not have permissions to use any APIs. </li> </ul>

firstNamestring

The first name of the user.

clientTokenstring

Idempotence Token for API operations

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.

Responses

{
  "success": true,
  "data": {
    "id": "abc123",
    "created_at": "2025-01-01T00:00:00Z"
  }
}

{
  "success": false,
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Invalid request parameters"
  }
}

Language

CredentialsAPI KEY

API Key

Enter token below to save for later

cURL Request

1curl --request PUT \
2     --url 'http://finspace-api.{region}.amazonaws.com/user/{userId}' \
3     --header 'accept: application/json' \
4     --header 'content-type: application/json'

Response

1{
2  "success": true,
3  "data": {
4    "id": "abc123",
5    "created_at": "2025-01-01T00:00:00Z"
6  }
7}

PUT