Skip to main content
Astra Automation
O português é fornecido por meio de tradução automática para sua conveniência. O inglês precede o português em caso de inconsistências.

Modificar um usuário

PDFs

PUT /accounts/{account_id}/core/v1/users/{user_id}

Substitui todo o recurso armazenado pelo corpo da solicitação JSON fornecida, preservando os valores-chave que não podem ser modificados pelo usuário.

Parâmetros

Nome Tipo Em Obrigatório Descrição

id_da_conta

string

caminho

Verdadeiro

ID do recurso de conta que o contém

  • exemplo: {{.Account}}

ID do usuário

string

caminho

Verdadeiro

ID da coleção de usuários a ser listada

Corpo da solicitação

Substitui todo o recurso armazenado pelo corpo da solicitação JSON fornecida, preservando os valores-chave que não podem ser modificados pelo usuário.

Nome Tipo Obrigatório Descrição

tipo

string

Verdadeiro

Tipo de mídia do recurso. Os valores definidos são:

  • "application/astra-user"

versão

string

Verdadeiro

Versão do recurso. Os valores definidos são:

  • "1,0"

  • "1,1"

  • "1,2"

id

string

Falso

Identificador globalmente único do recurso. Os valores definidos são:

  • Em conformidade com o esquema UUIDv4

estado

string

Falso

String JSON contendo um valor que indica o estado operacional do usuário. Os valores definidos são:

  • "pending" - A conta de usuário está em processo de criação. O usuário só pode ler e modificar o recurso de usuário (valor padrão).

  • Este estado não é válido para um usuário com "authProvider" como "local"

  • "ativo" - A conta de usuário está operacional (o usuário pode fazer login se a configuração da conta "isEnabled" estiver definida como "true").

  • Este é o valor padrão para um usuário com "authProvider" como "local"

  • "suspended" - A conta do usuário está suspensa (o usuário não pode fazer login independentemente da configuração "isEnabled" da conta).

isEnabled

string

Falso

String JSON que indica se o usuário tem permissão para fazer login. Os valores definidos são:

  • "true" - O usuário tem permissão para fazer login; valor padrão na criação.

  • "false" - O usuário não tem permissão para fazer login.

ID de autenticação

string

Falso

String JSON contendo o identificador associado a um provedor de identidade externo. O conteúdo desta string depende do authProvider especificado. Para um usuário com "authProvider" como "local", "authID" é definido com o valor "email". Para um usuário com "authProvider" como "ldap", "authID" é definido com seu Nome Distinto (DN) do servidor LDAP.

authProvider

string

Falso

String JSON que indica o contexto do identificador idAuth. Os valores definidos são:

  • "cloud-central" - autenticação do usuário vem do serviço NetApp Cloud Central

  • "local" - a autenticação do usuário vem do armazenamento local de usuário/senha

  • "ldap" - a autenticação do usuário vem de um servidor LDAP externo. No Astra Control Center, todos os usuários devem ter um valor de "local" ou "ldap". Se um valor não for especificado, um valor padrão de "local" será escolhido. No Astra Control Service, "authProvider" como "local" ou "ldap" não é suportado. Se um valor não for especificado, o padrão será "cloud-central".

firstName

string

Falso

String JSON contendo um nome próprio longo especificado pelo usuário. Os valores definidos são:

  • Comprimento mínimo: 0

  • Comprimento máximo: 63

  • Essa string é validada internamente para evitar ataques de XSS, Unicode, travessia de diretório e injeção de SQL

lastName

string

Falso

String JSON contendo um sobrenome completo especificado pelo usuário. Os valores definidos são:

  • Comprimento mínimo: 0

  • Comprimento máximo: 63

  • Essa string é validada internamente para evitar ataques de XSS, Unicode, travessia de diretório e injeção de SQL

companyName

string

Falso

String JSON contendo o nome da empresa associada ao usuário. Se essa chave não existir, indica que nenhum nome de empresa foi fornecido. Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 63

  • Essa string é validada internamente para evitar ataques de XSS, Unicode, travessia de diretório e injeção de SQL

e-mail

string

Falso

Cadeias JSON contendo um endereço de e-mail especificado pelo usuário.

telefone

string

Falso

String JSON contendo o número de telefone do usuário. Se essa chave não existir, indica que nenhum número de telefone foi fornecido.

postalAddress

"postalAddress"

Falso

Objeto JSON contendo um conjunto de campos que especifica um endereço. Se esta chave não existir, indica que um endereço não foi fornecido. Se esta chave existir, todos os seis campos contidos estarão presentes. Se nada foi fornecido pelo usuário, a string estará vazia.

sendWelcomeEmail

string

Falso

String JSON que indica se um e-mail de boas-vindas será enviado após a validação. Se não for especificado na criação, o valor será definido como "true" para ACS e "false" para Astra Control Center. Os valores definidos são:

  • "true" - Um e-mail de boas-vindas será enviado; valor padrão na criação

  • "false" - Um e-mail de boas-vindas não será enviado Para um usuário com "authProvider" como "local" ou "ldap", este valor é ignorado e definido como "false".

enableTimestamp

string

Falso

String JSON contendo um timestamp formatado em ISO-8601 indicando quando o usuário foi ativado pela última vez. Os valores definidos são:

  • Em conformidade com o esquema de data e hora ISO-8601

lastActTimestamp

string

Falso

String JSON contendo um timestamp formatado em ISO-8601 indicando quando a API de identidade foi invocada pela última vez em nome deste usuário. (Observação: isso consome muitos recursos.) Os valores definidos são:

  • Em conformidade com o esquema de data e hora ISO-8601

metadados

"type_astra_metadados_update"

Falso

Metadados especificados pelo cliente e pelo serviço associados ao recurso. Os valores definidos são:

  • Conforme o esquema de metadados Astra. Se não for especificado na criação, um objeto de metadados será criado sem rótulos. Se não for especificado na atualização, os rótulos do objeto de metadados, creationTimestamp e createdBy, serão preservados sem modificação.
Exemplo de solicitação 
{
  "type": "application/astra-user",
  "version": "1.2",
  "firstName": "John",
  "lastName": "Dale",
  "email": "jdale@example.com"
}

Resposta

Status: 204, Indicates if the user resource was updated.

Resposta

Status: 401, Unauthorized
Nome Tipo Obrigatório Descrição

tipo

string

Verdadeiro

título

string

Verdadeiro

detalhe

string

Verdadeiro

status

string

Verdadeiro

ID de correlação

string

Falso
Exemplo de resposta 
{
  "type": "https://astra.netapp.io/problems/3",
  "title": "Missing bearer token",
  "detail": "The request is missing the required bearer token.",
  "status": "401"
}

Resposta

Status: 400, Bad request
Nome Tipo Obrigatório Descrição

tipo

string

Verdadeiro

título

string

Verdadeiro

detalhe

string

Verdadeiro

status

string

Verdadeiro

ID de correlação

string

Falso

invalidFields

array["invalidFields"]

Falso

Lista de campos inválidos no corpo da requisição
Exemplo de resposta 
{
  "type": "https://astra.netapp.io/problems/5",
  "title": "Invalid query parameters",
  "detail": "The supplied query parameters are invalid.",
  "status": "400"
}

Resposta

Status: 409, Conflict
Nome Tipo Obrigatório Descrição

tipo

string

Verdadeiro

título

string

Verdadeiro

detalhe

string

Verdadeiro

status

string

Verdadeiro

ID de correlação

string

Falso

invalidFields

array["invalidFields"]

Falso

Lista de campos inválidos no corpo da requisição
Exemplo de resposta 
{
  "type": "https://astra.netapp.io/problems/10",
  "title": "JSON resource conflict",
  "detail": "The request body JSON contains a field that conflicts with an idempotent value.",
  "status": "409"
}

Resposta

Status: 403, Forbidden
Nome Tipo Obrigatório Descrição

tipo

string

Verdadeiro

título

string

Verdadeiro

detalhe

string

Verdadeiro

status

string

Verdadeiro

ID de correlação

string

Falso
Exemplo de resposta 
{
  "type": "https://astra.netapp.io/problems/11",
  "title": "Operation not permitted",
  "detail": "The requested operation isn't permitted.",
  "status": "403"
}

Erro

Status: 404, Not found
Nome Tipo Obrigatório Descrição

tipo

string

Verdadeiro

título

string

Verdadeiro

detalhe

string

Verdadeiro

status

string

Verdadeiro

ID de correlação

string

Falso
Exemplo de resposta de erro 
{
  "type": "https://astra.netapp.io/problems/1",
  "title": "Resource not found",
  "detail": "The resource specified in the request URI wasn't found.",
  "status": "404"
}

Definições

Ver definições

postalAddress

Objeto JSON contendo um conjunto de campos que especifica um endereço. Se esta chave não existir, indica que um endereço não foi fornecido. Se esta chave existir, todos os seis campos contidos estarão presentes. Se nada foi fornecido pelo usuário, a string estará vazia.

Nome Tipo Obrigatório Descrição

addressCountry

string

Verdadeiro

Cadeia JSON contendo o nome ou código do país associado ao endereço postal, conforme especificado na norma ISO 3166 Alpha-2. Os valores definidos são:

  • Comprimento mínimo: 2

  • Comprimento máximo: 2

addressLocality

string

Verdadeiro

String JSON contendo a localidade (por exemplo, cidade) associada ao endereço postal. Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 63

addressRegion

string

Verdadeiro

String JSON contendo a região (por exemplo, estado) associada ao endereço postal. Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 63

postalCode

string

Verdadeiro

String JSON contendo o código postal associado ao endereço postal. Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 63

streetAddress1

string

Verdadeiro

String JSON contendo o endereço da rua associado ao endereço postal. Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 63

streetAddress2

string

Falso

String JSON contendo informações opcionais de endereço de rua, caixa postal e assim por diante. Os valores definidos são:

  • Comprimento mínimo: 1

  • Comprimento máximo: 63

tipo_astra_label

Nome Tipo Obrigatório Descrição

nome

string

Verdadeiro

valor

string

Verdadeiro

type_astra_metadados_update

Metadados especificados pelo cliente e pelo serviço associados ao recurso. Os valores definidos são:

  • Conforme o esquema de metadados Astra. Se não for especificado na criação, um objeto de metadados será criado sem rótulos. Se não for especificado na atualização, os rótulos do objeto de metadados, creationTimestamp e createdBy, serão preservados sem modificação.

Nome Tipo Obrigatório Descrição

etiquetas

array["tipo_astra_label"]

Falso

CriaçãoTimestamp

string

Falso

Alteração do Timestamp

string

Falso

CreatedBy

string

Falso

modifiedBy

string

Falso

invalidParams

Nome Tipo Obrigatório Descrição

nome

string

Verdadeiro

Nome do parâmetro de consulta inválido

razão

string

Verdadeiro

Motivo pelo qual o parâmetro de consulta é inválido

invalidFields

Nome Tipo Obrigatório Descrição

nome

string

Verdadeiro

Nome do campo inválido no corpo da requisição

razão

string

Verdadeiro

Motivo pelo qual o campo do corpo da solicitação é inválido