/* * Copyright 2018-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with * the License. A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR * CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions * and limitations under the License. */ package com.amazonaws.services.quicksight.model; import java.io.Serializable; import javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class RegisterUserRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *

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

* */ private String identityType; /** *

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

*/ private String email; /** *

* The Amazon QuickSight role for the user. The user role can be one of the following: *

* */ private String userRole; /** *

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

*/ private String iamArn; /** *

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

*/ private String sessionName; /** *

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

*/ private String awsAccountId; /** *

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

*/ private String namespace; /** *

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

*/ private String userName; /** *

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

* *

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

*/ private String customPermissionsName; /** *

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

* */ private String externalLoginFederationProviderType; /** *

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

*/ private String customFederationProviderUrl; /** *

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

*/ private String externalLoginId; /** *

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

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

*