GetUserResponse ¶

class GetUserResponse(TypedDict, closed=True):
    user_id: NotRequired["capo_finspace_data.types.user_id.UserId"]
    """<p>The unique identifier for the user that is retrieved.</p>"""
    status: NotRequired["capo_finspace_data.types.user_status.UserStatus"]
    """<p>The current status of the user. </p> <ul> <li> <p> <code>CREATING</code> – The creation is in progress.</p> </li> <li> <p> <code>ENABLED</code> – The user is created and is currently active.</p> </li> <li> <p> <code>DISABLED</code> – The user is currently inactive.</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>"""
    email_address: NotRequired["capo_finspace_data.types.email.Email"]
    """<p>The email address that is associated with the user.</p>"""
    type: NotRequired["capo_finspace_data.types.user_type.UserType"]
    """<p>Indicates 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> </ul> <ul> <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>"""
    api_access: NotRequired["capo_finspace_data.types.api_access.ApiAccess"]
    """<p>Indicates 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>"""
    create_time: "capo_finspace_data.types.timestamp_epoch.TimestampEpoch"
    """<p>The timestamp at which the user was created in FinSpace. The value is determined as epoch time in milliseconds. </p>"""
    last_enabled_time: "capo_finspace_data.types.timestamp_epoch.TimestampEpoch"
    """<p>Describes the last time the user was activated. The value is determined as epoch time in milliseconds.</p>"""
    last_disabled_time: "capo_finspace_data.types.timestamp_epoch.TimestampEpoch"
    """<p>Describes the last time the user was deactivated. The value is determined as epoch time in milliseconds.</p>"""
    last_modified_time: "capo_finspace_data.types.timestamp_epoch.TimestampEpoch"
    """<p>Describes the last time the user details were updated. The value is determined as epoch time in milliseconds.</p>"""
    last_login_time: "capo_finspace_data.types.timestamp_epoch.TimestampEpoch"
    """<p>Describes the last time that the user logged into their account. The value is determined as epoch time in milliseconds.</p>"""