Skip to content

Create User

finspacedata_create_user R Documentation

Creates a new user in FinSpace

Description

Creates a new user in FinSpace.

Usage

finspacedata_create_user(emailAddress, type, firstName, lastName,
  apiAccess, apiAccessPrincipalArn, clientToken)

Arguments

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

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

firstName

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

lastName

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

apiAccess

The option to indicate whether the user can use the get_programmatic_access_credentials 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.

apiAccessPrincipalArn

The ARN identifier of an AWS user or role that is allowed to call the get_programmatic_access_credentials API to obtain a credentials token for a specific FinSpace user. This must be an IAM role within your FinSpace account.

clientToken

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

Value

A list with the following syntax: 

list(
  userId = "string"
)

Request syntax

svc$create_user(
  emailAddress = "string",
  type = "SUPER_USER"|"APP_USER",
  firstName = "string",
  lastName = "string",
  apiAccess = "ENABLED"|"DISABLED",
  apiAccessPrincipalArn = "string",
  clientToken = "string"
)