Skip to contents

Modifies the details of the specified user

Source: R/finspacedata_operations.R
finspacedata_update_user.Rd

Modifies the details of the specified user. You cannot update the userId for a user.

See https://www.paws-r-sdk.com/docs/finspacedata_update_user/ for full documentation.

Usage

finspacedata_update_user(
  userId,
  type = NULL,
  firstName = NULL,
  lastName = NULL,
  apiAccess = NULL,
  apiAccessPrincipalArn = NULL,
  clientToken = NULL
)

Arguments

userId

[required] The unique identifier for the user that you want to update.

type

The option to indicate the type of user.

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

lastName

The last name of the user.

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.