Gestionar administradores con la API de Cato

Este artículo discute las diferentes API de Cato que le permiten gestionar administradores y roles de administrador para la Aplicación de Gestión de Cato. Esta API admite la gestión de administradores tanto para cuentas de revendedor como para cuentas regulares.

addAdmin Configuración de API de Configuración de Administradores

La API de configuración addAdmin crea nuevos administradores para la cuenta en la Aplicación de Gestión de Cato.

addAdmin Parámetro de Entrada

accountId (obligatorio)

addAdmin Argumentos

Estos son los argumentos para la API de configuración addAdmin:

Nombre: El nombre del administrador (máx 255 caracteres) – este campo es obligatorio
Apellido: El apellido del administrador (máx 255 caracteres) – este campo es obligatorio
Correo electrónico: La dirección de correo electrónico, única por administrador (máx 255 caracteres) – este campo es obligatorio
passwordNeverExpires: Valor booleano (true/false). Si el valor está establecido en verdadero, la contraseña del administrador nunca vence – este campo es obligatorio
mfaEnabled: Valor booleano (true/false). Si el valor está establecido en verdadero, el administrador debe usar un código MFA para iniciar sesión en la Aplicación de Gestión de Cato - este campo es obligatorio
managedRoles: array de updateAdminRoleInput. Define uno o más roles que se asignan al administrador. Para administradores revendedores, este campo define los roles que se asignan al administrador para las cuentas gestionadas. Si este campo no se define en la llamada a la API, el administrador se asigna el rol de visor (ID 2)
- Use la ID 1 para asignar el rol de editor al administrador
resellerRoles: arreglo de updateAdminRoleInput (relevante solo para administradores de revendedor). Define los roles que se asignan al administrador para la cuenta del revendedor. Si este campo no se define para la llamada de API, el administrador se asigna el rol de visualizador para la cuenta del revendedor.

Una vez creado el administrador, el flujo es el mismo que si el administrador se hubiera creado en la Aplicación de Gestión de Cato.

Si la cuenta está definida para permitir que los administradores inicien sesión con nombre de usuario y contraseña, entonces el administrador recibirá el correo de bienvenida con un enlace para activar la cuenta y establecer la contraseña.

addAdmin Ejemplo de API

mutation {
 admin(accountId:"xxxxxx") {
 addAdmin(input: {
 firstName :"dani2",
 lastName :"din2"
 correo electrónico: "danidin5@4catonetworks.com",
 passwordNeverExpires: true,
 mfaEnabled: false,
 managedRoles: [{ rol: { id: 2} }, {rol: {id:3}}]
 }) {
 adminID
 }
 }
}

updateAdmin Configuración de API de Configuración de Administradores

La API de configuración updateAdmin le permite actualizar la información del administrador (no se puede actualizar el email ni el ID del administrador).

updateAdmin Parámetros de Entrada

accountId (obligatorio)

updateAdmin Argumentos

adminID (obligatorio)
Nombre: El nombre del administrador
Apellido: El apellido del administrador
passwordNeverExpires: Valor booleano (true/false). Si el valor está establecido en true, la contraseña del administrador nunca vence
mfaEnabled: Valor booleano (true/false). Si el valor está establecido en true, el administrador debe usar un código MFA para iniciar sesión en la Aplicación de Gestión de Cato
managedRoles: array de updateAdminRoleInput. Define uno o más roles que se asignan al administrador. Para los administradores de revendedor, este campo define los roles que se asignan al administrador para las cuentas administradas.
resellerRoles: array de updateAdminRoleInput (relevante solo para administradores de revendedor). Define los roles que se asignan al administrador para la cuenta del revendedor.

updateAdmin Ejemplo de API

mutation {
 admin(accountId: "26") {
 updateAdmin(
 adminID: "28876"
 input: {
 firstName: "sample"
 lastName: "admin"
 passwordNeverExpires: true
 managedRoles: [{ rol: { id: 1 } }]
 }
 ) {
 adminID
 }
 }
}

removeAdmin

La API de configuración removeAdmin le permite eliminar un administrador de la cuenta.

removeAdmin Argumentos

accountId (obligatorio)
adminID (obligatorio)

removeAdmin Ejemplo de API

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

admins API de Solo Lectura

La consulta de API de solo lectura admins devuelve datos sobre todos los administradores de la cuenta, incluyendo: id, email, Nombre, Apellido, passwordNeverExpires, mfaEnabled, y roles.

admins Parámetro de Entrada

accountId (obligatorio)

admins Argumentos

id: El ID de Cato del administrador
Nombre: El nombre del administrador
Apellido: El apellido del administrador
Correo electrónico: La dirección de correo electrónico
passwordNeverExpires: Valor booleano (true/false). Si el valor está establecido en true, la contraseña del administrador nunca vence
mfaEnabled: Valor booleano (true/false). Si el valor está establecido en true, el administrador debe usar un código MFA para iniciar sesión en la Aplicación de Gestión de Cato
managedRoles: array de updateAdminRoleInput. Define uno o más roles que se asignan al administrador. Para los administradores de revendedor, este campo define los roles que se asignan al administrador para las cuentas administradas.
resellerRoles: array de updateAdminRoleInput (relevante solo para administradores de revendedor). Define los roles que el administrador está asignado para la cuenta del revendedor.

admins Ejemplo de API

query {
 admins(accountID: XXXX) {
 items {
 id
 correo electrónico
 Nombre
 Apellido
 modifyDate
 creationDate
 passwordNeverExpires
 mfaEnabled
 managedRoles {
 rol {
 id
 nombre
 }
	resellerRoles {
 rol {
 id
 nombre
 }
 }
 }
 }
}

getAdmin API de Solo Lectura

La consulta de API de solo lectura getAdmin devuelve información sobre un único administrador de cuenta, como: Email, Nombre, Apellido, passwordNeverExpires, mfaEnabled, y roles

getAdmin Parámetros de Entrada

accountId (obligatorio)
adminID (obligatorio)

getAdmin Argumentos

Nombre: El nombre del administrador
Apellido: El apellido del administrador
Correo electrónico: La dirección de correo electrónico
passwordNeverExpires: Valor booleano (true/false). Si está configurado en verdadero, la contraseña del administrador nunca vence
mfaEnabled: Valor booleano (true/false). Si está configurado en verdadero, el administrador debe usar un código MFA para iniciar sesión en la Aplicación de Gestión de Cato
managedRoles: array de updateAdminRoleInput. Define uno o más roles que se asignan al administrador. Para los administradores de revendedor, este campo define los roles que se asignan al administrador para las cuentas administradas.
resellerRoles: array de updateAdminRoleInput (relevante solo para administradores de revendedor). Define los roles que el administrador está asignado para la cuenta del revendedor.

getAdmin Ejemplo de API

query {
 getAdmin(accountId: "XXX", adminID: YYY) {
 id
 Nombre
 Apellido
 correo electrónico
 passwordNeverExpires
 mfaEnabled
 creationDate
 managedRoles {
 rol {
 id
 nombre
 }
 }
 resellerRoles {
 rol {
 id
 nombre
 }
 }
 }
}

accountRoles API de Solo Lectura

La consulta de API de solo lectura accountRoles devuelve todos los roles definidos para la cuenta (roles personalizados y los predefinidos). Es necesario para los clientes que utilizan la API addAdmin, porque esta API muestra los IDs de rol (utilizados por la API addAdmin).

accountRoles Parámetros de Entrada

accountId
accountType
- Regular (para roles de cuentas regulares o administradas)
- Revendedor (para roles de cuentas de revendedor)

accountRoles Argumentos

   id: ID! (el id del rol)
 nombre: String! (el nombre del rol)
 descripción: String (la descripción)
 esPredefinido: Boolean! (es un rol predefinido o personalizado)

accountRoles Ejemplo de Consulta

query{
 accountRoles(accountID:XXX, accountType:REGULAR)
 {
 items
 {
 id
 nombre
 esPredefinido
 descripción
 }
 total
 }
}

updateAdminRoleInput Configuración de API

La API de configuración updateAdminRoleInput le permite actualizar la configuración para un rol de administrador para la Aplicación de Gestión de Cato.

input updateAdminRoleInput {
 rol: updateAccountRoleInput!
  allowedEntities: [entityInput!]
}