Gestion des administrateurs avec l'API Cato

Cet article traite des différentes APIs de Cato qui vous permettent de gérer les administrateurs et les rôles d'administrateur pour l'application de gestion Cato. Cette API prend en charge la gestion des administrateurs pour les comptes de revendeur et les comptes réguliers.

ajouterConfiguration Des administrateurs API

L’API de configuration addAdmin crée de nouveaux administrateurs pour le compte dans l'application de gestion Cato.

ajouterParamètre De l'admin

  • identifiantCompte (obligatoire)

ajouterArguments Admin

Voici les arguments pour l’API de configuration addAdmin :

  • firstName : Le prénom de l'admin (max 255 caractères) - ce champ est obligatoire
  • lastName : Le nom de famille de l'admin (max 255 caractères) - ce champ est obligatoire
  • email : L'adresse e-mail, unique par admin (max 255 caractères) - ce champ est obligatoire
  • passwordNeverExpires : Valeur booléenne (vrai/faux). Si la valeur est définie à vrai, le mot de passe de l'administrateur n'expire jamais - ce champ est obligatoire
  • mfaEnabled : Valeur booléenne (vrai/faux). Si la valeur est définie sur vrai, l'administrateur doit utiliser un code MFA pour se connecter à l'Application de gestion Cato - ce champ est obligatoire
  • managedRoles : tableau de updateAdminRoleInput. Définit un ou plusieurs rôles qui sont assignés à l'administrateur. Pour les administrateurs revendeurs, ce champ définit les rôles qui sont assignés à l'administrateur pour les comptes gérés. Si ce champ n'est pas défini pour l'appel API, l'administrateur se voit attribuer le rôle de visualiseur (ID 2)

    • Utilisez l'ID 1 pour assigner le rôle d'éditeur à l'admin
  • rôlesReseller : tableau de updateAdminRoleInput (relevant uniquement pour les administrateurs revendeurs). Définit les rôles que l'admin est assigné pour le compte revendeur. Si ce champ n'est pas défini pour l'appel API, alors l'admin est attribué le rôle de visualiseur pour le compte revendeur.

Une fois l'admin créé, le déroulement est le même que s'il avait été créé dans l'Application de gestion Cato.

Si le compte est défini pour permettre aux administrateurs de se connecter avec un nom d'utilisateur et un mot de passe, l'administrateur recevra l'e-mail de bienvenue avec un lien pour activer le compte et définir le mot de passe.

image1.png

ajouterExemple De l'API Admin

mutation {
 admin(accountId:"xxxxxx") {
 addAdmin(input: {
 firstName :"dani2",
 lastName :"din2"
 email: "danidin5@4catonetworks.com",
 passwordNeverExpires: true,
 mfaEnabled: false,
 managedRoles: [{ role: { id: 2} }, {role: {id:3}}]
 }) {
 adminID
 }
 }
}
image2.png
image3.png

updateConfiguration Des administrateurs API

L'API de configuration updateAdmin vous permet de mettre à jour les informations de l'administrateur (l'e-mail et l'ID de l'administrateur ne peuvent pas être mis à jour).

updateParamètres D'entrée de l'admin

  • identifiantCompte (obligatoire)

updateArguments Admin

  • adminID (obligatoire)
  • firstName : Le prénom de l'admin
  • lastName : Le nom de l'admin
  • passwordNeverExpires : Valeur booléenne (vrai/faux). Si la valeur est définie à vrai, le mot de passe de l'administrateur n'expire jamais
  • mfaEnabled : Valeur booléenne (vrai/faux). Si la valeur est définie à vrai, l'administrateur doit utiliser un code MFA pour se connecter à l'Application de gestion Cato
  • managedRoles : tableau de updateAdminRoleInput. Définit un ou plusieurs rôles attribués à l'admin. Pour les administrateurs revendeurs, ce champ définit les rôles assignés à l'admin pour les comptes gérés.
  • rôlesReseller : tableau de updateAdminRoleInput (relevant uniquement pour les administrateurs revendeurs). Définit les rôles que l'admin est assigné pour le compte revendeur.

updateExemple De l'API Admin

mutation {
 admin(accountId: "26") {
 updateAdmin(
 adminID: "28876"
 input: {
 firstName :"échantillon"
 lastName :"admin"
 passwordNeverExpires: true
 managedRoles: [{ role: { id: 1 } }]
 }
 ) {
 adminID
 }
 }
}
updateAdmin.png

supprimerAdmin

L'API de configuration removeAdmin vous permet de supprimer un administrateur du compte.

supprimerArguments Admin

  • identifiantCompte (obligatoire)
  • adminID (obligatoire)

supprimerExemple De l'API Admin

mutation {
 admin(accountId:"XXX") {
 removeAdmin(adminID:YYY
 ) {
 adminID
 }
 }
}

admins API En lecture seule

La requête de l'API admins en lecture seule renvoie des données concernant tous les administrateurs du compte, y compris : id, email, prénom, nom, passwordNeverExpires, mfaEnabled et Rôles.

paramètre D'entrée des Admins

  • identifiantCompte (obligatoire)

arguments Admins

  • id : L'ID Cato de l'admin
  • firstName : Le prénom de l'admin
  • lastName : Le nom de l'admin
  • email : L'adresse e-mail
  • passwordNeverExpires : Valeur booléenne (vrai/faux). Si la valeur est définie à vrai, le mot de passe de l'administrateur n'expire jamais
  • mfaEnabled : Valeur booléenne (vrai/faux). Si la valeur est définie à vrai, l'administrateur doit utiliser un code MFA pour se connecter à l'Application de gestion Cato
  • managedRoles : tableau de updateAdminRoleInput. Définit un ou plusieurs rôles attribués à l'admin. Pour les administrateurs revendeurs, ce champ définit les rôles assignés à l'admin pour les comptes gérés.
  • rôlesReseller : tableau de updateAdminRoleInput (relevant uniquement pour les administrateurs revendeurs). Définit les rôles que l'admin est assigné pour le compte revendeur.

exemple D'API Admins

query {
 admins(accountID: XXXX) {
 items {
 id
 email
 firstName
 lastName
 modifyDate
 creationDate
 passwordNeverExpires
 mfaEnabled
 managedRoles {
 role {
 id
 name
 }
 
 resellerRoles {
 role {
 id
 name
 }
 }
 }
 }
 }
admins.png

getAPI Admin En lecture seule

La requête de l'API getAdmin en lecture seule renvoie des informations sur un administrateur de compte unique, telles que : e-mail, prénom, nom, passwordNeverExpires, mfaEnabled et Rôles

paramètres D'entrée Admin

  • identifiantCompte (obligatoire)
  • adminID (obligatoire)

arguments Admin

  • firstName : Le prénom de l'admin
  • lastName : Le nom de l'admin
  • email : L'adresse e-mail
  • passwordNeverExpires : Valeur booléenne (vrai/faux). Si défini à vrai, le mot de passe de l'administrateur n'expire jamais
  • mfaEnabled : Valeur booléenne (vrai/faux). Si défini à vrai, l'administrateur doit utiliser un code MFA pour se connecter à l'Application de gestion Cato
  • managedRoles : tableau de updateAdminRoleInput. Définit un ou plusieurs rôles attribués à l'admin. Pour les administrateurs revendeurs, ce champ définit les rôles assignés à l'admin pour les comptes gérés.
  • rôlesReseller : tableau de updateAdminRoleInput (relevant uniquement pour les administrateurs revendeurs). Définit les rôles que l'admin est assigné pour le compte revendeur.

exemple D'API Admins

query {
 getAdmin(accountId: "XXX", adminID: YYY) {
 id
 firstName
 lastName
 email
 passwordNeverExpires
 mfaEnabled
 creationDate
 managedRoles {
 role {
 id
 name
 }
 }
 resellerRoles {
 role {
 id
 name
 }
 }
 }
 }
getAdmin.png

accountRoles API En lecture seule

La requête en lecture seule de l'API accountRoles renvoie tous les rôles définis pour le compte (rôles personnalisés et prédéfinis). Il est requis pour les clients qui utilisent l’API addAdmin car cette API montre les IDs de rôle (utilisés par l’API addAdmin).

paramètres D'entrée accountRoles

  • idCompte
  • Type de compte

    • Régulier (pour les rôles de comptes réguliers ou gérés)
    • Revendeur (pour les rôles de comptes de revendeur)

arguments accountRoles

   id : ID! (l'identifiant du rôle)
 name: String! (le nom du rôle)
 description : String (la description)
 isPredefined: Boolean! (est-ce un rôle prédéfini ou personnalisé)
image4.png

exemple De la requête accountRoles

query{
 accountRoles(accountID:XXX, accountType:REGULAR)
 {
 articles
 {
 id
 name
 isPredefined
 description
 }
 total
 }

configuration De updateAdminRoleInput API

L'API de configuration updateAdminRoleInput vous permet de mettre à jour les Paramètres pour un rôle d'administrateur pour l'application de gestion Cato.

entrée updateAdminRoleInput {
 rôle: rôleDeMiseAJourCompteInput!
  entitésAutorisées : [inputEntity!]
}

Cet article vous a-t-il été utile ?

Utilisateurs qui ont trouvé cela utile : 0 sur 0

0 commentaire