As traduções são geradas por tradução automática. Em caso de conflito entre o conteúdo da tradução e da versão original em inglês, a versão em inglês prevalecerá. # RegisterUser Cria uma Amazon QuickSight , cuja identidade é associada aoAWS Identity and Access Managementidentidade ou função (IAM) especificada na solicitação. ## Sintaxe da solicitação ``` 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 da solicitação de URI A solicitação usa os parâmetros de URI a seguir. ** [AwsAccountId](#API_RegisterUser_RequestSyntax) ** A ID doAWSconta na qual o usuário está. Atualmente, você usa o ID para oAWSconta da que contém sua Amazon QuickSight conta. Restrições de tamanho: Tamanho fixo de 12. Padrão: `^[0-9]{12}$` Obrigatório: Sim ** [Namespace](#API_RegisterUser_RequestSyntax) ** O namespace. No momento, é necessário definir isso como`default`. Restrições de tamanho: Tamanho máximo de 64. Padrão: `^[a-zA-Z0-9._-]*$` Obrigatório: Sim ## Corpo da solicitação A solicitação aceita os dados a seguir no formato JSON. ** [Email](#API_RegisterUser_RequestSyntax) ** O endereço de e-mail do usuário que você deseja registrar. Type: String Obrigatório: Sim ** [IdentityType](#API_RegisterUser_RequestSyntax) ** Amazônia QuickSight O oferece suporte a várias maneiras de gerenciar a identidade dos usuários. Esse parâmetro aceita dois valores: + `IAM`: um usuário cuja identidade é mapeada para um usuário ou função do IAM existente. + `QUICKSIGHT`: Um usuário cuja identidade pertence e é gerenciada internamente pela Amazon QuickSight. Type: String Valores válidos:` IAM | QUICKSIGHT` Obrigatório: Sim ** [UserRole](#API_RegisterUser_RequestSyntax) ** A Amazon QuickSight função para o usuário. A função de usuário pode ser uma das partes a seguir: + `READER`: obrigatório + `AUTHOR`: um usuário que pode criar fontes de dados, conjuntos de dados, análises e painéis. + `ADMIN`: Um usuário que é autor, que também pode gerenciar a Amazon QuickSightConfigurações do . + `RESTRICTED_READER`: essa função não está disponível para uso no momento. + `RESTRICTED_AUTHOR`: essa função não está disponível para uso no momento. Type: String Valores válidos:` ADMIN | AUTHOR | READER | RESTRICTED_AUTHOR | RESTRICTED_READER` Obrigatório: Sim ** [CustomFederationProviderUrl](#API_RegisterUser_RequestSyntax) ** A URL do provedor OpenID Connect (OIDC) personalizado que fornece identidade para permitir que um usuário se federar na Amazon QuickSight com umAWS Identity and Access Management(IAM) do Esse parâmetro só deve ser usado quando`ExternalLoginFederationProviderType`está definido como`CUSTOM_OIDC`. Type: String Obrigatório: Não ** [CustomPermissionsName](#API_RegisterUser_RequestSyntax) ** (Somente edição Enterprise) O nome do perfil de permissões personalizadas que você deseja atribuir a esse usuário. As permissões personalizadas permitem controlar o acesso de um usuário restringindo o acesso às seguintes operações: + Criar e atualizar fontes de dados + Crie e atualize conjuntos de dados + Criar e atualizar relatórios por e-mail + Assinar relatórios por e-mail Para adicionar permissões personalizadas a um usuário existente, use` [UpdateUser](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_UpdateUser.html) `em vez disso. Um conjunto de permissões personalizadas inclui qualquer combinação dessas restrições. Atualmente, você precisa criar os nomes de perfil para conjuntos de permissões personalizados usando a Amazon QuickSightconsole do . Em seguida, use o`RegisterUser`Operação de API para atribuir o conjunto nomeado de permissões a uma Amazon QuickSight usuário. Amazônia QuickSight permissões personalizadas são aplicadas por meio de políticas do IAM. Portanto, eles substituem as permissões normalmente concedidas pela atribuição da Amazon QuickSight usuários para uma das coortes de segurança padrão na Amazon QuickSight (administrador, autor, leitor). Esse recurso está disponível somente na Amazon QuickSight Assinaturas da Enterprise Edition. Type: String Restrições de tamanho: Tamanho mínimo de 1. Tamanho máximo de 64. Padrão: `^[a-zA-Z0-9+=,.@_-]+$` Obrigatório: Não ** [ExternalLoginFederationProviderType](#API_RegisterUser_RequestSyntax) ** O tipo de provedor de login externo compatível que fornece identidade para permitir que um usuário faça a federação na Amazon QuickSight com umAWS Identity and Access Management(IAM) do O tipo de provedor de login externo com suporte pode ser um dos seguintes. + `COGNITO`: Amazon Cognito. O URL do provedor é cognito-identity.amazonaws.com. Ao escolher o`COGNITO`tipo de provedor, não use o”CustomFederationProviderUrl“que só é necessário quando o provedor externo é personalizado. + `CUSTOM_OIDC`: obrigatório OpenID Connect (OIDC). Ao escolher`CUSTOM_OIDC`digite, use o`CustomFederationProviderUrl`para fornecer a URL do provedor OIDC personalizada. Type: String Obrigatório: Não ** [ExternalLoginId](#API_RegisterUser_RequestSyntax) ** O ID de identidade de um usuário no provedor de login externo. Type: String Obrigatório: Não ** [IamArn](#API_RegisterUser_RequestSyntax) ** O ARN do usuário ou função do IAM que você está registrando na Amazon QuickSight. Type: String Obrigatório: Não ** [SessionName](#API_RegisterUser_RequestSyntax) ** Você precisa usar esse parâmetro somente ao registrar um ou mais usuários usando uma função presumida do IAM. Você não precisa fornecer o nome da sessão para outros cenários, por exemplo, ao registrar um usuário do IAM ou uma Amazon QuickSight usuário. Você pode registrar vários usuários usando a mesma função do IAM se cada usuário tiver um nome de sessão diferente. Para obter mais informações sobre como assumir funções do IAM, consulte[https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html](https://docs.aws.amazon.com/cli/latest/reference/sts/assume-role.html)no* AWS CLIReferência.* Type: String Restrições de tamanho: Tamanho mínimo de 2. Tamanho máximo de 64. Padrão: `[\w+=.@-]*` Obrigatório: Não ** [UserName](#API_RegisterUser_RequestSyntax) ** A Amazon QuickSight nome de usuário que você deseja criar para o usuário que está registrando. Type: String Restrições de tamanho: Tamanho mínimo de 1. Padrão: `[\u0020-\u00FF]+` Obrigatório: Não ## Sintaxe da resposta ``` 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 resposta Se a ação for bem-sucedida, o serviço retornará a resposta HTTP a seguir. ** [Status](#API_RegisterUser_ResponseSyntax) ** O status HTTP da solicitação. Os seguintes dados são retornados no formato JSON pelo serviço. ** [RequestId](#API_RegisterUser_ResponseSyntax) ** OAWSID da solicitação para essa operação. Type: String ** [User](#API_RegisterUser_ResponseSyntax) ** O nome do usuário. Tipo: objeto [User](API_User.md) ** [UserInvitationUrl](#API_RegisterUser_ResponseSyntax) ** O URL que o usuário visita para concluir o registro e fornecer uma senha. Isso é retornado somente para usuários com um tipo de identidade de`QUICKSIGHT`. Type: String ## Erros Para obter informações sobre os erros que são comuns a todas as ações, consulte[Erros comuns](CommonErrors.md). ** AccessDeniedException ** Você não tem acesso a esse item. Não foi possível validar as credenciais fornecidas. Talvez você não tenha permissão para executar a solicitação. Verifique se sua conta está autorizada a usar a Amazon QuickSight , se as suas políticas têm as permissões corretas e se você está usando as chaves de acesso corretas. Código de status HTTP: 401 ** InternalFailureException ** Ocorreu um erro interno. Código de status HTTP: 500 ** InvalidParameterValueException ** Um ou mais parâmetros têm um valor que não é válido. Código de status HTTP: 400 ** LimitExceededException ** Um limite foi excedido. Código de status HTTP: 409 ** PreconditionNotMetException ** Uma ou mais pré-condições não foram atendidas. Código de status HTTP: 400 ** ResourceExistsException ** O recurso especificado já existe. Código de status HTTP: 409 ** ResourceNotFoundException ** Não foi possível encontrar um ou mais recursos. Código de status HTTP: 404 ** ResourceUnavailableException ** Este recurso está indisponível no momento. Código de status HTTP: 503 ** ThrottlingException ** O acesso é limitado. Código de status HTTP: 429 ## Consulte também Para obter mais informações sobre como usar essa API em um dos AWS SDKs específicos de linguagem, consulte o seguinte: + [AWS Command Line Interface](https://docs.aws.amazon.com/goto/aws-cli/quicksight-2018-04-01/RegisterUser) + [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/quicksight-2018-04-01/RegisterUser) + [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/quicksight-2018-04-01/RegisterUser) + [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/quicksight-2018-04-01/RegisterUser) + [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/quicksight-2018-04-01/RegisterUser) + [AWSSDK da para JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/quicksight-2018-04-01/RegisterUser) + [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/quicksight-2018-04-01/RegisterUser) + [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/quicksight-2018-04-01/RegisterUser) + [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/quicksight-2018-04-01/RegisterUser)