FinSpace Public API

{'apiAccess': 'ENABLED | DISABLED'}

Creates a new user in FinSpace.

See also: AWS API Documentation

Request Syntax

client.create_user(
    emailAddress='string',
    type='SUPER_USER'|'APP_USER',
    firstName='string',
    lastName='string',
    apiAccess='ENABLED'|'DISABLED',
    apiAccessPrincipalArn='string',
    clientToken='string'
)

type emailAddress

string

param emailAddress

[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 type

string

param type

[REQUIRED]

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.

type firstName

string

param firstName

The first name of the user that you want to register.

type lastName

string

param lastName

The last name of the user that you want to register.

type apiAccess

string

param 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.

type apiAccessPrincipalArn

string

param 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.

type clientToken

string

param clientToken

A token that ensures idempotency. This token expires in 10 minutes.

This field is autopopulated if not provided.

rtype

dict

returns

Response Syntax

{
    'userId': 'string'
}

Response Structure

• (dict) --

  • userId (string) --

    The unique identifier for the user.