Class: Aws::QuickSight::Types::RegisterUserRequest

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

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#aws_account_idString

The ID for the Amazon Web Services account that the user is in. Currently, you use the ID for the Amazon Web Services account that contains your Amazon QuickSight account.

Returns:

  • (String)


23351
23352
23353
23354
23355
23356
23357
23358
23359
23360
23361
23362
23363
23364
23365
23366
23367
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 23351

class RegisterUserRequest < Struct.new(
  :identity_type,
  :email,
  :user_role,
  :iam_arn,
  :session_name,
  :aws_account_id,
  :namespace,
  :user_name,
  :custom_permissions_name,
  :external_login_federation_provider_type,
  :custom_federation_provider_url,
  :external_login_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#custom_federation_provider_urlString

The URL of the custom OpenID Connect (OIDC) provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. This parameter should only be used when ExternalLoginFederationProviderType parameter is set to CUSTOM_OIDC.

Returns:

  • (String)


23351
23352
23353
23354
23355
23356
23357
23358
23359
23360
23361
23362
23363
23364
23365
23366
23367
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 23351

class RegisterUserRequest < Struct.new(
  :identity_type,
  :email,
  :user_role,
  :iam_arn,
  :session_name,
  :aws_account_id,
  :namespace,
  :user_name,
  :custom_permissions_name,
  :external_login_federation_provider_type,
  :custom_federation_provider_url,
  :external_login_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#custom_permissions_nameString

(Enterprise edition only) The name of the custom permissions profile that you want to assign to this user. Customized permissions allows you to control a user's access by restricting access the following operations:

  • Create and update data sources

  • Create and update datasets

  • Create and update email reports

  • Subscribe to email reports

To add custom permissions to an existing user, use UpdateUser instead.

A set of custom permissions includes any combination of these restrictions. Currently, you need to create the profile names for custom permission sets by using the Amazon QuickSight console. Then, you use the RegisterUser API operation to assign the named set of permissions to a Amazon QuickSight user.

Amazon QuickSight custom permissions are applied through IAM policies. Therefore, they override the permissions typically granted by assigning Amazon QuickSight users to one of the default security cohorts in Amazon QuickSight (admin, author, reader).

This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

Returns:

  • (String)


23351
23352
23353
23354
23355
23356
23357
23358
23359
23360
23361
23362
23363
23364
23365
23366
23367
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 23351

class RegisterUserRequest < Struct.new(
  :identity_type,
  :email,
  :user_role,
  :iam_arn,
  :session_name,
  :aws_account_id,
  :namespace,
  :user_name,
  :custom_permissions_name,
  :external_login_federation_provider_type,
  :custom_federation_provider_url,
  :external_login_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#emailString

The email address of the user that you want to register.

Returns:

  • (String)


23351
23352
23353
23354
23355
23356
23357
23358
23359
23360
23361
23362
23363
23364
23365
23366
23367
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 23351

class RegisterUserRequest < Struct.new(
  :identity_type,
  :email,
  :user_role,
  :iam_arn,
  :session_name,
  :aws_account_id,
  :namespace,
  :user_name,
  :custom_permissions_name,
  :external_login_federation_provider_type,
  :custom_federation_provider_url,
  :external_login_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#external_login_federation_provider_typeString

The type of supported external login provider that provides identity to let a user federate into Amazon QuickSight with an associated Identity and Access Management(IAM) role. The type of supported external login provider can be one of the following.

  • COGNITO: Amazon Cognito. The provider URL is cognito-identity.amazonaws.com. When choosing the COGNITO provider type, don’t use the "CustomFederationProviderUrl" parameter which is only needed when the external provider is custom.

  • CUSTOM_OIDC: Custom OpenID Connect (OIDC) provider. When choosing CUSTOM_OIDC type, use the CustomFederationProviderUrl parameter to provide the custom OIDC provider URL.

Returns:

  • (String)


23351
23352
23353
23354
23355
23356
23357
23358
23359
23360
23361
23362
23363
23364
23365
23366
23367
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 23351

class RegisterUserRequest < Struct.new(
  :identity_type,
  :email,
  :user_role,
  :iam_arn,
  :session_name,
  :aws_account_id,
  :namespace,
  :user_name,
  :custom_permissions_name,
  :external_login_federation_provider_type,
  :custom_federation_provider_url,
  :external_login_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#external_login_idString

The identity ID for a user in the external login provider.

Returns:

  • (String)


23351
23352
23353
23354
23355
23356
23357
23358
23359
23360
23361
23362
23363
23364
23365
23366
23367
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 23351

class RegisterUserRequest < Struct.new(
  :identity_type,
  :email,
  :user_role,
  :iam_arn,
  :session_name,
  :aws_account_id,
  :namespace,
  :user_name,
  :custom_permissions_name,
  :external_login_federation_provider_type,
  :custom_federation_provider_url,
  :external_login_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#iam_arnString

The ARN of the IAM user or role that you are registering with Amazon QuickSight.

Returns:

  • (String)


23351
23352
23353
23354
23355
23356
23357
23358
23359
23360
23361
23362
23363
23364
23365
23366
23367
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 23351

class RegisterUserRequest < Struct.new(
  :identity_type,
  :email,
  :user_role,
  :iam_arn,
  :session_name,
  :aws_account_id,
  :namespace,
  :user_name,
  :custom_permissions_name,
  :external_login_federation_provider_type,
  :custom_federation_provider_url,
  :external_login_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#identity_typeString

Amazon QuickSight supports several ways of managing the identity of users. This parameter accepts two values:

  • IAM: A user whose identity maps to an existing IAM user or role.

  • QUICKSIGHT: A user whose identity is owned and managed internally by Amazon QuickSight.

Returns:

  • (String)


23351
23352
23353
23354
23355
23356
23357
23358
23359
23360
23361
23362
23363
23364
23365
23366
23367
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 23351

class RegisterUserRequest < Struct.new(
  :identity_type,
  :email,
  :user_role,
  :iam_arn,
  :session_name,
  :aws_account_id,
  :namespace,
  :user_name,
  :custom_permissions_name,
  :external_login_federation_provider_type,
  :custom_federation_provider_url,
  :external_login_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#namespaceString

The namespace. Currently, you should set this to default.

Returns:

  • (String)


23351
23352
23353
23354
23355
23356
23357
23358
23359
23360
23361
23362
23363
23364
23365
23366
23367
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 23351

class RegisterUserRequest < Struct.new(
  :identity_type,
  :email,
  :user_role,
  :iam_arn,
  :session_name,
  :aws_account_id,
  :namespace,
  :user_name,
  :custom_permissions_name,
  :external_login_federation_provider_type,
  :custom_federation_provider_url,
  :external_login_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#session_nameString

You need to use this parameter only when you register one or more users using an assumed IAM role. You don't need to provide the session name for other scenarios, for example when you are registering an IAM user or an Amazon QuickSight user. You can register multiple users using the same IAM role if each user has a different session name. For more information on assuming IAM roles, see assume-role in the CLI Reference.

Returns:

  • (String)


23351
23352
23353
23354
23355
23356
23357
23358
23359
23360
23361
23362
23363
23364
23365
23366
23367
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 23351

class RegisterUserRequest < Struct.new(
  :identity_type,
  :email,
  :user_role,
  :iam_arn,
  :session_name,
  :aws_account_id,
  :namespace,
  :user_name,
  :custom_permissions_name,
  :external_login_federation_provider_type,
  :custom_federation_provider_url,
  :external_login_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

The tags to associate with the user.

Returns:



23351
23352
23353
23354
23355
23356
23357
23358
23359
23360
23361
23362
23363
23364
23365
23366
23367
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 23351

class RegisterUserRequest < Struct.new(
  :identity_type,
  :email,
  :user_role,
  :iam_arn,
  :session_name,
  :aws_account_id,
  :namespace,
  :user_name,
  :custom_permissions_name,
  :external_login_federation_provider_type,
  :custom_federation_provider_url,
  :external_login_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#user_nameString

The Amazon QuickSight user name that you want to create for the user you are registering.

Returns:

  • (String)


23351
23352
23353
23354
23355
23356
23357
23358
23359
23360
23361
23362
23363
23364
23365
23366
23367
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 23351

class RegisterUserRequest < Struct.new(
  :identity_type,
  :email,
  :user_role,
  :iam_arn,
  :session_name,
  :aws_account_id,
  :namespace,
  :user_name,
  :custom_permissions_name,
  :external_login_federation_provider_type,
  :custom_federation_provider_url,
  :external_login_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#user_roleString

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 QuickSight settings.

  • RESTRICTED_READER: This role isn't currently available for use.

  • RESTRICTED_AUTHOR: This role isn't currently available for use.

Returns:

  • (String)


23351
23352
23353
23354
23355
23356
23357
23358
23359
23360
23361
23362
23363
23364
23365
23366
23367
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 23351

class RegisterUserRequest < Struct.new(
  :identity_type,
  :email,
  :user_role,
  :iam_arn,
  :session_name,
  :aws_account_id,
  :namespace,
  :user_name,
  :custom_permissions_name,
  :external_login_federation_provider_type,
  :custom_federation_provider_url,
  :external_login_id,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end