--- title: "Gerenciando Admins com a API da Cato" slug: "managing-admins-with-the-cato-api" updated: 2026-07-30T01:47:54Z published: 2026-07-30T01:47:54Z canonical: "knowledge.catonetworks.com/managing-admins-with-the-cato-api" --- > ## Documentation Index > Fetch the complete documentation index at: https://knowledge.catonetworks.com/llms.txt > Use this file to discover all available pages before exploring further. # Gerenciando Admins com a API da Cato Este artigo discute as diferentes APIs da Cato que permitem gerenciar admins e funções de admin para o Aplicativo de Gerenciamento da Cato. Esta API suporta o gerenciamento de admins para contas de revendedor e contas regulares. ## addAdmin Configuração de Administradores API A API de configuração `addAdmin` cria novos admins para a conta no Aplicativo de Gerenciamento da Cato. ### addAdmin Parâmetro de Entrada - accountId (obrigatório) ### addAdmin Argumentos Estes são os argumentos para a API de configuração `addAdmin`: - firstName: O nome do administrador (máx 255 caracteres) – este campo é obrigatório - lastName: O sobrenome do administrador (máx 255 caracteres) – este campo é obrigatório - email: O endereço de e-mail, único por administrador (máx 255 caracteres) – este campo é obrigatório - passwordNeverExpires: Valor booleano (verdadeiro/falso). Se o valor for definido como verdadeiro, a senha do administrador nunca expira – este campo é obrigatório - mfaEnabled: Valor booleano (verdadeiro/falso). Se o valor for definido como verdadeiro, o administrador deve usar um código MFA para fazer login no Aplicativo de Gerenciamento Cato - este campo é obrigatório - managedRoles: matriz de updateAdminRoleInput. Define uma ou mais funções que são atribuídas ao administrador. Para administradores revendedores, este campo define as funções que são atribuídas ao administrador para as contas gerenciadas. Se este campo não estiver definido para a chamada da API, o admin será atribuído à função de visualizador (ID 2) - Use o ID 1 para atribuir a função de editor ao administrador - resellerRoles: matriz de updateAdminRoleInput (relevante apenas para administradores revendedores). Define as funções que o administrador está atribuído para a conta do revendedor. Se este campo não for definido para a chamada de API, então o administrador está atribuído à função de visualizador para a conta do revendedor. Uma vez que o administrador é criado, o fluxo é o mesmo como se o administrador tivesse sido criado no Aplicativo de Gerenciamento Cato. Se a conta estiver definida para permitir que admins entrem com nome de usuário e senha, então o admin receberá o email de boas-vindas com um link para ativar a conta e definir a senha. | ![imagem1.png](https://cdn.document360.io/81d0367c-2b69-4ba8-b412-1c8f46ce677e/Images/Documentation/8788772690717(1).png?sv=2026-02-06&spr=https&st=2026-11-19T05%3A42%3A01Z&se=2026-11-19T06%3A42%3A01Z&sr=b&sp=r&sig=5ihyWfuZ6iKe%2FYNj9lB%2BikyBjdUxEp9qwnGK34r3Z68%3D) | | --- | ### addAdmin Exemplo de API ```plaintext 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    }  } } ``` | ![imagem2.png](https://cdn.document360.io/81d0367c-2b69-4ba8-b412-1c8f46ce677e/Images/Documentation/8788805455517(1).png?sv=2026-02-06&spr=https&st=2026-11-19T05%3A42%3A01Z&se=2026-11-19T06%3A42%3A01Z&sr=b&sp=r&sig=qCeELzgS4L%2F2%2FfN351dpxR8Wtz0kyym159n1ppVZWoI%3D) | | --- | | ![imagem3.png](https://cdn.document360.io/81d0367c-2b69-4ba8-b412-1c8f46ce677e/Images/Documentation/8788805492637(1).png?sv=2026-02-06&spr=https&st=2026-11-19T05%3A42%3A01Z&se=2026-11-19T06%3A42%3A01Z&sr=b&sp=r&sig=9Q8GY4JS6f6p%2FvdL1As0dj2kRiK300y%2F6TZXM0Lr0R8%3D) | | --- | ## updateAdmin Configuração de Administradores API A API de configuração `updateAdmin` permite atualizar informações de admin (email e id do admin não podem ser atualizados). ### updateAdmin Parâmetros de Entrada - accountId (obrigatório) ### updateAdmin Argumentos - adminID (obrigatório) - firstName: O nome do administrador - lastName: O último do administrador - passwordNeverExpires: Valor booleano (verdadeiro/falso). Se o valor for definido para **verdadeiro**, a senha do administrador nunca expira - mfaEnabled: Valor booleano (verdadeiro/falso). Se o valor for definido para **verdadeiro**, o administrador deve usar um código MFA para fazer login no Aplicativo de Gerenciamento Cato - managedRoles: matriz de `updateAdminRoleInput`. Define uma ou mais funções que são atribuídas ao administrador. Para administradores revendedores, este campo define as funções que são atribuídas ao administrador para as contas gerenciadas. - resellerRoles: matriz de `updateAdminRoleInput` (relevante apenas para administradores revendedores). Define as funções que o administrador está atribuído para a conta do revendedor. ### updateAdmin Exemplo de API ```plaintext mutation {  admin(accountId: "26") {    updateAdmin(      adminID: "28876"      input: {        firstName: "sample"        lastName: "admin"        passwordNeverExpires: true        managedRoles: [{ role: { id: 1 } }]      }    ) {      adminID    }  } } ``` ![updateAdmin.png](https://cdn.document360.io/81d0367c-2b69-4ba8-b412-1c8f46ce677e/Images/Documentation/8788805514781(1).png?sv=2026-02-06&spr=https&st=2026-11-19T05%3A42%3A01Z&se=2026-11-19T06%3A42%3A01Z&sr=b&sp=r&sig=RQwDMfjov7DunZmWcyWiG7VxFRmfGaf5cvVTtrbk3DU%3D) ## removeAdmin A API de configuração `removeAdmin` permite excluir um admin da conta. ### removeAdmin Argumentos - accountId (obrigatório) - adminID (obrigatório) ### removeAdmin Exemplo de API ```plaintext mutation {  admin(accountId:"XXX") {    removeAdmin(adminID:YYY    ) {        adminID    }  } } ``` ## admins API Somente Leitura A consulta de API de leitura-only `admins` retorna dados sobre todos os admins da conta, incluindo: id, email, Primeiro Nome, Último Nome, passwordNeverExpires, mfaEnabled e funções. ### administradores Parâmetro de Entrada - accountId (obrigatório) ### admins Argumentos - id: O ID Cato do administrador - firstName: O nome do administrador - lastName: O último do administrador - email: O endereço de e-mail - passwordNeverExpires: Valor booleano (verdadeiro/falso). Se o valor for definido para **verdadeiro**, a senha do administrador nunca expira - mfaEnabled: Valor booleano (verdadeiro/falso). Se o valor for definido para **verdadeiro**, o administrador deve usar um código MFA para fazer login no Aplicativo de Gerenciamento Cato - managedRoles: matriz de updateAdminRoleInput. Define uma ou mais funções que são atribuídas ao administrador. Para administradores revendedores, este campo define as funções que são atribuídas ao administrador para as contas gerenciadas. - resellerRoles: matriz de updateAdminRoleInput (relevante apenas para administradores revendedores). Define as funções que o administrador está atribuído para a conta do revendedor. ### administradores Exemplo de API ```plaintext query {  admins(accountID: XXXX) {    items {      id      email      firstName      lastName      modifyDate      creationDate      passwordNeverExpires      mfaEnabled      managedRoles {        role {          id          name        } resellerRoles {        role {          id          name        }      }    }  } } ``` ![admins.png](https://cdn.document360.io/81d0367c-2b69-4ba8-b412-1c8f46ce677e/Images/Documentation/8788772828573(1).png?sv=2026-02-06&spr=https&st=2026-11-19T05%3A42%3A01Z&se=2026-11-19T06%3A42%3A01Z&sr=b&sp=r&sig=aopVvZNuBGhFldnNDkPkWpgGwx%2BchN07guaSPIndf58%3D) ## getAdmin API Somente Leitura A consulta de API de leitura-only `getAdmin` retorna informações sobre um único admin de conta, como: Email, Primeiro Nome, Último Nome, passwordNeverExpires, mfaEnabled e funções ### getAdmin Parâmetros de Entrada - accountId (obrigatório) - adminID (obrigatório) ### getAdmin Argumentos - firstName: O nome do administrador - lastName: O último nome do administrador - email: O endereço de e-mail - passwordNeverExpires: Valor booleano (verdadeiro/falso). Se for definido para verdadeiro, a senha do administrador nunca expira - mfaEnabled: Valor booleano (verdadeiro/falso). Se for definido para verdadeiro, o administrador deve usar um código MFA para fazer login no Aplicativo de Gerenciamento Cato - managedRoles: matriz de updateAdminRoleInput. Define uma ou mais funções que são atribuídas ao administrador. Para administradores revendedores, este campo define as funções que são atribuídas ao administrador para as contas gerenciadas. - resellerRoles: matriz de updateAdminRoleInput (relevante apenas para administradores revendedores). Define as funções que o administrador está atribuído para a conta do revendedor. ### getAdmin Exemplo de API ```plaintext query {  getAdmin(accountId: "XXX", adminID: YYY) {    id    firstName    lastName    email    passwordNeverExpires    mfaEnabled    creationDate    managedRoles {      role {        id        name      }    }    resellerRoles {      role {        id        name      }    }  } } ``` ![getAdmin.png](https://support.catonetworks.com/hc/article_attachments/8788772860701) ## role contas API Somente Leitura A consulta de API de leitura-only `accountRoles` retorna todas as funções definidas para a conta (funções personalizadas e as predefinidas). É necessário para clientes que usam a API `addAdmin`, porque esta API mostra os IDs de função (usados pela API addAdmin). ### role contas Parâmetros de Entrada - accountId - accountType - Regular (para funções de contas regulares ou gerenciadas) - Revendedor (para funções de contas de revendedor) #### role contas Argumentos ```plaintext   id: ID! (o id da função)   nome: String! (o nome da função)   descrição: String (a descrição)   éPredefinido: Boolean! (é uma função predefinida ou personalizada) ``` | ![imagem4.png](https://cdn.document360.io/81d0367c-2b69-4ba8-b412-1c8f46ce677e/Images/Documentation/8788772888605(1).png?sv=2026-02-06&spr=https&st=2026-11-19T05%3A42%3A01Z&se=2026-11-19T06%3A42%3A01Z&sr=b&sp=r&sig=YY84yEcbkGW9pTQxHASigsHO0VswnktHpJbHz6DgMOc%3D) | | --- | ### role contas Exemplo de Consulta ```plaintext consulta{  accountRoles(accountID:XXX, accountType:REGULAR)  {    items    {      id      name      isPredefined      description    }    total  } } ``` ## updateAdminRoleInput Configuração API A API de configuração `updateAdminRoleInput` permite atualizar as configurações de uma função de admin para o Aplicativo de Gerenciamento da Cato. ```plaintext input updateAdminRoleInput {  role: updateAccountRoleInput!  allowedEntities: [entityInput!] } ```