Go to main content

Guide RESTful API des systèmes Oracle® ZFS Storage Appliance, version OS8.8.x

Quitter la vue de l'impression

Mis à jour : Août 2021
 
 

Propriétés du service utilisateur

Outre le nom d'utilisateur et le mot de passe, les propriétés du service utilisateur définissent des caractéristiques telles que les autorisations octroyées à l'utilisateur, les restrictions qui lui sont imposées et ses paramètres régionaux.

Propriétés utilisateur

Les utilisateurs peuvent posséder les propriétés suivantes. Certaines d'entre elles sont disponibles uniquement pour les utilisateurs d'un type particulier.

Table 77  Propriétés utilisateur
Propriété
Type
Description
logname
string
Nom d'utilisateur unique. La propriété logname est inaltérable une fois l'utilisateur créé.
type
string
Type d'utilisateur : local, directory, data, nologin. Le type est inaltérable une fois l'utilisateur créé. Valeur par défaut : local
uid
number
ID de l'utilisateur. Vous pouvez spécifier l'ID de l'utilisateur ou laisser le système en affecter un. Si vous spécifiez l'ID de l'utilisateur, il ne peut pas être inférieur à la valeur 100 et supérieur à 2147483646, et ne peut pas être identique à 60001, 60002 ou 65534. L'uid est inaltérable une fois l'utilisateur créé.
fullname
string
Nom complet ou nom réel de l'utilisateur. Dans la BUI, le nom complet est affiché à gauche du bouton Déconnexion en haut du tableau de bord et peut également être affiché dans l'onglet du navigateur. Valeur par défaut : valeur de logname
initial_password
string
Mot de passe pour les utilisateurs locaux et de données.
require_annotation
boolean
Lorsque définie sur true :
  • BUI – L'utilisateur doit saisir un commentaire avant que la page initiale de la BUI s'affiche.

  • CLI – L'utilisateur doit saisir un commentaire avant que l'invite de la CLI s'affiche.

  • REST – Les demandes échouent comme étant inautorisées.

L'annotation de session s'affiche dans le journal d'audit.
roles
list
Rôles affectés à un utilisateur de type Local ou Annuaire.
kiosk_mode
boolean
Lorsque que la propriété est définie sur true, l'utilisateur est un utilisateur Kiosk :
  • BUI – L'utilisateur peut uniquement afficher l'écran représentant la valeur de la propriété kiosk_screen.

  • CLI – La connexion échoue.

  • REST – Les demandes échouent comme étant inautorisées.

kiosk_screen
string
Ecran BUI auquel cet utilisateur est restreint lorsque la propriété kiosk_mode est définie sur true. Valeur par défaut : status/dashboard
exceptions
list
Autorisations supplémentaires affectées à un utilisateur de type Annuaire ou Local, ou limites des autorisations affectées dans un rôle.
preferences
list
Préférences pour l'environnement utilisateur, telles que l'environnement linguistique, la page initiale de la BUI, les délais d'expiration, les clés publiques SSH et le jetons de connexion REST.

Pour obtenir une description plus détaillée de ces propriétés, reportez-vous à la documentation suivante :

Rôles et exceptions d'utilisateur

La propriété roles permet d'affecter des rôles existants à un utilisateur. Pour créer un rôle, reportez-vous à Service des rôles de l'API RESTful.

La propriété exceptions permet d'ajouter des autorisations à un utilisateur. Vous pouvez également utiliser ce mécanisme pour supprimer des autorisations. Par exemple, si l'utilisateur se voit affecté un rôle qui accorde certaines autorisations, vous pouvez définir des autorisations individuelles sur false dans la liste des exceptions, et en conserver d'autres incluses au rôle.

La demande suivante ajoute l'autorisation de redémarrer le service Kerberos à l'utilisateur user1.

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

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

Le résultat suivant affiche toutes les autorisations dont dispose l'utilisateur user1 pour le service Kerberos. Dans cet exemple, d'autres autorisations présentent la valeur par défaut false.

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

Propriétés des préférences utilisateur

Vous pouvez définir des préférences pour l'utilisateur actuellement connecté ou pour tout utilisateur pour lequel vous disposez de l'autorisation allow_changePreferences. Pour obtenir l'autorisation allow_changePreferences, reportez-vous à Rôles et exceptions d'utilisateur.

Table 78  Propriétés des préférences utilisateur
Propriété
Type
Description
locale
string
Localité. Valeur par défaut : C
login_screen
string
Page de la BUI présentée à la connexion si aucune page n'est spécifiée dans l'URL. Valeur par défaut : status/dashboard
session_timeout
integer
Nombre de minutes jusqu'à ce que le navigateur mette automatiquement fin à la session une fois que l'utilisateur quitte la BUI. Valeur par défaut : 15
cli_idle_timeout
integer
Durée en secondes pendant laquelle la CLI peut être inactive avant l'interruption de la session. La valeur par défaut, -1, indique que la CLI ne se ferme pas automatiquement lorsqu'elle est inactive.
advanced_analytics
string
Mise à disposition de statistiques d'analyse avancées
keys
list
Clés publiques RSA/DSA
tokens
list
Jetons de connexion REST

Pour plus d'informations sur ces propriétés, reportez-vous aux sections suivantes :

Délai d'expiration de la CLI

Par défaut, il n'existe aucune limite de durée d'inactivité de la CLI (la valeur de cli_idle_timeout est -1). Pour en définir une, saisissez un entier positif pour la valeur cli_idle_timeout en secondes. Si la limite du délai d'expiration est atteinte, la CLI se ferme.

L'exemple suivant définit un délai d'expiration de la CLI d'une heure.

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": []
    }
}

Pour désactiver le délai d'expiration, définissez la valeur cli_idle_timeout sur -1 ou utilisez unset comme illustré dans l'exemple ci-dessous.

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

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

Entourez la commande unset de chevrons pour qu'elle ne soit pas considérée comme une propriété.

Clés SSH

Les clés publiques SSH permettent d'autoriser les connexions SSH sans mot de passe.

Table 79  Propriétés des clés SSH
Propriété
Type
Description
type
string
Type de clé SSH : RSA ou DSA
key
string
Contenu de la clé SSH
comment
string
Commentaire associé à cette clé SSH

Jetons de connexion REST

Vous pouvez créer un jeton de connexion REST persistant ou non, et y accéder au moyen de sa valeur ou de son ID renvoyés.

Table 80  Propriétés des jetons de connexion REST
Propriété
Type
Description
name
string
Nom du jeton.
token_username
string
Nom de l'utilisateur autorisé à se servir de ce jeton de connexion. Cette valeur est définie dans le chemin d'accès de demande.
preserve
boolean
Si false, utilisez la valeur par défaut expiration. Si true, définissez une valeur expiration personnalisée. Valeur par défaut : false
expiration
number
Lorsqu'un jeton est créé, cette valeur indique le nombre de secondes avant son expiration. Cette propriété est obligatoire si la valeur de preserve est true. Si preserve est définie sur false, la valeur d'expiration est 900.
Dans la liste des propriétés des jetons, cette valeur indique la date et l'heure d'expiration du jeton.

Paramètre de requête d'un jeton de connexion REST

Utilisez le paramètre de requête token=token avec la commande GET pour afficher les valeurs de propriétés de ce jeton. Utilisez le paramètre de requête token=token avec la commande DELETE pour supprimer ce jeton. token indique la valeur de X-Auth-Session dans la réponse à la création du jeton.

token s'affiche à la création du jeton et n'apparaît plus ensuite. Copiez et conservez cette valeur token. Reportez-vous à Exemple 3, Création d'un jeton de connexion REST.