RegisterUserRequest (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.core.SdkRequest
- - software.amazon.awssdk.awscore.AwsRequest
  - - software.amazon.awssdk.services.quicksight.model.QuickSightRequest
    - - software.amazon.awssdk.services.quicksight.model.RegisterUserRequest

All Implemented Interfaces:: SdkPojo, ToCopyableBuilder<RegisterUserRequest.Builder,RegisterUserRequest>

@Generated(value="software.amazon.awssdk:codegen")
public final class RegisterUserRequest
extends QuickSightRequest
implements ToCopyableBuilder<RegisterUserRequest.Builder,RegisterUserRequest>

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface RegisterUserRequest.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`RegisterUserRequest.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`awsAccountId()` The ID for the Amazon Web Services account that the user is in.
`static RegisterUserRequest.Builder`	`builder()`
`String`	`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.
`String`	`customPermissionsName()` (Enterprise edition only) The name of the custom permissions profile that you want to assign to this user.
`String`	`email()` The email address of the user that you want to register.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`String`	`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.
`String`	`externalLoginId()` The identity ID for a user in the external login provider.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`int`	`hashCode()`
`String`	`iamArn()` The ARN of the IAM user or role that you are registering with Amazon QuickSight.
`IdentityType`	`identityType()` Amazon QuickSight supports several ways of managing the identity of users.
`String`	`identityTypeAsString()` Amazon QuickSight supports several ways of managing the identity of users.
`String`	`namespace()` The namespace.
`List<SdkField<?>>`	`sdkFields()`
`static Class<? extends RegisterUserRequest.Builder>`	`serializableBuilderClass()`
`String`	`sessionName()` You need to use this parameter only when you register one or more users using an assumed IAM role.
`RegisterUserRequest.Builder`	`toBuilder()`
`String`	`toString()` Returns a string representation of this object.
`String`	`userName()` The Amazon QuickSight user name that you want to create for the user you are registering.
`UserRole`	`userRole()` The Amazon QuickSight role for the user.
`String`	`userRoleAsString()` The Amazon QuickSight role for the user.

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - identityType
```
public final 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.
    If the service returns an enum value that is not available in the current SDK version, identityType will return IdentityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from identityTypeAsString().
    Returns:
    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.
    See Also:
    
    IdentityType
  - identityTypeAsString
```
public final String identityTypeAsString()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, identityType will return IdentityType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from identityTypeAsString().
    Returns:
    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.
    See Also:
    
    IdentityType
  - email
```
public final String email()
```
    The email address of the user that you want to register.
    
    Returns:
    
    The email address of the user that you want to register.
  - userRole
```
public final 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.
    If the service returns an enum value that is not available in the current SDK version, userRole will return UserRole.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from userRoleAsString().
    Returns:
    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.
    See Also:
    
    UserRole
  - userRoleAsString
```
public final String userRoleAsString()
```
    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.
    If the service returns an enum value that is not available in the current SDK version, userRole will return UserRole.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from userRoleAsString().
    Returns:
    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.
    See Also:
    
    UserRole
  - iamArn
```
public final String iamArn()
```
    The ARN of the IAM user or role that you are registering with Amazon QuickSight.
    
    Returns:
    
    The ARN of the IAM user or role that you are registering with Amazon QuickSight.
  - sessionName
```
public final String 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.
    
    Returns:
    
    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.
  - awsAccountId
```
public final String 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.
    
    Returns:
    
    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
```
public final String namespace()
```
    The namespace. Currently, you should set this to default.
    
    Returns:
    
    The namespace. Currently, you should set this to default.
  - userName
```
public final String userName()
```
    The Amazon QuickSight user name that you want to create for the user you are registering.
    
    Returns:
    
    The Amazon QuickSight user name that you want to create for the user you are registering.
  - customPermissionsName
```
public final String 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.
    Returns:
    (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
```
public final String 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.
    Returns:
    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.
  - customFederationProviderUrl
```
public final String 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.
    
    Returns:
    
    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.
  - externalLoginId
```
public final String externalLoginId()
```
    The identity ID for a user in the external login provider.
    
    Returns:
    
    The identity ID for a user in the external login provider.
  - toBuilder
```
public RegisterUserRequest.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<RegisterUserRequest.Builder,RegisterUserRequest>
    
    Specified by:
    
    toBuilder in class QuickSightRequest
  - builder
```
public static RegisterUserRequest.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends RegisterUserRequest.Builder> serializableBuilderClass()
```
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class AwsRequest
  - equals
```
public final boolean equals(Object obj)
```
    Overrides:
    
    equals in class AwsRequest
  - equalsBySdkFields
```
public final boolean equalsBySdkFields(Object obj)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - toString
```
public final String toString()
```
    Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
    
    Overrides:
    
    toString in class Object
  - getValueForField
```
public final <T> Optional<T> getValueForField(String fieldName,
                                              Class<T> clazz)
```
    Overrides:
    
    getValueForField in class SdkRequest
  - sdkFields
```
public final List<SdkField<?>> sdkFields()
```
    Specified by:
    
    sdkFields in interface SdkPojo

Class RegisterUserRequest

Nested Class Summary

Method Summary

Methods inherited from class software.amazon.awssdk.awscore.AwsRequest

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

identityType

identityTypeAsString

email

userRole

userRoleAsString

iamArn

sessionName

awsAccountId

namespace

userName

customPermissionsName

externalLoginFederationProviderType

customFederationProviderUrl

externalLoginId

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields