--- title: "使用Cato API管理管理员" slug: "managing-admins-with-the-cato-api" updated: 2026-07-30T03:28:05Z published: 2026-07-30T03:28:05Z 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. # 使用Cato API管理管理员 本文讨论了不同的Cato API,这些API允许您管理Cato管理应用程序的管理员和管理员角色。 该API支持管理经销商账户和普通账户的管理员。 ## addAdmin配置API `addAdmin` 配置API为Cato管理应用程序中的账户创建新的管理员。 ### addAdmin输入参数 - accountId(必填) ### addAdmin参数 以下是`addAdmin`配置API的参数: - firstName: 管理员的名字(最大255个字符)——此字段为必填项 - lastName: 管理员的姓氏(最大255个字符)——此字段为必填项 - email: 电子邮件地址,管理员唯一(最大255个字符)——此字段为必填项 - passwordNeverExpires: 布尔值(true/false)。 如果值设置为true,管理员的密码永不过期——此字段为必填项 - mfaEnabled: 布尔值(true/false)。 如果值设置为true,管理员必须使用MFA代码登录Cato管理应用程序——此字段为必填项 - managedRoles: updateAdminRoleInput数组。 定义一个或多个分配给管理员的角色。 对于经销商管理员,此字段定义分配给管理员用于托管账户的角色。 如果API调用未定义此字段,则管理员被赋予查看者角色(ID 2) - 使用ID 1将编辑者角色分配给管理员 - resellerRoles: updateAdminRoleInput数组(仅与经销商管理员相关)。 定义管理员在经销商账户中分配的角色。 如果此字段未为API调用定义,则管理员被分配查看者角色用于经销商账户。 一旦创建管理员,该流程与通过Cato管理应用程序创建管理员的流程相同。 如果账户被定义为允许管理员使用用户名和密码登录,则管理员将收到欢迎邮件,邮件中包含一个链接以激活账户和设置密码。 | ![image1.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%3A23%3A43Z&se=2026-11-19T06%3A23%3A43Z&sr=b&sp=r&sig=tQXxRvZIHqYwiq8BD7BxOHZDmQnFEl4OBDCyMwARrRo%3D) | | --- | ### addAdmin 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 } } } ``` | ![image2.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%3A23%3A43Z&se=2026-11-19T06%3A23%3A43Z&sr=b&sp=r&sig=C7%2Fhpe%2FCD8MG4v6dRHrX8VZ7TJ9oYTZXaYbiM%2B%2B2VHg%3D) | | --- | | ![image3.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%3A23%3A43Z&se=2026-11-19T06%3A23%3A43Z&sr=b&sp=r&sig=DpTWMSIx1p31t4EaQxlCPNG44BGHwZoGocFjfgIbLRM%3D) | | --- | ## updateAdmin配置API `updateAdmin` 配置API允许您更新管理员信息(管理员的邮箱和ID不能更新)。 ### updateAdmin输入参数 - accountId(必填) ### updateAdmin参数 - adminID(必填) - firstName: 管理员的名字 - lastName: 管理员的姓 - passwordNeverExpires: 布尔值(true/false)。 如果值设置为**true**,管理员的密码永不过期 - mfaEnabled: 布尔值(true/false)。 如果值设置为**true**,管理员必须使用MFA代码登录Cato管理应用程序 - managedRoles: `updateAdminRoleInput`数组。 定义一个或多个分配给管理员的角色。 对于经销商管理员,此字段定义分配给管理员用于托管账户的角色。 - resellerRoles: `updateAdminRoleInput`数组(仅与经销商管理员相关)。 定义管理员在经销商账户中分配的角色。 ### updateAdmin 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%3A23%3A43Z&se=2026-11-19T06%3A23%3A43Z&sr=b&sp=r&sig=1Nb7XcmpzN7MHi%2BJqISPEFyFh7wAxUnP6fRTqleFaio%3D) ## removeAdmin `removeAdmin` 配置API允许您从账户中删除管理员。 ### removeAdmin参数 - accountId(必填) - adminID(必填) ### removeAdmin API示例 ```plaintext mutation { admin(accountId:"XXX") { removeAdmin(adminID:YYY ) { adminID } } } ``` ## admins只读API `admins` 只读API查询返回关于账户所有管理员的数据,包括:ID,邮箱,名字,姓氏,密码永不过期,MFA启用状态和角色。 ### admins输入参数 - accountId(必填) ### admins参数 - id: 管理员的Cato ID - firstName: 管理员的名字 - lastName: 管理员的姓 - email: 电子邮件地址 - passwordNeverExpires: 布尔值(true/false)。 如果值设置为**true**,管理员的密码永不过期 - mfaEnabled: 布尔值(true/false)。 如果值设置为**true**,管理员必须使用MFA代码登录Cato管理应用程序 - managedRoles: updateAdminRoleInput数组。 定义一个或多个分配给管理员的角色。 对于经销商管理员,此字段定义分配给管理员用于托管账户的角色。 - resellerRoles: updateAdminRoleInput数组(仅与经销商管理员相关)。 定义管理员在经销商账户中分配的角色。 ### admins 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%3A23%3A43Z&se=2026-11-19T06%3A23%3A43Z&sr=b&sp=r&sig=eoMM47bFq6Vh1BFbkNu6rfdb6HZ31jNyoxDuwe0KY1o%3D) ## getAdmin只读API `getAdmin` 只读API查询返回有关单个账户管理员的信息,如邮箱,名字,姓氏,密码永不过期,MFA启用状态和角色 ### getAdmin输入参数 - accountId(必填) - adminID(必填) ### getAdmin参数 - firstName: 管理员的名字 - lastName: 管理员的姓 - email: 电子邮件地址 - passwordNeverExpires: 布尔值(true/false)。 如果设置为true,管理员的密码永不过期 - mfaEnabled: 布尔值(true/false)。 如果设置为true,管理员必须使用MFA代码登录Cato管理应用程序 - managedRoles: updateAdminRoleInput数组。 定义一个或多个分配给管理员的角色。 对于经销商管理员,此字段定义分配给管理员用于托管账户的角色。 - resellerRoles: updateAdminRoleInput数组(仅与经销商管理员相关)。 定义管理员在经销商账户中分配的角色。 ### getAdmin 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) ## accountRoles只读API `accountRoles` API只读查询返回为账户定义的所有角色(自定义角色和预定义角色)。 对于使用`addAdmin` API的客户是必需的,因为这些API显示角色ID(由addAdmin API使用)。 ### accountRoles输入参数 - accountId - accountType - 常规(适用于常规或托管账户角色) - 经销商(适用于经销商账户角色) #### accountRoles参数 ```plaintext   id: ID! (角色的id) 名称: 字符串! (角色的名称) 描述: 字符串(描述) isPredefined: 布尔值! (是预定义角色还是自定义角色) ``` | ![image4.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%3A23%3A43Z&se=2026-11-19T06%3A23%3A43Z&sr=b&sp=r&sig=CiSGY%2FLslJsLCG1Q4MpvzUvfH6w5MtxWkdtytjEhkH0%3D) | | --- | ### accountRoles查询示例 ```plaintext query{ accountRoles(accountID:XXX, accountType:REGULAR) { items { id name isPredefined description } total } } ``` ## updateAdminRoleInput配置API `updateAdminRoleInput` 配置API允许您更新Cato管理应用程序的管理员角色设置。 ```plaintext 输入updateAdminRoleInput { 角色: updateAccountRoleInput!  allowedEntities: [entityInput!] } ```