

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

# UpdateUser
<a name="API_UpdateUser"></a>

Atualiza uma Amazon QuickSight usuário.

## Sintaxe da solicitação
<a name="API_UpdateUser_RequestSyntax"></a>

```
PUT /accounts/AwsAccountId/namespaces/Namespace/users/UserName HTTP/1.1
Content-type: application/json

{
   "CustomFederationProviderUrl": "string",
   "CustomPermissionsName": "string",
   "Email": "string",
   "ExternalLoginFederationProviderType": "string",
   "ExternalLoginId": "string",
   "Role": "string",
   "UnapplyCustomPermissions": boolean
}
```

## Parâmetros da solicitação de URI
<a name="API_UpdateUser_RequestParameters"></a>

A solicitação usa os parâmetros de URI a seguir.

 ** [AwsAccountId](#API_UpdateUser_RequestSyntax) **   <a name="QS-UpdateUser-request-AwsAccountId"></a>
A ID doAWSconta na qual o usuário está. Atualmente, você usa o ID para oAWSconta que contém a Amazon QuickSight conta.  
Restrições de comprimento: Comprimento fixo de 12.  
Padrão: `^[0-9]{12}$`   
Obrigatório: Sim

 ** [Namespace](#API_UpdateUser_RequestSyntax) **   <a name="QS-UpdateUser-request-Namespace"></a>
O namespace. No momento, é necessário definir isso como`default`.  
Restrições de comprimento: Tamanho máximo de 64.  
Padrão: `^[a-zA-Z0-9._-]*$`   
Obrigatório: Sim

 ** [UserName](#API_UpdateUser_RequestSyntax) **   <a name="QS-UpdateUser-request-UserName"></a>
A Amazon QuickSight nome de usuário que você deseja atualizar.  
Restrições de comprimento: Tamanho mínimo de 1.  
Padrão: `[\u0020-\u00FF]+`   
Obrigatório: Sim

## Corpo da solicitação
<a name="API_UpdateUser_RequestBody"></a>

A solicitação aceita os dados a seguir no formato JSON.

 ** [Email](#API_UpdateUser_RequestSyntax) **   <a name="QS-UpdateUser-request-Email"></a>
O endereço de e-mail do usuário que você deseja atualizar.  
Type: String  
Obrigatório: Sim

 ** [Role](#API_UpdateUser_RequestSyntax) **   <a name="QS-UpdateUser-request-Role"></a>
A Amazon QuickSight função do usuário. A função pode ser uma das seguintes coortes de segurança padrão:  
+  `READER`: obrigatório acesso somente leitura aos painéis.
+  `AUTHOR`: obrigatório criar fontes de dados, análises e painéis.
+  `ADMIN`: Um usuário que é autor, que também pode gerenciar a Amazon QuickSightConfigurações do .
O nome da Amazon QuickSight é invisível para o usuário, exceto pelas telas do console que lidam com permissões.  
Type: String  
Valores válidos:` ADMIN | AUTHOR | READER | RESTRICTED_AUTHOR | RESTRICTED_READER`   
Obrigatório: Sim

 ** [CustomFederationProviderUrl](#API_UpdateUser_RequestSyntax) **   <a name="QS-UpdateUser-request-CustomFederationProviderUrl"></a>
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). Esse parâmetro só deve ser usado quando`ExternalLoginFederationProviderType`está definido como`CUSTOM_OIDC`.  
Type: String  
Obrigatório: Não

 ** [CustomPermissionsName](#API_UpdateUser_RequestSyntax) **   <a name="QS-UpdateUser-request-CustomPermissionsName"></a>
(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
+ Crie e e atualize relatórios por e-mail
+ Assinar relatórios por e-mail
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, é necessário`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 para Amazon QuickSight Assinaturas da Enterprise Edition.  
Type: String  
Restrições de comprimento: Tamanho mínimo de 1. Tamanho máximo de 64.  
Padrão: `^[a-zA-Z0-9+=,.@_-]+$`   
Obrigatório: Não

 ** [ExternalLoginFederationProviderType](#API_UpdateUser_RequestSyntax) **   <a name="QS-UpdateUser-request-ExternalLoginFederationProviderType"></a>
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). O tipo de provedor de login externo compatível 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 personalizado.
+  `NONE`: isso limpa todas as informações de login externas salvas anteriormente para um usuário. Usar a` [DescribeUser](https://docs.aws.amazon.com/quicksight/latest/APIReference/API_DescribeUser.html) `Operação da API para verificar as informações de login externo.
Type: String  
Obrigatório: Não

 ** [ExternalLoginId](#API_UpdateUser_RequestSyntax) **   <a name="QS-UpdateUser-request-ExternalLoginId"></a>
O ID de identidade de um usuário no provedor de login externo.  
Type: String  
Obrigatório: Não

 ** [UnapplyCustomPermissions](#API_UpdateUser_RequestSyntax) **   <a name="QS-UpdateUser-request-UnapplyCustomPermissions"></a>
Um sinalizador que você usa para indicar que deseja remover todas as permissões personalizadas desse usuário. O uso desse parâmetro redefine o usuário para o estado em que estava antes da aplicação de um perfil de permissões personalizado. O padrão desse parâmetro é NULL e não aceita nenhum outro valor.  
Type: Booliano  
Obrigatório: Não

## Sintaxe da resposta
<a name="API_UpdateUser_ResponseSyntax"></a>

```
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"
   }
}
```

## Elementos de resposta
<a name="API_UpdateUser_ResponseElements"></a>

Se a ação for bem-sucedida, o serviço retornará a resposta HTTP a seguir.

 ** [Status](#API_UpdateUser_ResponseSyntax) **   <a name="QS-UpdateUser-response-Status"></a>
O status HTTP da solicitação.

Os seguintes dados são retornados no formato JSON pelo serviço.

 ** [RequestId](#API_UpdateUser_ResponseSyntax) **   <a name="QS-UpdateUser-response-RequestId"></a>
OAWSID da solicitação para essa operação.  
Type: String

 ** [User](#API_UpdateUser_ResponseSyntax) **   <a name="QS-UpdateUser-response-User"></a>
A Amazon QuickSight usuário.  
Tipo: objeto [User](API_User.md)

## Erros
<a name="API_UpdateUser_Errors"></a>

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

 ** PreconditionNotMetException **   
Uma ou mais pré-condições não foram atendidas.  
Código de status HTTP: 400

 ** 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
<a name="API_UpdateUser_SeeAlso"></a>

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/UpdateUser) 
+  [AWS SDK for .NET](https://docs.aws.amazon.com/goto/DotNetSDKV3/quicksight-2018-04-01/UpdateUser) 
+  [AWS SDK for C\$1\$1](https://docs.aws.amazon.com/goto/SdkForCpp/quicksight-2018-04-01/UpdateUser) 
+  [AWS SDK for Go](https://docs.aws.amazon.com/goto/SdkForGoV1/quicksight-2018-04-01/UpdateUser) 
+  [AWS SDK para Java V2](https://docs.aws.amazon.com/goto/SdkForJavaV2/quicksight-2018-04-01/UpdateUser) 
+  [AWSSDK para JavaScript](https://docs.aws.amazon.com/goto/AWSJavaScriptSDK/quicksight-2018-04-01/UpdateUser) 
+  [AWS SDK para PHP V3](https://docs.aws.amazon.com/goto/SdkForPHPV3/quicksight-2018-04-01/UpdateUser) 
+  [AWS SDK para Python](https://docs.aws.amazon.com/goto/boto3/quicksight-2018-04-01/UpdateUser) 
+  [AWS SDK for Ruby V3](https://docs.aws.amazon.com/goto/SdkForRubyV3/quicksight-2018-04-01/UpdateUser) 