RegisterUser - Amazon QuickSight
Sintaxis de la solicitudParámetros de solicitud del URICuerpo de la solicitudSintaxis de la respuestaElementos de respuestaErroresVéase también

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

RegisterUser

Crea un Amazon QuickSight ,AWS Identity and Access Management(IAM) o función especificada en la solicitud.

Sintaxis de la solicitud

POST /accounts/AwsAccountId/namespaces/Namespace/users HTTP/1.1
Content-type: application/json

{
   "CustomFederationProviderUrl": "string",
   "CustomPermissionsName": "string",
   "Email": "string",
   "ExternalLoginFederationProviderType": "string",
   "ExternalLoginId": "string",
   "IamArn": "string",
   "IdentityType": "string",
   "SessionName": "string",
   "UserName": "string",
   "UserRole": "string"
}

Parámetros de solicitud del URI

La solicitud utiliza los siguientes parámetros URI.

AwsAccountId

El ID deAWScuenta en la que se encuentra el usuario. En la actualidad, utilizas el ID para elAWScuenta que contiene su QuickSight account.

Limitaciones de longitud Longitud fija de 12.

Patrón: ^[0-9]{12}$

Obligatorio Sí

Namespace

El espacio de nombres. Actualmente, debe establecer esto endefault.

Limitaciones de longitud La longitud máxima es 64.

Patrón: ^[a-zA-Z0-9._-]*$

Obligatorio Sí

Cuerpo de la solicitud

La solicitud acepta los siguientes datos en formato JSON.

Email

La dirección de correo electrónico del usuario que desea registrar.

Type: Cadena

Obligatorio Sí

IdentityType

Amazon QuickSight admite varias formas de gestionar la identidad de los usuarios. Este parámetro acepta dos valores:

  • IAM: usuario cuya identidad se asigna a un usuario o rol de IAM existente.

  • QUICKSIGHT: un usuario cuya identidad es propiedad de Amazon y la gestiona internamente QuickSight.

Type: Cadena

Valores válidos: IAM | QUICKSIGHT

Obligatorio Sí

UserRole

El Amazon QuickSight rol de para el usuario. La rol de usuario puede ser uno de los siguientes:

  • READER:

  • AUTHOR: Un usuario que puede crear orígenes de datos, conjuntos de datos, análisis y paneles.

  • ADMIN: un usuario que es autor y que también puede gestionar Amazon QuickSightConfiguración del .

  • RESTRICTED_READER: esta función no está disponible actualmente para su uso.

  • RESTRICTED_AUTHOR: esta función no está disponible actualmente para su uso.

Type: Cadena

Valores válidos: ADMIN | AUTHOR | READER | RESTRICTED_AUTHOR | RESTRICTED_READER

Obligatorio Sí

CustomFederationProviderUrl

La URL del proveedor de OpenID Connect (OIDC) personalizado que proporciona identidad para permitir que un usuario se federe en Amazon QuickSight conAWS Identity and Access Management(IAM). Este parámetro solo se debe usar cuandoExternalLoginFederationProviderTypese establece enCUSTOM_OIDC.

Type: Cadena

Obligatorio No

CustomPermissionsName

(Solo en la edición Enterprise) El nombre del perfil de permisos personalizados que desea asignar a este usuario. Los permisos personalizados le permiten controlar el acceso de un usuario restringiendo el acceso a las siguientes operaciones:

  • Crear y actualizar fuentes de datos

  • Crear y actualizar conjuntos de datos

  • Creación y actualización de informes

  • Suscribirse a informes

Para añadir permisos personalizados a un usuario existente, utilice UpdateUser instead.

Un conjunto de permisos personalizados incluye cualquier combinación de estas restricciones. Actualmente, debe crear los nombres de perfil para los conjuntos de permisos personalizados mediante Amazon QuickSightconsola de . ARegisterUserOperación de API para asignar el conjunto de permisos con nombre a un Amazon QuickSight usuario.

Amazon QuickSight Los permisos personalizados se aplican a través de políticas de IAM. Por lo tanto, anulan los permisos que normalmente se conceden mediante la asignación de Amazon QuickSight usuarios a una de las cohortes de seguridad predeterminadas de Amazon QuickSight (administrador, autor, lector).

Esta característica solo está disponible en Amazon QuickSight Susricciones

Type: Cadena

Limitaciones de longitud Longitud mínima de 1. La longitud máxima es 64.

Patrón: ^[a-zA-Z0-9+=,.@_-]+$

Obligatorio No

ExternalLoginFederationProviderType

El tipo de proveedor de inicio de sesión externo compatible que proporciona identidad para permitir que un usuario se federe en Amazon QuickSight conAWS Identity and Access Management(IAM). El tipo de proveedor de inicio de sesión externo compatible puede ser uno de los siguientes.

  • COGNITOAmazon Cognito La URL del proveedor es cognito-identity.amazonaws.com. Al elegir elCOGNITOtipo de proveedor, no utilice el»CustomFederationProviderUrl«que solo se necesita cuando el proveedor externo es personalizado.

  • CUSTOM_OIDCOpenID Al elegirCUSTOM_OIDCescriba, utilice elCustomFederationProviderUrlpara proporcionar la URL del proveedor OIDC.

Type: Cadena

Obligatorio No

ExternalLoginId

El ID de identidad de un usuario en el proveedor de inicio de sesión externo.

Type: Cadena

Obligatorio No

IamArn

El ARN del usuario o rol de IAM que está registrando en Amazon QuickSight.

Type: Cadena

Obligatorio No

SessionName

Debe usar este parámetro solo cuando registre uno o más usuarios con una función de IAM asumida. No necesita proporcionar el nombre de la sesión para otras situaciones, por ejemplo, cuando registra un usuario de IAM o un Amazon QuickSight usuario. Puede registrar varios usuarios con el mismo rol de IAM si cada usuario tiene un nombre de sesión diferente. Para obtener más información acerca de cómo asumir roles de IAM, consulteassume-roleen la AWS CLI Reference.

Type: Cadena

Limitaciones de longitud Longitud mínima de 2. La longitud máxima es 64.

Patrón: [\w+=.@-]*

Obligatorio No

UserName

El Amazon QuickSight nombre de usuario que desea crear para el usuario que está registrando.

Type: Cadena

Limitaciones de longitud Longitud mínima de 1.

Patrón: [\u0020-\u00FF]+

Obligatorio No

Sintaxis de la respuesta

HTTP/1.1 Status
Content-type: application/json

{
   "RequestId": "string",
   "User": { 
      "Active": boolean,
      "Arn": "string",
      "CustomPermissionsName": "string",
      "Email": "string",
      "ExternalLoginFederationProviderType": "string",
      "ExternalLoginFederationProviderUrl": "string",
      "ExternalLoginId": "string",
      "IdentityType": "string",
      "PrincipalId": "string",
      "Role": "string",
      "UserName": "string"
   },
   "UserInvitationUrl": "string"
}

Elementos de respuesta

Si la acción se realiza correctamente, el servicio devuelve la siguiente respuesta HTTP.

Status

El estado HTTP de la solicitud.

El servicio devuelve los datos siguientes en formato JSON.

RequestId

LaAWSID de solicitud para esta operación.

Type: Cadena

User

El nombre del usuario.

Tipo: objeto User

UserInvitationUrl

La URL que visita el usuario para completar el registro y proporcionar una contraseña. Esto se devuelve solo para los usuarios con un tipo de identidad deQUICKSIGHT.

Type: Cadena

Errores

Para obtener información sobre los errores que son comunes a todas las acciones, consulteErrores comunes.

AccessDeniedException

No tiene permiso de acceso a este artículo. La credenciales proporcionadas no se pudieron validar. Es posible que no tenga autorización para realizar la solicitud. Asegúrese de que su cuenta esté autorizada para usar Amazon QuickSight , que las políticas tienen los permisos correctos y que está utilizando las claves de acceso correctas.

Código de estado HTTP: 401

InternalFailureException

Se produjo un error interno.

Código de estado HTTP: 500

InvalidParameterValueException

Uno o más parámetros tienen un valor que no es válido.

Código de estado HTTP: 400

LimitExceededException

Se superó un límite.

Código de estado HTTP: 409

PreconditionNotMetException

No se cumplen una o varias condiciones previas.

Código de estado HTTP: 400

ResourceExistsException

El recurso especificado ya existe.

Código de estado HTTP: 409

ResourceNotFoundException

No se encontraron uno o varios recursos.

Código de estado HTTP: 404

ResourceUnavailableException

Este recurso no está disponible en este momento.

Código de estado HTTP: 503

ThrottlingException

El acceso está limitado.

Código de estado HTTP: 429

Véase también

Para obtener más información sobre el uso de esta API en un SDK de AWS de un lenguaje específico, consulte: