Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.QuickSight.RegisterUser

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

Creates an Amazon QuickSight user, whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request.

Synopsis

data RegisterUser = RegisterUser' {
- customFederationProviderUrl :: Maybe Text
- customPermissionsName :: Maybe Text
- externalLoginFederationProviderType :: Maybe Text
- externalLoginId :: Maybe Text
- iamArn :: Maybe Text
- sessionName :: Maybe Text
- userName :: Maybe Text
- identityType :: IdentityType
- email :: Text
- userRole :: UserRole
- awsAccountId :: Text
- namespace :: Text
}
newRegisterUser :: IdentityType -> Text -> UserRole -> Text -> Text -> RegisterUser
registerUser_customFederationProviderUrl :: Lens' RegisterUser (Maybe Text)
registerUser_customPermissionsName :: Lens' RegisterUser (Maybe Text)
registerUser_externalLoginFederationProviderType :: Lens' RegisterUser (Maybe Text)
registerUser_externalLoginId :: Lens' RegisterUser (Maybe Text)
registerUser_iamArn :: Lens' RegisterUser (Maybe Text)
registerUser_sessionName :: Lens' RegisterUser (Maybe Text)
registerUser_userName :: Lens' RegisterUser (Maybe Text)
registerUser_identityType :: Lens' RegisterUser IdentityType
registerUser_email :: Lens' RegisterUser Text
registerUser_userRole :: Lens' RegisterUser UserRole
registerUser_awsAccountId :: Lens' RegisterUser Text
registerUser_namespace :: Lens' RegisterUser Text
data RegisterUserResponse = RegisterUserResponse' {
- requestId :: Maybe Text
- user :: Maybe User
- userInvitationUrl :: Maybe Text
- status :: Int
}
newRegisterUserResponse :: Int -> RegisterUserResponse
registerUserResponse_requestId :: Lens' RegisterUserResponse (Maybe Text)
registerUserResponse_user :: Lens' RegisterUserResponse (Maybe User)
registerUserResponse_userInvitationUrl :: Lens' RegisterUserResponse (Maybe Text)
registerUserResponse_status :: Lens' RegisterUserResponse Int

Creating a Request

data RegisterUser Source #

See: newRegisterUser smart constructor.

Constructors

RegisterUser'

Fields

customFederationProviderUrl :: Maybe Text
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.
customPermissionsName :: Maybe Text
(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.
externalLoginFederationProviderType :: Maybe Text
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.
externalLoginId :: Maybe Text
The identity ID for a user in the external login provider.
iamArn :: Maybe Text
The ARN of the IAM user or role that you are registering with Amazon QuickSight.
sessionName :: Maybe Text
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.
userName :: Maybe Text
The Amazon QuickSight user name that you want to create for the user you are registering.
identityType :: IdentityType
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.
email :: Text
The email address of the user that you want to register.
userRole :: UserRole
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.
awsAccountId :: Text
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.
namespace :: Text
The namespace. Currently, you should set this to default.

Instances

Instances details

ToJSON RegisterUser Source #
Instance details Defined in Amazonka.QuickSight.RegisterUser Methods toJSON :: RegisterUser -> Value # toEncoding :: RegisterUser -> Encoding # toJSONList :: [RegisterUser] -> Value # toEncodingList :: [RegisterUser] -> Encoding #
ToHeaders RegisterUser Source #
Instance details Defined in Amazonka.QuickSight.RegisterUser Methods toHeaders :: RegisterUser -> [Header] #
ToPath RegisterUser Source #
Instance details Defined in Amazonka.QuickSight.RegisterUser Methods toPath :: RegisterUser -> ByteString #
ToQuery RegisterUser Source #
Instance details Defined in Amazonka.QuickSight.RegisterUser Methods toQuery :: RegisterUser -> QueryString #
AWSRequest RegisterUser Source #
Instance details Defined in Amazonka.QuickSight.RegisterUser Associated Types type AWSResponse RegisterUser # Methods request :: (Service -> Service) -> RegisterUser -> Request RegisterUser # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy RegisterUser -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse RegisterUser))) #
Generic RegisterUser Source #
Instance details Defined in Amazonka.QuickSight.RegisterUser Associated Types type Rep RegisterUser :: Type -> Type # Methods from :: RegisterUser -> Rep RegisterUser x # to :: Rep RegisterUser x -> RegisterUser #
Read RegisterUser Source #
Instance details Defined in Amazonka.QuickSight.RegisterUser Methods readsPrec :: Int -> ReadS RegisterUser # readList :: ReadS [RegisterUser] # readPrec :: ReadPrec RegisterUser # readListPrec :: ReadPrec [RegisterUser] #
Show RegisterUser Source #
Instance details Defined in Amazonka.QuickSight.RegisterUser Methods showsPrec :: Int -> RegisterUser -> ShowS # show :: RegisterUser -> String # showList :: [RegisterUser] -> ShowS #
NFData RegisterUser Source #
Instance details Defined in Amazonka.QuickSight.RegisterUser Methods rnf :: RegisterUser -> () #
Eq RegisterUser Source #
Instance details Defined in Amazonka.QuickSight.RegisterUser Methods (==) :: RegisterUser -> RegisterUser -> Bool # (/=) :: RegisterUser -> RegisterUser -> Bool #
Hashable RegisterUser Source #
Instance details Defined in Amazonka.QuickSight.RegisterUser Methods hashWithSalt :: Int -> RegisterUser -> Int # hash :: RegisterUser -> Int #
type AWSResponse RegisterUser Source #
Instance details Defined in Amazonka.QuickSight.RegisterUser type AWSResponse RegisterUser = RegisterUserResponse
type Rep RegisterUser Source #
Instance details Defined in Amazonka.QuickSight.RegisterUser type Rep RegisterUser = D1 ('MetaData "RegisterUser" "Amazonka.QuickSight.RegisterUser" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "RegisterUser'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "customFederationProviderUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "customPermissionsName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "externalLoginFederationProviderType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :: (S1 ('MetaSel ('Just "externalLoginId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "iamArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "sessionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))))) :: ((S1 ('MetaSel ('Just "userName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "identityType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 IdentityType) :: S1 ('MetaSel ('Just "email") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))) :: (S1 ('MetaSel ('Just "userRole") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 UserRole) :: (S1 ('MetaSel ('Just "awsAccountId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "namespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newRegisterUser Source #

Arguments

:: IdentityType	`RegisterUser`
-> Text	`RegisterUser`
-> UserRole	`$sel:userRole:RegisterUser'`
-> Text	`RegisterUser`
-> Text	`RegisterUser`
-> RegisterUser

Create a value of RegisterUser with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:customFederationProviderUrl:RegisterUser', registerUser_customFederationProviderUrl - 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.

RegisterUser, registerUser_customPermissionsName - (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.

RegisterUser, registerUser_externalLoginFederationProviderType - 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.

RegisterUser, registerUser_externalLoginId - The identity ID for a user in the external login provider.

$sel:iamArn:RegisterUser', registerUser_iamArn - The ARN of the IAM user or role that you are registering with Amazon QuickSight.

$sel:sessionName:RegisterUser', registerUser_sessionName - 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.

RegisterUser, registerUser_userName - The Amazon QuickSight user name that you want to create for the user you are registering.

RegisterUser, registerUser_identityType - 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.

RegisterUser, registerUser_email - The email address of the user that you want to register.

$sel:userRole:RegisterUser', registerUser_userRole - 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.

RegisterUser, registerUser_awsAccountId - 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.

RegisterUser, registerUser_namespace - The namespace. Currently, you should set this to default.

Request Lenses

registerUser_customFederationProviderUrl :: Lens' RegisterUser (Maybe Text) Source #

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.

registerUser_customPermissionsName :: Lens' RegisterUser (Maybe Text) Source #

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

registerUser_externalLoginFederationProviderType :: Lens' RegisterUser (Maybe Text) Source #

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.

registerUser_externalLoginId :: Lens' RegisterUser (Maybe Text) Source #

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

registerUser_iamArn :: Lens' RegisterUser (Maybe Text) Source #

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

registerUser_sessionName :: Lens' RegisterUser (Maybe Text) Source #

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.

registerUser_userName :: Lens' RegisterUser (Maybe Text) Source #

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

registerUser_identityType :: Lens' RegisterUser IdentityType Source #

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.

registerUser_email :: Lens' RegisterUser Text Source #

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

registerUser_userRole :: Lens' RegisterUser UserRole Source #

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.

registerUser_awsAccountId :: Lens' RegisterUser Text Source #

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.

registerUser_namespace :: Lens' RegisterUser Text Source #

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

Destructuring the Response

data RegisterUserResponse Source #

See: newRegisterUserResponse smart constructor.

Constructors

RegisterUserResponse'
Fields requestId :: Maybe Text The Amazon Web Services request ID for this operation. user :: Maybe User The user's user name. userInvitationUrl :: Maybe Text The URL the user visits to complete registration and provide a password. This is returned only for users with an identity type of `QUICKSIGHT`. status :: Int The HTTP status of the request.

Instances

Instances details

Generic RegisterUserResponse Source #
Instance details Defined in Amazonka.QuickSight.RegisterUser Associated Types type Rep RegisterUserResponse :: Type -> Type # Methods from :: RegisterUserResponse -> Rep RegisterUserResponse x # to :: Rep RegisterUserResponse x -> RegisterUserResponse #
Read RegisterUserResponse Source #
Instance details Defined in Amazonka.QuickSight.RegisterUser Methods readsPrec :: Int -> ReadS RegisterUserResponse # readList :: ReadS [RegisterUserResponse] # readPrec :: ReadPrec RegisterUserResponse # readListPrec :: ReadPrec [RegisterUserResponse] #
Show RegisterUserResponse Source #
Instance details Defined in Amazonka.QuickSight.RegisterUser Methods showsPrec :: Int -> RegisterUserResponse -> ShowS # show :: RegisterUserResponse -> String # showList :: [RegisterUserResponse] -> ShowS #
NFData RegisterUserResponse Source #
Instance details Defined in Amazonka.QuickSight.RegisterUser Methods rnf :: RegisterUserResponse -> () #
Eq RegisterUserResponse Source #
Instance details Defined in Amazonka.QuickSight.RegisterUser Methods (==) :: RegisterUserResponse -> RegisterUserResponse -> Bool # (/=) :: RegisterUserResponse -> RegisterUserResponse -> Bool #
type Rep RegisterUserResponse Source #
Instance details Defined in Amazonka.QuickSight.RegisterUser type Rep RegisterUserResponse = D1 ('MetaData "RegisterUserResponse" "Amazonka.QuickSight.RegisterUser" "amazonka-quicksight-2.0-9P6nV9koXl6GTlt8ZjS7C9" 'False) (C1 ('MetaCons "RegisterUserResponse'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "requestId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "user") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe User))) :: (S1 ('MetaSel ('Just "userInvitationUrl") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "status") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newRegisterUserResponse Source #

Arguments

:: Int	`RegisterUserResponse`
-> RegisterUserResponse

Create a value of RegisterUserResponse with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:requestId:RegisterUserResponse', registerUserResponse_requestId - The Amazon Web Services request ID for this operation.

$sel:user:RegisterUserResponse', registerUserResponse_user - The user's user name.

$sel:userInvitationUrl:RegisterUserResponse', registerUserResponse_userInvitationUrl - The URL the user visits to complete registration and provide a password. This is returned only for users with an identity type of QUICKSIGHT.

RegisterUserResponse, registerUserResponse_status - The HTTP status of the request.

Response Lenses

registerUserResponse_requestId :: Lens' RegisterUserResponse (Maybe Text) Source #

The Amazon Web Services request ID for this operation.

registerUserResponse_user :: Lens' RegisterUserResponse (Maybe User) Source #

The user's user name.

registerUserResponse_userInvitationUrl :: Lens' RegisterUserResponse (Maybe Text) Source #

The URL the user visits to complete registration and provide a password. This is returned only for users with an identity type of QUICKSIGHT.

registerUserResponse_status :: Lens' RegisterUserResponse Int Source #

The HTTP status of the request.