Modificar un usuario
PUT /accounts/{account_id}/core/v1/users/{user_id}
Sustituye todo el recurso almacenado por el cuerpo de la solicitud JSON suministrado, conservando los valores clave que no son modificables por el usuario.
Parámetros
| Nombre | Tipo | En | Obligatorio | Descripción |
|---|---|---|---|---|
account_id |
cadena |
ruta |
Verdadero |
ID del recurso de cuenta que lo contiene
|
user_id |
cadena |
ruta |
Verdadero |
ID de la colección de usuarios a listar |
Cuerpo de la solicitud
Sustituye todo el recurso almacenado por el cuerpo de la solicitud JSON suministrado, conservando los valores clave que no son modificables por el usuario.
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
Tipo de medio del recurso. Los valores definidos son:
|
versión |
cadena |
Verdadero |
Versión del recurso. Los valores definidos son:
|
id |
cadena |
Falso |
Identificador único global del recurso. Los valores definidos son:
|
estado |
cadena |
Falso |
Cadena JSON que contiene un valor que indica el estado operativo del usuario. Los valores definidos son:
|
isEnabled |
cadena |
Falso |
Cadena JSON que indica si el usuario tiene permiso para iniciar sesión. Los valores definidos son:
|
authID |
cadena |
Falso |
Cadena JSON que contiene el identificador asociado a un proveedor de identidad externo. El contenido de esta cadena depende del authProvider especificado. Para un usuario con "authProvider" como "local", "authID" se establece con el valor de "email". Para un usuario con "authProvider" como "ldap", "authID" se establece con su Nombre Distinguido (DN) del servidor LDAP. |
authProvider |
cadena |
Falso |
Cadena JSON que indica el contexto del identificador idAuth. Los valores definidos son:
|
firstName |
cadena |
Falso |
Cadena JSON que contiene un nombre de pila largo especificado por el usuario. Los valores definidos son:
|
lastName |
cadena |
Falso |
Cadena JSON que contiene un apellido largo especificado por el usuario. Los valores definidos son:
|
companyName |
cadena |
Falso |
Cadena JSON que contiene el nombre de la empresa asociada al usuario. Si esta clave no existe, indica que no se ha proporcionado un nombre de empresa. Los valores definidos son:
|
correo electrónico |
cadena |
Falso |
Cadenas JSON que contienen una dirección de correo electrónico especificada por el usuario. |
teléfono |
cadena |
Falso |
Cadena JSON que contiene el número de teléfono del usuario. Si esta clave no existe, indica que no se ha proporcionado un número de teléfono. |
postalAddress |
Falso |
Objeto JSON que contiene una colección de campos que especifica una dirección. Si esta clave no existe, indica que no se ha proporcionado una dirección. Si esta clave existe, los seis campos contenidos estarán presentes. Si el usuario no ha proporcionado nada, la cadena estará vacía. |
|
sendWelcomeEmail |
cadena |
Falso |
Cadena JSON que indica si se enviará un correo electrónico de bienvenida tras la validación. Si no se especifica al crear, el valor se establecerá en "true" para ACS y en "false" para Astra Control Center. Los valores definidos son:
|
enableTimestamp |
cadena |
Falso |
Cadena JSON que contiene una marca de tiempo con formato ISO-8601 que indica cuándo se habilitó el usuario por última vez. Los valores definidos son:
|
lastActTimestamp |
cadena |
Falso |
Cadena JSON que contiene una marca de tiempo con formato ISO-8601 que indica cuándo se invocó por última vez la API de identidad en nombre de este usuario. (Nota: esto es caro.) Los valores definidos son:
|
metadatos |
Falso |
Metadatos especificados por el cliente y el servicio asociados con el recurso. Los valores definidos son:
|
Ejemplo de solicitud
{
"type": "application/astra-user",
"version": "1.2",
"firstName": "John",
"lastName": "Dale",
"email": "jdale@example.com"
}
Respuesta
Status: 204, Indicates if the user resource was updated.
Respuesta
Status: 401, Unauthorized
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
|
título |
cadena |
Verdadero |
|
detalle |
cadena |
Verdadero |
|
estado |
cadena |
Verdadero |
|
correlationID |
cadena |
Falso |
Ejemplo de respuesta
{
"type": "https://astra.netapp.io/problems/3",
"title": "Missing bearer token",
"detail": "The request is missing the required bearer token.",
"status": "401"
}
Respuesta
Status: 400, Bad request
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
|
título |
cadena |
Verdadero |
|
detalle |
cadena |
Verdadero |
|
estado |
cadena |
Verdadero |
|
correlationID |
cadena |
Falso |
|
invalidFields |
array["invalidFields"] |
Falso |
Lista de campos del cuerpo de la solicitud no válidos |
Ejemplo de respuesta
{
"type": "https://astra.netapp.io/problems/5",
"title": "Invalid query parameters",
"detail": "The supplied query parameters are invalid.",
"status": "400"
}
Respuesta
Status: 409, Conflict
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
|
título |
cadena |
Verdadero |
|
detalle |
cadena |
Verdadero |
|
estado |
cadena |
Verdadero |
|
correlationID |
cadena |
Falso |
|
invalidFields |
array["invalidFields"] |
Falso |
Lista de campos del cuerpo de la solicitud no válidos |
Ejemplo de respuesta
{
"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"
}
Respuesta
Status: 403, Forbidden
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
|
título |
cadena |
Verdadero |
|
detalle |
cadena |
Verdadero |
|
estado |
cadena |
Verdadero |
|
correlationID |
cadena |
Falso |
Ejemplo de respuesta
{
"type": "https://astra.netapp.io/problems/11",
"title": "Operation not permitted",
"detail": "The requested operation isn't permitted.",
"status": "403"
}
Error
Status: 404, Not found
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
tipo |
cadena |
Verdadero |
|
título |
cadena |
Verdadero |
|
detalle |
cadena |
Verdadero |
|
estado |
cadena |
Verdadero |
|
correlationID |
cadena |
Falso |
Ejemplo de respuesta de error
{
"type": "https://astra.netapp.io/problems/1",
"title": "Resource not found",
"detail": "The resource specified in the request URI wasn't found.",
"status": "404"
}
Definiciones
Ver definiciones
postalAddress
Objeto JSON que contiene una colección de campos que especifica una dirección. Si esta clave no existe, indica que no se ha proporcionado una dirección. Si esta clave existe, los seis campos contenidos estarán presentes. Si el usuario no ha proporcionado nada, la cadena estará vacía.
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
addressCountry |
cadena |
Verdadero |
Cadena JSON que contiene el nombre del país o el código de país asociado a la dirección postal, tal como se especifica en ISO 3166 Alpha-2. Los valores definidos son:
|
addressLocality |
cadena |
Verdadero |
Cadena JSON que contiene la localidad (por ejemplo, ciudad) asociada a la dirección postal. Los valores definidos son:
|
addressRegion |
cadena |
Verdadero |
Cadena JSON que contiene la región (por ejemplo, estado) asociada a la dirección postal. Los valores definidos son:
|
postalCode |
cadena |
Verdadero |
Cadena JSON que contiene el código postal asociado a la dirección postal. Los valores definidos son:
|
streetAddress1 |
cadena |
Verdadero |
Cadena JSON que contiene la dirección de la calle asociada a la dirección postal. Los valores definidos son:
|
streetAddress2 |
cadena |
Falso |
Cadena JSON que contiene información auxiliar opcional sobre la dirección, apartado de correos, etc. Los valores definidos son:
|
etiqueta_tipo_astra
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
nombre |
cadena |
Verdadero |
|
valor |
cadena |
Verdadero |
type_astra_metadatos_update
Metadatos especificados por el cliente y el servicio asociados con el recurso. Los valores definidos son:
-
Conforme al esquema de metadatos de Astra. Si no se especifica al crear, se creará un objeto de metadatos sin etiquetas. Si no se especifica al actualizar, las etiquetas del objeto de metadatos, creationTimestamp y createdBy, se conservarán sin modificaciones.
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
etiquetas |
array["etiqueta_tipo_astra"] |
Falso |
|
CreationTimestamp |
cadena |
Falso |
|
Modificación.Marca de hora |
cadena |
Falso |
|
CreatedBy |
cadena |
Falso |
|
modifiedBy |
cadena |
Falso |
invalidParams
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
nombre |
cadena |
Verdadero |
Nombre del parámetro de consulta no válido |
motivo |
cadena |
Verdadero |
Razón por la que el parámetro de consulta no es válido |
invalidFields
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
nombre |
cadena |
Verdadero |
Nombre del campo no válido del cuerpo de la solicitud |
motivo |
cadena |
Verdadero |
Motivo por el que el campo del cuerpo de la solicitud no es válido |