Skip to content

Update Kx User

finspace_update_kx_user R Documentation

Updates the user details

Description

Updates the user details. You can only update the IAM role associated with a user.

Usage

finspace_update_kx_user(environmentId, userName, iamRole, clientToken)

Arguments

environmentId

[required] A unique identifier for the kdb environment.

userName

[required] A unique identifier for the user.

iamRole

[required] The IAM role ARN that is associated with the user.

clientToken

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

Value

A list with the following syntax:

list(
  userName = "string",
  userArn = "string",
  environmentId = "string",
  iamRole = "string"
)

Request syntax

svc$update_kx_user(
  environmentId = "string",
  userName = "string",
  iamRole = "string",
  clientToken = "string"
)