Go to main content

Guía de la API de RESTful de Oracle® ZFS Storage Appliance (versión OS8.8.x)

Salir de la Vista de impresión

Actualización: Agosto de 2021
 
 

Propiedades del servicio de usuario

Además del nombre de usuario y la contraseña, las propiedades del servicio de usuario definen características tales como qué autorizaciones se otorgan al usuario, qué restricciones se imponen al usuario y cuál es la configuración regional del usuario.

Propiedades de usuario

Los usuarios pueden tener las siguientes propiedades. Algunas propiedades están disponibles solo para usuarios de un tipo en particular.

Tabla 77  Propiedades de usuario
Propiedad
Tipo
Descripción
logname
string
Nombre de usuario único. El logname es inmutable después de que se crea el usuario.
type
string
Tipo de usuario: local, directory, data, nologin. El type es inmutable después de que se crea el usuario. Por defecto: local
uid
number
ID de usuario. Puede especificar el ID de usuario o permitir que el sistema lo asigne. Si usted especifica el ID de usuario, este no podrá ser menor que 100 ni mayor que 2147483646, y no podrá ser igual a 60001, 60002 o 65534. El uid es inmutable después de que se crea el usuario.
fullname
string
Nombre completo o nombre real del usuario. En la BUI, el nombre completo se muestra a la izquierda del botón Cerrar sesión, en la parte superior del panel de control, y también puede aparecer en la ficha del explorador. Por defecto: Igual que logname
initial_password
string
Contraseña para usuarios locales y de datos
require_annotation
boolean
Cuando esté activado:
  • BUI: el usuario debe introducir un comando antes de visualizar la página de BUI inicial.

  • CLI: el usuario debe introducir un comando antes de visualizar el símbolo del sistema de la CLI.

  • REST: se produce un error en las solicitudes por falta de autorización.

La anotación de la sesión aparece en el log de auditoría
roles
Lista
Roles asignados a un usuario de directorio o local.
kiosk_mode
boolean
Cuando está activado, este usuario es usuario de kiosco:
  • BUI: el usuario solo puede visualizar la pantalla con el valor de la propiedad kiosk_screen.

  • CLI: se produce un fallo en el inicio de sesión.

  • REST: se produce un error en las solicitudes por falta de autorización.

kiosk_screen
string
La pantalla de la BUI a la que este usuario tiene acceso restringido si está activado kiosk_mode. Por defecto: status/dashboard
exceptions
Lista
Autorizaciones adicionales asignadas a un usuario de directorio o local, o las limitaciones en las autorizaciones asignadas a un rol.
preferences
Lista
Preferencias del entorno de usuario, como la configuración regional, la página de inicio de la BUI, los tiempos de espera excedidos, las claves públicas SSH y los tokens de inicio de sesión en REST.

Para obtener descripciones de estas propiedades, consulte la documentación a continuación:

Roles de usuario y excepciones

Utilice la propiedad roles para asignar roles existentes a un usuario. Para crear un rol, consulte Servicio de rol de la API de RESTful.

Utilice la propiedad exceptions para agregar autorizaciones para un usuario. También puede utilizar este mecanismo para suprimir autorizaciones. Por ejemplo, si al usuario se le asigna un rol que otorga ciertas autorizaciones, puede establecer autorizaciones individuales en false en la lista de excepciones y mantener, al mismo tiempo, otras autorizaciones que se incluyen en el rol.

La siguiente solicitud agrega la autorización para reiniciar el servicio Kerberos para el usuario user1.

POST /api/user/v1/users/user1/exceptions HTTP/1.1

{
    "scope": "svc",
    "service": "kerberos",
    "allow_restart": true
}

El siguiente resultado muestra todas las autorizaciones que están disponibles para el servicio Kerberos para usuario1 . En este ejemplo, otras autorizaciones todavía tienen su valor por defecto en false.

{
    "auth": {
        "href": "/api/user/v1/users/user1/exceptions/auth-001",
        "scope": "svc",
        "service": "kerberos",
        "allow_administer": false,
        "allow_configure": false,
        "allow_restart": true
    }
}

Propiedades de preferencias de usuario

Puede establecer preferencias para el usuario con el que ha iniciado sesión o para cualquier usuario para el que tenga la autorización allow_changePreferences. Para obtener la autorización allow_changePreferences, consulte Roles de usuario y excepciones.

Tabla 78  Propiedades de preferencias de usuario
Propiedad
Tipo
Descripción
locale
string
Localidad. Por defecto: C
login_screen
string
La página de la BUI que se presenta después de iniciar sesión correctamente si no se especifica una página en la URL. Por defecto: status/dashboard
session_timeout
integer
La cantidad de minutos hasta que el explorador cierra automáticamente la sesión después de que el usuario sale de la BUI. Por defecto: 15
cli_idle_timeout
integer
La cantidad de tiempo en segundos que la CLI puede estar inactiva antes de que se detenga la sesión. El valor por defecto, -1, implica que la CLI no se cerrará automáticamente cuando esté inactiva.
advanced_analytics
string
Poner a disposición estadísticas de análisis avanzadas
keys
Lista
Claves RSA/DSA públicas
tokens
Lista
Tokens de inicio de sesión REST

Consulte las siguientes secciones para obtener más información sobre estas propiedades:

Timeout de CLI

Por defecto, no hay límite en el tiempo durante el cual la CLI puede estar inactiva (el valor de cli_idle_timeout es -1). Para establecer un límite en el tiempo durante el cual la CLI puede estar inactiva, establezca un valor entero positivo para los segundos cli_idle_timeout. Al alcanzar el límite de timeout, se cierra la CLI.

En el siguiente ejemplo, se establece el timeout de CLI en 1 hora.

PUT /api/user/v1/users/user1/preferences HTTP/1.1

{ "cli_idle_timeout": 3600 }
{
    "preferences": {
        "href": "/api/user/v1/users/user1/preferences",
        "locale": "C",
        "login_screen": "configuration/preferences",
        "session_timeout": 15,
        "cli_idle_timeout": 3600,
        "advanced_analytics": false,
        "keys": [],
        "tokens": []
    }
}

Para deshabilitar el timeout, establezca el valor de cli_idle_timeout en -1 o utilice el comando unset tal como se muestra en el siguiente ejemplo.

PUT /api/user/v1/users/user1/preferences HTTP/1.1

{ "<unset>": ["cli_idle_timeout"] }

Colocar el comando unset entre paréntesis angulares evita el problema de tener una propiedad denominada unset.

Claves SSH

Las claves SSH públicas se pueden usar para permitir conexiones SSH sin usar contraseñas.

Tabla 79  Propiedades de la clave SSH
Propiedad
Tipo
Descripción
type
string
El tipo de clave SSH key: ya sea RSA o DSA
key
string
El contenido de la clave SSH
comment
string
Un comentario asociado con esta clave SSH

Tokens de inicio de sesión REST

Puede crear un token de inicio de sesión REST persistente o no persistente y acceder al token a través de su valor de token devuelto o ID de token.

Tabla 80  Propiedades del token de inicio de sesión REST
Propiedad
Tipo
Descripción
name
string
El nombre del token
token_username
string
El nombre del usuario que puede utilizar este token de inicio de sesión. Este valor se establece en la ruta de acceso de solicitud.
preserve
boolean
Si false, use el valor por defecto de expiration. Si true, establezca una valor personalizado de expiration. Por defecto: false
expiration
number
Al crear un token, este valor es de segundos hasta que el token caduque. Esta propiedad debe establecerse si preserve se establece en true. Si preserve se establece en false, el valor de expiration es 900.
Cuando se enumeran las propiedades del token, este valor es la fecha y hora en que caducará este token.

Parámetro de consulta de token de inicio de sesión REST

Utilice el parámetro de consulta token=token con el comando GET para mostrar los valores de propiedad para ese token. Utilice el parámetro de consulta token=token con el comando DELETE para suprimir ese token. El token es el valor de X-Auth-Session en la respuesta de creación de token.

El token se muestra cuando se crea el token y no se vuelve a mostrar. Asegúrese de copiar y conservar el token. Consulte Ejemplo 3, Creación de un token de inicio de sesión REST.