Class: Aws::QuickSight::Types::User
- Inherits:
-
Struct
- Object
- Struct
- Aws::QuickSight::Types::User
- Defined in:
- gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb
Overview
A registered user of Amazon QuickSight.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#active ⇒ Boolean
The active status of user.
-
#arn ⇒ String
The Amazon Resource Name (ARN) for the user.
-
#custom_permissions_name ⇒ String
The custom permissions profile associated with this user.
-
#email ⇒ String
The user's email address.
-
#external_login_federation_provider_type ⇒ String
The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAM role.
-
#external_login_federation_provider_url ⇒ String
The URL of the external login provider.
-
#external_login_id ⇒ String
The identity ID for the user in the external login provider.
-
#identity_type ⇒ String
The type of identity authentication used by the user.
-
#principal_id ⇒ String
The principal ID of the user.
-
#role ⇒ String
The Amazon QuickSight role for the user.
-
#user_name ⇒ String
The user's user name.
Instance Attribute Details
#active ⇒ Boolean
The active status of user. When you create an Amazon QuickSight user that's not an IAM user or an Active Directory user, that user is inactive until they sign in and provide a password.
32744 32745 32746 32747 32748 32749 32750 32751 32752 32753 32754 32755 32756 32757 32758 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 32744 class User < Struct.new( :arn, :user_name, :email, :role, :identity_type, :active, :principal_id, :custom_permissions_name, :external_login_federation_provider_type, :external_login_federation_provider_url, :external_login_id) SENSITIVE = [] include Aws::Structure end |
#arn ⇒ String
The Amazon Resource Name (ARN) for the user.
32744 32745 32746 32747 32748 32749 32750 32751 32752 32753 32754 32755 32756 32757 32758 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 32744 class User < Struct.new( :arn, :user_name, :email, :role, :identity_type, :active, :principal_id, :custom_permissions_name, :external_login_federation_provider_type, :external_login_federation_provider_url, :external_login_id) SENSITIVE = [] include Aws::Structure end |
#custom_permissions_name ⇒ String
The custom permissions profile associated with this user.
32744 32745 32746 32747 32748 32749 32750 32751 32752 32753 32754 32755 32756 32757 32758 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 32744 class User < Struct.new( :arn, :user_name, :email, :role, :identity_type, :active, :principal_id, :custom_permissions_name, :external_login_federation_provider_type, :external_login_federation_provider_url, :external_login_id) SENSITIVE = [] include Aws::Structure end |
#email ⇒ String
The user's email address.
32744 32745 32746 32747 32748 32749 32750 32751 32752 32753 32754 32755 32756 32757 32758 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 32744 class User < Struct.new( :arn, :user_name, :email, :role, :identity_type, :active, :principal_id, :custom_permissions_name, :external_login_federation_provider_type, :external_login_federation_provider_url, :external_login_id) SENSITIVE = [] include Aws::Structure end |
#external_login_federation_provider_type ⇒ String
The type of supported external login provider that provides identity to let the user federate into Amazon QuickSight with an associated IAM role. The type can be one of the following.
COGNITO
: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com.CUSTOM_OIDC
: Custom OpenID Connect (OIDC) provider.
32744 32745 32746 32747 32748 32749 32750 32751 32752 32753 32754 32755 32756 32757 32758 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 32744 class User < Struct.new( :arn, :user_name, :email, :role, :identity_type, :active, :principal_id, :custom_permissions_name, :external_login_federation_provider_type, :external_login_federation_provider_url, :external_login_id) SENSITIVE = [] include Aws::Structure end |
#external_login_federation_provider_url ⇒ String
The URL of the external login provider.
32744 32745 32746 32747 32748 32749 32750 32751 32752 32753 32754 32755 32756 32757 32758 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 32744 class User < Struct.new( :arn, :user_name, :email, :role, :identity_type, :active, :principal_id, :custom_permissions_name, :external_login_federation_provider_type, :external_login_federation_provider_url, :external_login_id) SENSITIVE = [] include Aws::Structure end |
#external_login_id ⇒ String
The identity ID for the user in the external login provider.
32744 32745 32746 32747 32748 32749 32750 32751 32752 32753 32754 32755 32756 32757 32758 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 32744 class User < Struct.new( :arn, :user_name, :email, :role, :identity_type, :active, :principal_id, :custom_permissions_name, :external_login_federation_provider_type, :external_login_federation_provider_url, :external_login_id) SENSITIVE = [] include Aws::Structure end |
#identity_type ⇒ String
The type of identity authentication used by the user.
32744 32745 32746 32747 32748 32749 32750 32751 32752 32753 32754 32755 32756 32757 32758 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 32744 class User < Struct.new( :arn, :user_name, :email, :role, :identity_type, :active, :principal_id, :custom_permissions_name, :external_login_federation_provider_type, :external_login_federation_provider_url, :external_login_id) SENSITIVE = [] include Aws::Structure end |
#principal_id ⇒ String
The principal ID of the user.
32744 32745 32746 32747 32748 32749 32750 32751 32752 32753 32754 32755 32756 32757 32758 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 32744 class User < Struct.new( :arn, :user_name, :email, :role, :identity_type, :active, :principal_id, :custom_permissions_name, :external_login_federation_provider_type, :external_login_federation_provider_url, :external_login_id) SENSITIVE = [] include Aws::Structure end |
#role ⇒ String
The Amazon QuickSight role for the user. The user role can be one of the following:.
READER
: A user who has read-only access to dashboards.AUTHOR
: A user who can create data sources, datasets, analyses, and dashboards.ADMIN
: A user who is an author, who can also manage Amazon Amazon QuickSight settings.RESTRICTED_READER
: This role isn't currently available for use.RESTRICTED_AUTHOR
: This role isn't currently available for use.
32744 32745 32746 32747 32748 32749 32750 32751 32752 32753 32754 32755 32756 32757 32758 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 32744 class User < Struct.new( :arn, :user_name, :email, :role, :identity_type, :active, :principal_id, :custom_permissions_name, :external_login_federation_provider_type, :external_login_federation_provider_url, :external_login_id) SENSITIVE = [] include Aws::Structure end |
#user_name ⇒ String
The user's user name. This value is required if you are registering
a user that will be managed in Amazon QuickSight. In the output, the
value for UserName
is N/A
when the value for IdentityType
is
IAM
and the corresponding IAM user is deleted.
32744 32745 32746 32747 32748 32749 32750 32751 32752 32753 32754 32755 32756 32757 32758 |
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 32744 class User < Struct.new( :arn, :user_name, :email, :role, :identity_type, :active, :principal_id, :custom_permissions_name, :external_login_federation_provider_type, :external_login_federation_provider_url, :external_login_id) SENSITIVE = [] include Aws::Structure end |