POST

/user

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

Creates a new user in FinSpace.

Access Token Required: API Key

Body Params

typestringrequired

The option to indicate the type of user. Use one of the following options to specify this parameter: <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 that you want to register.

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 that you want to register.

clientTokenstring

Idempotence Token for API operations

emailAddressstringrequired

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.

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 POST \
2     --url 'http://finspace-api.{region}.amazonaws.com/user' \
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}