Class: Aws::FinSpaceData::Types::UserByPermissionGroup

Inherits:

Struct

• Object
• Struct
• Aws::FinSpaceData::Types::UserByPermissionGroup

Includes:

Structure

Defined in:

lib/aws-sdk-finspacedata/types.rb

Overview

The structure of a user associated with a permission group.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:first_name, :last_name, :email_address]

Instance Attribute Summary

• #api_access ⇒ String

  Indicates whether the user can access FinSpace API operations.

• #api_access_principal_arn ⇒ String

  The IAM ARN identifier that is attached to FinSpace API calls.

• #email_address ⇒ String

  The email address of the user.

• #first_name ⇒ String

  The first name of the user.

• #last_name ⇒ String

  The last name of the user.

• #membership_status ⇒ String

  Indicates the status of the user within a permission group.

• #status ⇒ String

  The current status of the user.

• #type ⇒ String

  Indicates the type of user.

• #user_id ⇒ String

  The unique identifier for the user.

Instance Attribute Details

#api_access ⇒ String

Indicates whether the user can access FinSpace API operations.

• ‘ENABLED` – The user has permissions to use the API operations.

• ‘DISABLED` – The user does not have permissions to use any API operations.

Returns:

• (String)

# File 'lib/aws-sdk-finspacedata/types.rb', line 2807

class UserByPermissionGroup < Struct.new(
  :user_id,
  :status,
  :first_name,
  :last_name,
  :email_address,
  :type,
  :api_access,
  :api_access_principal_arn,
  :membership_status)
  SENSITIVE = [:first_name, :last_name, :email_address]
  include Aws::Structure
end

#api_access_principal_arn ⇒ String

The IAM ARN identifier that is attached to FinSpace API calls.

Returns:

• (String)

# File 'lib/aws-sdk-finspacedata/types.rb', line 2807

class UserByPermissionGroup < Struct.new(
  :user_id,
  :status,
  :first_name,
  :last_name,
  :email_address,
  :type,
  :api_access,
  :api_access_principal_arn,
  :membership_status)
  SENSITIVE = [:first_name, :last_name, :email_address]
  include Aws::Structure
end

#email_address ⇒ String

The email address of the user. The email address serves as a unique identifier for each user and cannot be changed after it’s created.

Returns:

• (String)

# File 'lib/aws-sdk-finspacedata/types.rb', line 2807

class UserByPermissionGroup < Struct.new(
  :user_id,
  :status,
  :first_name,
  :last_name,
  :email_address,
  :type,
  :api_access,
  :api_access_principal_arn,
  :membership_status)
  SENSITIVE = [:first_name, :last_name, :email_address]
  include Aws::Structure
end

#first_name ⇒ String

The first name of the user.

Returns:

• (String)

# File 'lib/aws-sdk-finspacedata/types.rb', line 2807

class UserByPermissionGroup < Struct.new(
  :user_id,
  :status,
  :first_name,
  :last_name,
  :email_address,
  :type,
  :api_access,
  :api_access_principal_arn,
  :membership_status)
  SENSITIVE = [:first_name, :last_name, :email_address]
  include Aws::Structure
end

#last_name ⇒ String

The last name of the user.

Returns:

• (String)

# File 'lib/aws-sdk-finspacedata/types.rb', line 2807

class UserByPermissionGroup < Struct.new(
  :user_id,
  :status,
  :first_name,
  :last_name,
  :email_address,
  :type,
  :api_access,
  :api_access_principal_arn,
  :membership_status)
  SENSITIVE = [:first_name, :last_name, :email_address]
  include Aws::Structure
end

#membership_status ⇒ String

Indicates the status of the user within a permission group.

• ‘ADDITION_IN_PROGRESS` – The user is currently being added to the permission group.

• ‘ADDITION_SUCCESS` – The user is successfully added to the permission group.

• ‘REMOVAL_IN_PROGRESS` – The user is currently being removed from the permission group.

Returns:

• (String)

# File 'lib/aws-sdk-finspacedata/types.rb', line 2807

class UserByPermissionGroup < Struct.new(
  :user_id,
  :status,
  :first_name,
  :last_name,
  :email_address,
  :type,
  :api_access,
  :api_access_principal_arn,
  :membership_status)
  SENSITIVE = [:first_name, :last_name, :email_address]
  include Aws::Structure
end

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

Returns:

• (String)

# File 'lib/aws-sdk-finspacedata/types.rb', line 2807

class UserByPermissionGroup < Struct.new(
  :user_id,
  :status,
  :first_name,
  :last_name,
  :email_address,
  :type,
  :api_access,
  :api_access_principal_arn,
  :membership_status)
  SENSITIVE = [:first_name, :last_name, :email_address]
  include Aws::Structure
end

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

Returns:

• (String)

# File 'lib/aws-sdk-finspacedata/types.rb', line 2807

class UserByPermissionGroup < Struct.new(
  :user_id,
  :status,
  :first_name,
  :last_name,
  :email_address,
  :type,
  :api_access,
  :api_access_principal_arn,
  :membership_status)
  SENSITIVE = [:first_name, :last_name, :email_address]
  include Aws::Structure
end

#user_id ⇒ String

The unique identifier for the user.

Returns:

• (String)

# File 'lib/aws-sdk-finspacedata/types.rb', line 2807

class UserByPermissionGroup < Struct.new(
  :user_id,
  :status,
  :first_name,
  :last_name,
  :email_address,
  :type,
  :api_access,
  :api_access_principal_arn,
  :membership_status)
  SENSITIVE = [:first_name, :last_name, :email_address]
  include Aws::Structure
end