Skip to content

Register User

quicksight_register_user R Documentation

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

Description

Creates an Amazon QuickSight user whose identity is associated with the Identity and Access Management (IAM) identity or role specified in the request. When you register a new user from the Amazon QuickSight API, Amazon QuickSight generates a registration URL. The user accesses this registration URL to create their account. Amazon QuickSight doesn't send a registration email to users who are registered from the Amazon QuickSight API. If you want new users to receive a registration email, then add those users in the Amazon QuickSight console. For more information on registering a new user in the Amazon QuickSight console, see Inviting users to access Amazon QuickSight.

Usage

quicksight_register_user(IdentityType, Email, UserRole, IamArn,
  SessionName, AwsAccountId, Namespace, UserName, CustomPermissionsName,
  ExternalLoginFederationProviderType, CustomFederationProviderUrl,
  ExternalLoginId, Tags)

Arguments

IdentityType

[required] The identity type that your Amazon QuickSight account uses to manage the identity of users.

Email

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

UserRole

[required] 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.

  • READER_PRO: Reader Pro adds Generative BI capabilities to the Reader role. Reader Pros have access to Amazon Q in Amazon QuickSight, can build stories with Amazon Q, and can generate executive summaries from dashboards.

  • AUTHOR_PRO: Author Pro adds Generative BI capabilities to the Author role. Author Pros can author dashboards with natural language with Amazon Q, build stories with Amazon Q, create Topics for Q&A, and generate executive summaries from dashboards.

  • ADMIN_PRO: Admin Pros are Author Pros who can also manage Amazon QuickSight administrative settings. Admin Pro users are billed at Author Pro pricing.

  • RESTRICTED_READER: This role isn't currently available for use.

  • RESTRICTED_AUTHOR: This role isn't currently available for use.

IamArn

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

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.

AwsAccountId

[required] 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

[required] The namespace. Currently, you should set this to default.

UserName

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

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 update_user 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 register_user 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, admin pro, author pro, reader pro).

This feature is available only to Amazon QuickSight Enterprise edition subscriptions.

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.

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.

ExternalLoginId

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

Tags

The tags to associate with the user.

Value

A list with the following syntax: 

list(
  User = list(
    Arn = "string",
    UserName = "string",
    Email = "string",
    Role = "ADMIN"|"AUTHOR"|"READER"|"RESTRICTED_AUTHOR"|"RESTRICTED_READER"|"ADMIN_PRO"|"AUTHOR_PRO"|"READER_PRO",
    IdentityType = "IAM"|"QUICKSIGHT"|"IAM_IDENTITY_CENTER",
    Active = TRUE|FALSE,
    PrincipalId = "string",
    CustomPermissionsName = "string",
    ExternalLoginFederationProviderType = "string",
    ExternalLoginFederationProviderUrl = "string",
    ExternalLoginId = "string"
  ),
  UserInvitationUrl = "string",
  RequestId = "string",
  Status = 123
)

Request syntax

svc$register_user(
  IdentityType = "IAM"|"QUICKSIGHT"|"IAM_IDENTITY_CENTER",
  Email = "string",
  UserRole = "ADMIN"|"AUTHOR"|"READER"|"RESTRICTED_AUTHOR"|"RESTRICTED_READER"|"ADMIN_PRO"|"AUTHOR_PRO"|"READER_PRO",
  IamArn = "string",
  SessionName = "string",
  AwsAccountId = "string",
  Namespace = "string",
  UserName = "string",
  CustomPermissionsName = "string",
  ExternalLoginFederationProviderType = "string",
  CustomFederationProviderUrl = "string",
  ExternalLoginId = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)