Skip to content

UpdateUserRequest

Source code in docs_src/capo_finspace_data/types/update_user_request.py
class UpdateUserRequest(TypedDict, closed=True):
    user_id: "capo_finspace_data.types.user_id.UserId"
    """<p>The unique identifier for the user that you want to update.</p>"""
    type: NotRequired["capo_finspace_data.types.user_type.UserType"]
    """<p>The option to indicate the type of user.</p> <ul> <li> <p> <code>SUPER_USER</code>– A user with permission to all the functionality and data in FinSpace.</p> </li> <li> <p> <code>APP_USER</code> – A user with specific permissions in FinSpace. The users are assigned permissions by adding them to a permission group.</p> </li> </ul>"""
    first_name: NotRequired["capo_finspace_data.types.first_name.FirstName"]
    """<p>The first name of the user.</p>"""
    last_name: NotRequired["capo_finspace_data.types.last_name.LastName"]
    """<p>The last name of the user.</p>"""
    api_access: NotRequired["capo_finspace_data.types.api_access.ApiAccess"]
    """<p>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.</p> <ul> <li> <p> <code>ENABLED</code> – The user has permissions to use the APIs.</p> </li> <li> <p> <code>DISABLED</code> – The user does not have permissions to use any APIs.</p> </li> </ul>"""
    api_access_principal_arn: NotRequired["capo_finspace_data.types.role_arn.RoleArn"]
    """<p>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.</p>"""
    client_token: NotRequired["capo_finspace_data.types.client_token.ClientToken"]
    """<p>A token that ensures idempotency. This token expires in 10 minutes.</p>"""

api_access instance-attribute

api_access: NotRequired[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.

api_access_principal_arn instance-attribute

api_access_principal_arn: NotRequired[RoleArn]

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.

client_token instance-attribute

client_token: NotRequired[ClientToken]

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

first_name instance-attribute

first_name: NotRequired[FirstName]

The first name of the user.

last_name instance-attribute

last_name: NotRequired[LastName]

The last name of the user.

type instance-attribute

type: NotRequired[UserType]

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.

user_id instance-attribute

user_id: UserId

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