Class: Aws::QuickSight::Types::UpdateUserRequest

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

Overview

Note:

When making an API call, you may pass UpdateUserRequest data as a hash:

{
  user_name: "UserName", # required
  aws_account_id: "AwsAccountId", # required
  namespace: "Namespace", # required
  email: "String", # required
  role: "ADMIN", # required, accepts ADMIN, AUTHOR, READER, RESTRICTED_AUTHOR, RESTRICTED_READER
  custom_permissions_name: "RoleName",
  unapply_custom_permissions: false,
  external_login_federation_provider_type: "String",
  custom_federation_provider_url: "String",
  external_login_id: "String",
}

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)


15276
15277
15278
15279
15280
15281
15282
15283
15284
15285
15286
15287
15288
15289
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 15276

class UpdateUserRequest < Struct.new(
  :user_name,
  :aws_account_id,
  :namespace,
  :email,
  :role,
  :custom_permissions_name,
  :unapply_custom_permissions,
  :external_login_federation_provider_type,
  :custom_federation_provider_url,
  :external_login_id)
  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)


15276
15277
15278
15279
15280
15281
15282
15283
15284
15285
15286
15287
15288
15289
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 15276

class UpdateUserRequest < Struct.new(
  :user_name,
  :aws_account_id,
  :namespace,
  :email,
  :role,
  :custom_permissions_name,
  :unapply_custom_permissions,
  :external_login_federation_provider_type,
  :custom_federation_provider_url,
  :external_login_id)
  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

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)


15276
15277
15278
15279
15280
15281
15282
15283
15284
15285
15286
15287
15288
15289
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 15276

class UpdateUserRequest < Struct.new(
  :user_name,
  :aws_account_id,
  :namespace,
  :email,
  :role,
  :custom_permissions_name,
  :unapply_custom_permissions,
  :external_login_federation_provider_type,
  :custom_federation_provider_url,
  :external_login_id)
  SENSITIVE = []
  include Aws::Structure
end

#emailString

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

Returns:

  • (String)


15276
15277
15278
15279
15280
15281
15282
15283
15284
15285
15286
15287
15288
15289
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 15276

class UpdateUserRequest < Struct.new(
  :user_name,
  :aws_account_id,
  :namespace,
  :email,
  :role,
  :custom_permissions_name,
  :unapply_custom_permissions,
  :external_login_federation_provider_type,
  :custom_federation_provider_url,
  :external_login_id)
  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.

  • NONE: This clears all the previously saved external login information for a user. Use the DescribeUser API operation to check the external login information.

Returns:

  • (String)


15276
15277
15278
15279
15280
15281
15282
15283
15284
15285
15286
15287
15288
15289
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 15276

class UpdateUserRequest < Struct.new(
  :user_name,
  :aws_account_id,
  :namespace,
  :email,
  :role,
  :custom_permissions_name,
  :unapply_custom_permissions,
  :external_login_federation_provider_type,
  :custom_federation_provider_url,
  :external_login_id)
  SENSITIVE = []
  include Aws::Structure
end

#external_login_idString

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

Returns:

  • (String)


15276
15277
15278
15279
15280
15281
15282
15283
15284
15285
15286
15287
15288
15289
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 15276

class UpdateUserRequest < Struct.new(
  :user_name,
  :aws_account_id,
  :namespace,
  :email,
  :role,
  :custom_permissions_name,
  :unapply_custom_permissions,
  :external_login_federation_provider_type,
  :custom_federation_provider_url,
  :external_login_id)
  SENSITIVE = []
  include Aws::Structure
end

#namespaceString

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

Returns:

  • (String)


15276
15277
15278
15279
15280
15281
15282
15283
15284
15285
15286
15287
15288
15289
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 15276

class UpdateUserRequest < Struct.new(
  :user_name,
  :aws_account_id,
  :namespace,
  :email,
  :role,
  :custom_permissions_name,
  :unapply_custom_permissions,
  :external_login_federation_provider_type,
  :custom_federation_provider_url,
  :external_login_id)
  SENSITIVE = []
  include Aws::Structure
end

#roleString

The Amazon QuickSight role of the user. The role can be one of the following default security cohorts:

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

The name of the Amazon QuickSight role is invisible to the user except for the console screens dealing with permissions.

Returns:

  • (String)


15276
15277
15278
15279
15280
15281
15282
15283
15284
15285
15286
15287
15288
15289
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 15276

class UpdateUserRequest < Struct.new(
  :user_name,
  :aws_account_id,
  :namespace,
  :email,
  :role,
  :custom_permissions_name,
  :unapply_custom_permissions,
  :external_login_federation_provider_type,
  :custom_federation_provider_url,
  :external_login_id)
  SENSITIVE = []
  include Aws::Structure
end

#unapply_custom_permissionsBoolean

A flag that you use to indicate that you want to remove all custom permissions from this user. Using this parameter resets the user to the state it was in before a custom permissions profile was applied. This parameter defaults to NULL and it doesn't accept any other value.

Returns:

  • (Boolean)


15276
15277
15278
15279
15280
15281
15282
15283
15284
15285
15286
15287
15288
15289
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 15276

class UpdateUserRequest < Struct.new(
  :user_name,
  :aws_account_id,
  :namespace,
  :email,
  :role,
  :custom_permissions_name,
  :unapply_custom_permissions,
  :external_login_federation_provider_type,
  :custom_federation_provider_url,
  :external_login_id)
  SENSITIVE = []
  include Aws::Structure
end

#user_nameString

The Amazon QuickSight user name that you want to update.

Returns:

  • (String)


15276
15277
15278
15279
15280
15281
15282
15283
15284
15285
15286
15287
15288
15289
# File 'gems/aws-sdk-quicksight/lib/aws-sdk-quicksight/types.rb', line 15276

class UpdateUserRequest < Struct.new(
  :user_name,
  :aws_account_id,
  :namespace,
  :email,
  :role,
  :custom_permissions_name,
  :unapply_custom_permissions,
  :external_login_federation_provider_type,
  :custom_federation_provider_url,
  :external_login_id)
  SENSITIVE = []
  include Aws::Structure
end