RegisterUserRequest

Types

Link copied to clipboard
class Builder
Link copied to clipboard
object Companion

Properties

Link copied to clipboard

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 Quick Sight account.

Link copied to clipboard

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

Link copied to clipboard

(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:

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

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

Link copied to clipboard

The identity type that your Quick Sight account uses to manage the identity of users.

Link copied to clipboard

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

Link copied to clipboard

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 Quick Sight 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.

Link copied to clipboard
val tags: List<Tag>?

The tags to associate with the user.

Link copied to clipboard

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

Link copied to clipboard

The Amazon Quick Sight role for the user. The user role can be one of the following:

Functions

Link copied to clipboard
Link copied to clipboard
open operator override fun equals(other: Any?): Boolean
Link copied to clipboard
open override fun hashCode(): Int
Link copied to clipboard
open override fun toString(): String