users

Creates, updates, deletes, gets or lists a users resource.

Overview

Name	users
Type	Resource
Id	aws.finspace_data.users

Fields

The following fields are returned by SELECT queries:

list_users

Name	Datatype	Description
api_access	string	Indicates 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. (ENABLED, DISABLED)
api_access_principal_arn	string	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. (pattern: <code>^arn:aws[a-z-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@-_/]+$</code>)
create_time	integer (int64)	Milliseconds since UTC epoch
email_address	string	The email address of the user. The email address serves as a uniquer identifier for each user and cannot be changed after it's created. (pattern: <code>[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+.[A-Za-z]{2,4}</code>)
first_name	string	The first name of the user. (pattern: <code>.\S.</code>)
last_disabled_time	integer (int64)	Milliseconds since UTC epoch
last_enabled_time	integer (int64)	Milliseconds since UTC epoch
last_login_time	integer (int64)	Milliseconds since UTC epoch
last_modified_time	integer (int64)	Milliseconds since UTC epoch
last_name	string	The last name of the user. (pattern: <code>.\S.</code>)
status	string	The current status of the user. CREATING – The user creation is in progress. ENABLED – The user is created and is currently active. DISABLED – The user is currently inactive. (CREATING, ENABLED, DISABLED)
type_	string	Indicates 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. (SUPER_USER, APP_USER)
user_id	string	The unique identifier for the user. (pattern: <code>.\S.</code>)

get_user

Name	Datatype	Description
api_access	string	Indicates 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. (ENABLED, DISABLED)
api_access_principal_arn	string	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. (pattern: <code>^arn:aws[a-z-]*:iam::\d{12}:role/?[a-zA-Z_0-9+=,.@-_/]+$</code>)
create_time	integer (int64)	Milliseconds since UTC epoch
email_address	string	The email address that is associated with the user. (pattern: <code>[A-Za-z0-9._%+-]+@[A-Za-z0-9.-]+.[A-Za-z]{2,4}</code>)
first_name	string	The first name of the user. (pattern: <code>.\S.</code>)
last_disabled_time	integer (int64)	Milliseconds since UTC epoch
last_enabled_time	integer (int64)	Milliseconds since UTC epoch
last_login_time	integer (int64)	Milliseconds since UTC epoch
last_modified_time	integer (int64)	Milliseconds since UTC epoch
last_name	string	The last name of the user. (pattern: <code>.\S.</code>)
status	string	The current status of the user. CREATING – The creation is in progress. ENABLED – The user is created and is currently active. DISABLED – The user is currently inactive. (CREATING, ENABLED, DISABLED)
type_	string	Indicates 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. (SUPER_USER, APP_USER)
user_id	string	The unique identifier for the user that is retrieved. (pattern: <code>.\S.</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_users	select	maxResults, region	nextToken	Lists all available users in FinSpace.
get_user	select	user_id, region		Retrieves details for a specific user.
create_user	insert	region, emailAddress, type		Creates a new user in FinSpace.
update_user	update	user_id, region		Modifies the details of the specified user. You cannot update the userId for a user.
disable_user	exec	user_id, region		Denies access to the FinSpace web application and API for the specified user.
enable_user	exec	user_id, region		Allows the specified user to access the FinSpace web application and API.
reset_user_password	exec	user_id, region		Resets the password for a specified user ID and generates a temporary one. Only a superuser can reset password for other users. Resetting the password immediately invalidates the previous password associated with the user.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
maxResults	integer	The maximum number of results per page.
region	string	AWS region (default: us-east-1)
user_id	string	The unique identifier of the user that a temporary password is requested for.
nextToken	string	A token that indicates where a results page should begin.

SELECT examples

list_users

Lists all available users in FinSpace.

SELECT
api_access,
api_access_principal_arn,
create_time,
email_address,
first_name,
last_disabled_time,
last_enabled_time,
last_login_time,
last_modified_time,
last_name,
status,
type_,
user_id
FROM aws.finspace_data.users
WHERE maxResults = '{{ maxResults }}' -- required
AND region = '{{ region }}' -- required
AND nextToken = '{{ nextToken }}'
;

get_user

Retrieves details for a specific user.

SELECT
api_access,
api_access_principal_arn,
create_time,
email_address,
first_name,
last_disabled_time,
last_enabled_time,
last_login_time,
last_modified_time,
last_name,
status,
type_,
user_id
FROM aws.finspace_data.users
WHERE user_id = '{{ user_id }}' -- required
AND region = '{{ region }}' -- required
;

INSERT examples

create_user

Creates a new user in FinSpace.

INSERT INTO aws.finspace_data.users (
emailAddress,
type,
firstName,
lastName,
apiAccess,
apiAccessPrincipalArn,
clientToken,
region
)
SELECT 
'{{ emailAddress }}' /* required */,
'{{ type }}' /* required */,
'{{ firstName }}',
'{{ lastName }}',
'{{ apiAccess }}',
'{{ apiAccessPrincipalArn }}',
'{{ clientToken }}',
'{{ region }}'
RETURNING
user_id
;

Manifest

# Description fields are for documentation purposes
- name: users
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the users resource.
  - name: emailAddress
    value: "{{ emailAddress }}"
  - name: type
    value: "{{ type }}"
    valid_values: ['SUPER_USER', 'APP_USER']
  - name: firstName
    value: "{{ firstName }}"
  - name: lastName
    value: "{{ lastName }}"
  - name: apiAccess
    value: "{{ apiAccess }}"
    valid_values: ['ENABLED', 'DISABLED']
  - name: apiAccessPrincipalArn
    value: "{{ apiAccessPrincipalArn }}"
  - name: clientToken
    value: "{{ clientToken }}"
    description: |
      Idempotence Token for API operations

UPDATE examples

update_user

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

UPDATE aws.finspace_data.users
SET 
type = '{{ type }}',
firstName = '{{ firstName }}',
lastName = '{{ lastName }}',
apiAccess = '{{ apiAccess }}',
apiAccessPrincipalArn = '{{ apiAccessPrincipalArn }}',
clientToken = '{{ clientToken }}'
WHERE 
user_id = '{{ user_id }}' --required
AND region = '{{ region }}' --required
RETURNING
user_id;

Lifecycle Methods

disable_user

Denies access to the FinSpace web application and API for the specified user.

EXEC aws.finspace_data.users.disable_user 
@user_id='{{ user_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"clientToken": "{{ clientToken }}"
}'
;

enable_user

Allows the specified user to access the FinSpace web application and API.

EXEC aws.finspace_data.users.enable_user 
@user_id='{{ user_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"clientToken": "{{ clientToken }}"
}'
;

reset_user_password

Resets the password for a specified user ID and generates a temporary one. Only a superuser can reset password for other users. Resetting the password immediately invalidates the previous password associated with the user.

EXEC aws.finspace_data.users.reset_user_password 
@user_id='{{ user_id }}' --required, 
@region='{{ region }}' --required 
@@json=
'{
"clientToken": "{{ clientToken }}"
}'
;