Class: Aws::FinSpaceData::Types::CreateUserRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:email_address, :first_name, :last_name]

Instance Attribute Summary collapse

Instance Attribute Details

#api_access ⇒ String

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.

Returns:

  • (String) 


674
675
676
677
678
679
680
681
682
683
684
 
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/types.rb', line 674

class CreateUserRequest < Struct.new(
  :email_address,
  :type,
  :first_name,
  :last_name,
  :api_access,
  :api_access_principal_arn,
  :client_token)
  SENSITIVE = [:email_address, :first_name, :last_name]
  include Aws::Structure
end

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

Returns:

  • (String) 


674
675
676
677
678
679
680
681
682
683
684
 
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/types.rb', line 674

class CreateUserRequest < Struct.new(
  :email_address,
  :type,
  :first_name,
  :last_name,
  :api_access,
  :api_access_principal_arn,
  :client_token)
  SENSITIVE = [:email_address, :first_name, :last_name]
  include Aws::Structure
end

#client_token ⇒ String

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

A suitable default value is auto-generated. You should normally not need to pass this option.

Returns:

  • (String) 


674
675
676
677
678
679
680
681
682
683
684
 
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/types.rb', line 674

class CreateUserRequest < Struct.new(
  :email_address,
  :type,
  :first_name,
  :last_name,
  :api_access,
  :api_access_principal_arn,
  :client_token)
  SENSITIVE = [:email_address, :first_name, :last_name]
  include Aws::Structure
end

#email_address ⇒ String

The email address of the user that you want to register. The email address serves as a uniquer identifier for each user and cannot be changed after it's created.

Returns:

  • (String) 


674
675
676
677
678
679
680
681
682
683
684
 
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/types.rb', line 674

class CreateUserRequest < Struct.new(
  :email_address,
  :type,
  :first_name,
  :last_name,
  :api_access,
  :api_access_principal_arn,
  :client_token)
  SENSITIVE = [:email_address, :first_name, :last_name]
  include Aws::Structure
end

#first_name ⇒ String

The first name of the user that you want to register.

Returns:

  • (String) 


674
675
676
677
678
679
680
681
682
683
684
 
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/types.rb', line 674

class CreateUserRequest < Struct.new(
  :email_address,
  :type,
  :first_name,
  :last_name,
  :api_access,
  :api_access_principal_arn,
  :client_token)
  SENSITIVE = [:email_address, :first_name, :last_name]
  include Aws::Structure
end

#last_name ⇒ String

The last name of the user that you want to register.

Returns:

  • (String) 


674
675
676
677
678
679
680
681
682
683
684
 
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/types.rb', line 674

class CreateUserRequest < Struct.new(
  :email_address,
  :type,
  :first_name,
  :last_name,
  :api_access,
  :api_access_principal_arn,
  :client_token)
  SENSITIVE = [:email_address, :first_name, :last_name]
  include Aws::Structure
end

#type ⇒ String

The option to indicate the type of user. Use one of the following options to specify this parameter:

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

Returns:

  • (String) 


674
675
676
677
678
679
680
681
682
683
684
 
# File 'gems/aws-sdk-finspacedata/lib/aws-sdk-finspacedata/types.rb', line 674

class CreateUserRequest < Struct.new(
  :email_address,
  :type,
  :first_name,
  :last_name,
  :api_access,
  :api_access_principal_arn,
  :client_token)
  SENSITIVE = [:email_address, :first_name, :last_name]
  include Aws::Structure
end