Service Web de rôles

L'API fournit le service Web de rôles permettent d'afficher, de créer et de modifier des rôles de compte d'utilisateur.
capm250
L'API fournit le service Web de rôles permettent d'afficher, de créer et de modifier des rôles de compte d'utilisateur.
Le
rôle
est un paramètre assigné à un compte d'utilisateur qui contrôle l'accès de l'utilisateur aux fonctionnalités de produit et aux pages de tableau de bord. Le rôle se base sur les fonctions et les
droits de rôle
de l'utilisateur pour accorder à ce dernier un accès d'administrateur dans le cadre de la configuration du produit. Les rôles permettent aux utilisateurs d'accéder aux données et aux fonctionnalités du produit dont ils ont besoin pour effectuer les tâches dont ils sont responsables et limitent l'accès des utilisateurs aux fonctionnalités dont ils n'ont pas besoin. Pour assigner des rôles prédéfinis ou personnalisés à des comptes d'utilisateurs, utilisez le service Web RESTful des utilisateurs.
Paramètres de rôle de base
Les valeurs actuelles pour les paramètres de rôle de compte d'utilisateur suivants sont disponibles à l'aide de la commande GET :
  • accessRights
    Droits de rôle alloués au rôle. Plusieurs droits de rôle sont disponibles pour allocation et certains dépendent de la source de données. L'affichage de la liste de l'ensemble des droits de rôle disponibles requiert le paramètre
    categoryId
    . La définition du paramètre categoryId sur 1 correspond à CA
    NetOps Portal
    et au Data Aggregator.
  • 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é)
    • fr-FR (français,France)
  • description
    (Facultatif) Décrit le rôle pour vous aider à l'identifier.
  • enabled
    Détermine si le rôle est activé pour l'utilisation (activé). Valeurs : true ou false.
  • name
    Nom du rôle Le nom ne peut pas contenir plus de 50 caractères.
  • selections
    Fournit des définitions de droits d'accès que vous pouvez accorder de manière sélective à ce rôle et organiser par catégories.
  • userCount
    Nombre d'utilisateurs dont le compte est associé à ce rôle.
  • userID
    Valeur interne affectée au rôle.
Exemple de syntaxe du service Web roles
Envoyez l'appel suivant pour afficher les opérations et les paramètres disponibles pour le service Web roles :
http://
PC_host
:8181/pc/center/rest/roles/documentation
Méthodes GET disponibles
  • get access rights
    Récupère une liste des droits de rôle affectés au rôle spécifié. Utilisez la syntaxe suivante :
    http://
    PC_host
    :8181/pc/center/webservice/roles/idName/idValue/rights/cultureId
  • get access rights by category
    Récupère une liste de tous les droits de rôle disponibles pour la catégorie spécifiée. La catégorie est CA
    NetOps Portal
    ou une source de données. La définition du paramètre categoryId sur 1 correspond à CA
    NetOps Portal
    et au Data Aggregator.
    http://
    PC_host
    :8181/pc/center/webservice/roles/rights/categoryid/cultureId
  • get category
    Récupère un document XML qui inclut l'ID de catégorie :
    http://
    PC_host
    :8181/pc/center/webservice/roles/rights/categories/en-US
  • get by tenant
    Récupère une liste de tous les rôles associés au client hébergé pour l'utilisateur connecté. Utilisez la syntaxe suivante :
    http://
    PC_host
    :8181/pc/center/webservice/roles/idName/idValue/rights/tenant/tenantIdName/tenantIdValue/cultureId
  • get categoryId
    Récupère le fichier XML qui affiche les ID de catégorie disponibles.
    http://
    PC_host
    :8181/pc/center/webservice/roles/rights/categories/cultureId
    La définition du paramètre sur 1 correspond à CA
    NetOps Portal
    et au Data Aggregator. Les droits de rôle dans cette catégorie s'appliquent uniquement à une source de données Data Aggregator.
  • get id names
    Récupère une liste d'identificateurs que vous pouvez utiliser pour identifier des rôles dans d'autres méthodes de service Web. Utilisez la syntaxe suivante :
    http://
    PC_host
    :8181/pc/center/webservice/roles/idNames
Méthodes GET disponibles
  • copy
    Copie un rôle. Cette méthode crée une copie du rôle spécifié et l'associe au client hébergé pour l'utilisateur connecté. Utilisez la syntaxe suivante :
    http://
    PC_host
    :8181/pc/center/webservice/roles/idName/idValue/copy/roleName/description/enabled/cultureId
  • update
    Modifie le rôle spécifié. Le nom de rôle et l'ID de client hébergé sont les éléments requis pour les paramètres de rôle.
    http://
    PC_host
    :8181/pc center/webservice/roles/idName/idValue/cultureId
Méthodes POST disponibles
  • create
    Crée un rôle. Le nouveau rôle est associé au client hébergé pour l'utilisateur connecté :
    http://
    PC_host
    :8181/pc/center/webservice/roles/
  • create for tenant
    Crée un rôle et l'affecte au client hébergé spécifié.
    http://
    PC_host
    :8181/pc/center/webservice/roles/tenant/tenantIdName/tenantIdValue
Création d'un rôle
Utilisez le service Web roles pour créer des rôles de compte d'utilisateur.
Envoyez l'appel suivant pour afficher les paramètres du service Web roles :
http://
PC_host
:8181/pc/center/webservice/roles
Procédez comme suit :
  1. Dans le client REST, entrez l'URL correspondant à l'API des services Web RESTful de CA
    NetOps Portal
    . Utilisez le format suivant :
    http://
    PC_host
    :8181/pc /center/webservice/roles
  2. Sélectionnez
    POST
    comme
    méthode HTTP
    .
  3. Fournissez un nom d'utilisateur et un mot de passe valides pour un compte d'utilisateur global disposant d'un accès d'administrateur global à
    NetOps Portal
    .
  4. Dans les paramètres de corps, sélectionnez
    application/xml
    comme
    Body Content-type
    .
  5. Dans le champ Body (Corps), collez le contenu XML qui ressemble au code suivant :
    <role> <name>TestRoleName</name> <description>Test Role Description</description> <enabled>true</enabled> <accessRights> <accessRight> <accessRightName>ViewToS</accessRightName> <categoryId>1</categoryId> <enabled>true</enabled> </accessRight> </accessRights> </role>
    • accessRights
      Correspond aux droits de rôle.
    • accessRightName
      Nom du droit de rôle. Par exemple, le droit de rôle administerGroups permet à l'utilisateur disposant de ce rôle de gérer une section limitée de l'arborescence Groupes.
    • categoryId
      Identifie la catégorie de droits de rôle, tels que les droits de rôle de CA
      NetOps Portal
      ou les droits de rôle propres à une source de données.
  6. Exécutez la méthode.