Service Web d'utilisateurs

L'API fournit un service Web d'utilisateurs qui permet de gérer les comptes d'utilisateurs. Vous pouvez effectuer les tâches suivantes :
capm380
L'API fournit un service Web d'utilisateurs qui permet de gérer les comptes d'utilisateurs. Vous pouvez effectuer les tâches suivantes :
  • Obtenir la liste actuelle des comptes d'utilisateurs
  • Création de comptes d'utilisateurs
  • Modifier des comptes d'utilisateurs
  • Supprimer des comptes d'utilisateurs
Les rubriques suivantes fournissent des informations sur les paramètres associés :
Paramètres de base de compte d'utilisateur
Les valeurs actuelles pour les paramètres de compte d'utilisateur suivants sont disponibles à l'aide d'une opération GET :
http://hôte_PC:8181/pc/center/webservice/users/
cultureId
Cette URL renvoie des informations sur les utilisateurs associés au même client hébergé que le compte qui est utilisé pour exécuter cette commande.
Pour
cultureId
, indiquez le code de la langue dans laquelle vous souhaitez afficher le résultat, en-US par exemple.
  • userID
    Valeur affectée en interne pour le compte d'utilisateur.
  • name
    Nom de connexion pour le compte d'utilisateur. Le nom ne peut pas contenir plus de 50 caractères.
  • description
    (Facultatif) Décrit le compte d'utilisateur pour vous aider à l'identifier.
  • enabled
    Détermine si le compte est activé pour l'utilisation.
  • removable
    Indique que l'élément peut être supprimé (de la base de données).
    Valeurs
    : true ou false.
    Vous ne pouvez pas supprimer les deux comptes d'utilisateurs prédéfinis (
    admin
    et
    user
    ).
  • timezone (tz)
    Fuseau horaire utilisé pour afficher les données de rapport.
    Valeur par défaut
    : UTC (Temps universel coordonné).
  • userLevel
    Identifie les droits sur le produit affectés à ce compte d'utilisateur.
  • Rôle
    Spécifie le rôle affecté au compte d'utilisateur.
  • tenantId
    Est-ce un identificateur interne (base de données) pour le client hébergé auquel le compte d'utilisateur est associé.
  • culture
    Spécifie une langue (environnement linguistique). Entrez un identificateur de langue à partir de la liste suivante :
    • en-US (anglais, Etats-Unis)
    • ja-JP (japonais)
    • zh-CN (chinois simplifié)
    • zh-TW (chinois traditionnel)
    • fr-FR (français,France)
La méthode GET ne renvoie pas les informations de mot de passe. Lorsque vous créez un compte d'utilisateur, le mot de passe est automatiquement défini pour être identique au nom d'utilisateur.
Une méthode PUT distincte permet de mettre à jour le mot de passe d'un compte d'utilisateur spécifié. Le mot de passe est envoyé en texte clair pour éviter de communiquer la clé de chiffrement pour le service Web à utiliser. En conséquence, la méthode de modification du mot de passe doit être utilisée uniquement sur l'hôte CA
NetOps Portal
afin de protéger la confidentialité du mot de passe.
Paramètres des droits sur le produit du compte d'utilisateur
Utilisez l'interface utilisateur de CA
NetOps Portal
pour déterminer les droits du produit pour le compte d'utilisateur spécifié. Le droit du produit est un type de définition d'autorisation associé à un compte d'utilisateur. Le droit du produit accorde à l'utilisateur un accès aux fonctionnalités des sources de données sélectionnées et ne s'applique pas à la fonctionnalité
NetOps Portal
.
Les comptes d'utilisateurs possèdent l'une des affectations de droits sur le produit suivantes :
  • NONE
    Indique que cet utilisateur n'a pas accès à une source de données spécifiée.
  • ADMINISTRATOR
    Indique que cet utilisateur possède des droits d'administrateur sur le produit pour la source de données indiquée et peut effectuer des tâches administratives.
  • POWER_USER
    Indique que cet utilisateur possède des droits d'utilisateur avancé pour la source de données indiquée et peut effectuer certaines tâches administratives associées aux comptes d'utilisateurs et aux tableaux de bord.
  • USER
    Indique que cet utilisateur possède des droits d'utilisateur sur le produit pour la source de données indiquée et n'a pas accès aux fonctionnalités administratives.
Exemple de syntaxe du service Web d'utilisateurs
Envoyez l'appel suivant pour afficher les paramètres et les opérations disponibles pour le service Web users :
http://
hôte_PC
:8181/pc/center/rest/users/documentation
Méthodes GET disponibles
  • get groups owned by user
    Récupère une liste de groupes pour l'utilisateur spécifié. Les groupes renvoyés correspondent aux groupes que l'utilisateur spécifié possède et qu'il peut modifier ou supprimer :
    http://
    hôte_PC
    :8181/pc/center/webservice/users/
    idName
    /
    idValue
    /groupsOwnedByUser
  • get groups
    Récupère une liste des groupes pour lesquels l'utilisateur spécifié dispose des droits d'affichage. Les groupes renvoyés correspondent aux groupes qui figurent dans l'ensemble d'autorisation de l'utilisateur spécifié. L'utilisateur ne peut pas modifier ou supprimer ces groupes :
    http://
    hôte_PC
    :8181/pc/center/webservice/users/
    idName
    /
    idValue
    /groups
  • get administered groups
    Récupère une liste de tous les groupes administrés associés au compte d’utilisateur spécifié.
    http://
    hôte_PC
    :8181/pc/center/webservice/users/idName/idValue/administeredGroups
  • get id names
    Récupère une liste d'identificateurs que vous pouvez utiliser pour identifier des utilisateurs dans d'autres méthodes de service Web :
    http://
    hôte_PC
    :8181/pc/center/webservice/users/idNames
    • idValue
      Valeur de la catégorie d'identification. Par exemple, si
      idName
      est userID, fournissez l'ID d'utilisateur. Si
      idName
      est userName, fournissez le nom d'utilisateur.
  • get authentication types
    Renvoie une liste d'identificateurs que vous pouvez utiliser pour assigner des types d'authentification à des utilisateurs :
    http://
    hôte_PC
    :8181/pc/center/webservice/users/authenticationTypes
Méthodes GET disponibles
  • update role
    Met à jour l'affectation de rôle du compte d'utilisateur spécifié :
    http://
    hôte_PC
    :8181/pc/center/webservice/users/
    idName
    /
    idValue
    /role/
    roleIdName
    /
    roleIdValue
  • update time zone
    Met à jour le fuseau horaire du compte d'utilisateur spécifié :
    http://
    hôte_PC
    :8181/pc/center/webservice/users/
    idName
    /
    idValue
    /timeZone/
    newTimeZone
  • set groups
Met à jour les groupes d'autorisations accordés au compte d'utilisateur spécifié :
http://
hôte_PC
:8181/pc/center/webservice/users/
idName
/
idValue
/groups
Pour définir des groupes, saisissez du contenu XML au format suivant :
<group> <group ID="5245"/> <group ID="5246"/> <group ID="5247"/> ... </group>
  • Ajout de groupes
Ajoute les groupes spécifiés.
http://
hôte_PC
:8181/pc/center/webservice/users/
idName
/
idValue
/addGroups
Pour ajouter des groupes, saisissez du contenu XML au format suivant :
<group> <group ID="5245"/> <group ID="5246"/> <group ID="5247"/> ... </group>
  • Suppression de groupes
Supprime les groupes spécifiés.
http://
hôte_PC
:8181/pc/center/webservice/users/
idName
/
idValue
/removeGroups
Pour supprimer des groupes, saisissez du contenu XML au format suivant :
<group> <group ID="5245"/> <group ID="5246"/> <group ID="5247"/> ... </group>
  • set administered groups
Met à jour les branches de l’arborescence de groupes pour lesquelles l’utilisateur dispose de droits d'administration.
http://
hôte_PC
:8181/pc/center/webservice/users/idName/idValue/administeredGroups
Pour définir des groupes administrés à un compte d'utilisateur, fournissez un code XML au format suivant :
<group> <group ID="5245"/> <group ID="5246"/> <group ID="5247"/> ... </group>
  • set default group
    Met à jour le groupe par défaut pour l'utilisateur spécifié.
    http://
    hôte_PC
    :8181/pc/center/webservice/users/
    idName
    /
    idValue
    /defaultGroup/
    groupId
    Exemple :
    http://PC.broadcom.net:8181/pc/center/webservice/users/userId/7/defaultGroup/11
  • Ajout de groupes administrés
Ajoute les groupes spécifiés à un compte d'utilisateur.
http://
hôte_PC
:8181/pc/center/webservice/users/
idName
/
idValue
/addAdministeredGroups
Pour ajouter des groupes administrés à un compte d'utilisateur, fournissez un code XML au format suivant :
<group> <group ID="5245"/> <group ID="5246"/> <group ID="5247"/> ... </group>
  • Suppression de groupes administrés
Supprime les groupes spécifiés d'un compte d'utilisateur.
http://
hôte_PC
:8181/pc/center/webservice/users/
idName
/
idValue
/removeAdministeredGroups
Pour supprimer des groupes administrés d'un compte d'utilisateur, fournissez un code XML au format suivant :
<group> <group ID="5245"/> <group ID="5246"/> <group ID="5247"/> ... </group>
  • update product privilege per datasource
    Met à jour les droits du produit du compte d'utilisateur spécifié pour permettre l'accès à l'interface utilisateur d'une source de données spécifique :
    http://
    hôte_PC
    :8181/pc/center/webservice/users/
    idName
    /
    idValue
    /ds/
    dsId
    /productPrivilege/
    newProductPrivilege
    • dsId
      Identificateur de la source de données. Pour obtenir la liste des identificateurs de source de données disponibles, consultez la rubrique Paramètres de source de données de base.
Méthodes POST disponibles
  • create
    Crée un compte d'utilisateur. Le nouveau rôle est associé au client hébergé de l'utilisateur connecté. Les paramètres incluent une assignation de rôle :
    http://
    hôte_PC
    :8181/pc/center/webservice/users/role/
    roleIdName
    /
    roleIdValue
  • create in tenant
    Crée un compte d'utilisateur dans le client hébergé spécifié, avec l'assignation de rôle spécifiée :
    http://
    hôte_PC
    :8181/pc/center/webservice/users/tenant/
    tenantIdName
    /
    tenantIdValue
    /role/
    roleIdName
    /
    roleIdValue
  • clear administered groups
    Efface les groupes administrés avec un ID spécial qui indique qu'aucun groupe n'est sélectionné.
    http://
    hôte_PC
    :8181/pc/center/webservice/users/idName/idValue/administeredGroups
    Pour effacer les groupes administrés, fournissez le code XML suivant :
    <group>
    <group ID="2"/>
    </group>
Création d'un compte d'utilisateur à l'aide de REST
Pour créer un compte d'utilisateur personnalisé, utilisez le service Web d'utilisateurs. Chaque compte d'utilisateur est automatiquement associé à un client hébergé. Si vous déployez l'hébergement multiclient, le nouvel utilisateur est affecté au client hébergé du compte d'utilisateur authentifié utilisé pour émettre l'appel du service REST. Si vous ne déployez pas l'hébergement multiclient, cette association est transparente : les nouveaux comptes d'utilisateurs sont associés au client hébergé par défaut.
Procédez comme suit :
  1. Configurez un client REST avec une connexion à l'hôte
    NetOps Portal
    .
  2. Dans le client REST, entrez l'URL correspondant à l'API des services Web RESTful de CA
    NetOps Portal
    . Utilisez le format suivant :
    http://
    hôte_PC
    :8181/pc/center/webservice/users/role/
    roleIdName/roleIdValue
    /
    • roleIdName
      Utilisez les valeurs spécifiées à l'URL suivante :
      http://
      hôte_PC
      :8181/pc/center/webservice/roles/idNames
      Exemples :
      • roleName
      • roleId
    • roleIdValue
      Cette valeur dépend de la valeur de roleIdName que vous avez sélectionnée. Par exemple, si vous utilisez le paramètre roleName, remplacez
      roleIdValue
      par un nom de rôle valide.
      Ce rôle doit être disponible dans le client hébergé.
  3. Sélectionnez POST comme méthode HTTP.
  4. Entrez un nom d'utilisateur et un mot de passe valides pour un compte d'utilisateur disposant d'un accès en tant qu'hôte ou qu'administrateur de clients hébergés à CA
    NetOps Portal
    .
  5. Dans les paramètres de corps, sélectionnez application/xml comme Body Content-type.
  6. Ajoutez les paramètres suivants dans la section de texte Body :
    <user> <name>{UserName}</name> <description>{UserDescription}</description> <enabled>{UserEnabled}</enabled> <removable>{UserRemovable}</removable> <timezone>{UserTimeZone}</timezone> <culture>{UserCulture}</culture> <administeredGroups> <group ID="{groupID}"/> <group ID="{groupID}"/> </administeredGroups> </user>
  7. Remplacez toute valeur par les valeurs que vous souhaitez utiliser pour le nouveau compte d'utilisateur.
    Fournissez, par exemple, les paramètres suivants :
    <user> <name>Jane Doe</name> <description>User associated with the John Doe Corporation tenant.</description> <enabled>true</enabled> <removable>true</removable> <timezone>CST6CDT</timezone> <culture>en-US</culture> <administeredGroups> <group ID="105"/> <group ID="367"/> </administeredGroups> </user>
    La balise administeredGroups est facultative. Pour créer un utilisateur sans groupes administrés, excluez la balise.
  8. Exécutez la méthode.
  9. Répétez les étapes précédentes jusqu'à ce que vous ayez créé tous les utilisateurs de votre choix.
Paramètres des droits sur le produit du compte d'utilisateur
Utilisez l'interface utilisateur de CA
NetOps Portal
pour déterminer les droits du produit pour le compte d'utilisateur spécifié. Le
droit d'accès au produit
est un type d'ensemble d'autorisations associé à un compte d'utilisateur. Le droit du produit accorde à l'utilisateur un accès aux fonctionnalités des sources de données sélectionnées et ne s'applique pas à la fonctionnalité
NetOps Portal
.
Les comptes d'utilisateurs possèdent l'une des affectations de droits sur le produit suivantes :
  • NONE
    Indique que cet utilisateur n'a pas accès à une source de données spécifiée.
  • ADMINISTRATOR
    Indique que cet utilisateur possède des droits d'administrateur sur le produit pour la source de données indiquée et peut effectuer des tâches administratives.
  • POWER_USER
    Indique que cet utilisateur possède des droits d'utilisateur avancé sur produit pour la source de données indiquée et peut effectuer certaines tâches administratives associées aux comptes d'utilisateurs et aux tableaux de bord.
  • USER
    Indique que cet utilisateur possède des droits d'utilisateur sur le produit pour la source de données indiquée et n'a pas accès aux fonctionnalités administratives.