В этой статье обсуждаются различные Cato API, которые позволяют управлять администраторами и их ролями в Приложении управления Cato. Этот API поддерживает управление администраторами как для учетных записей реселлеров, так и для обычных учетных записей.
Конфигурация API addAdmin создает новых администраторов для учетной записи в Приложении управления Cato.
Это аргументы для конфигурации API addAdmin:
- 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.
Если учетная запись определена для позволения администраторам входить с помощью имени пользователя и пароля, администратор получит приветственное письмо со ссылкой для активации учетной записи и установки пароля.
мутация {
администратор(accountId:"xxxxxx") {
добавить администратора(ввод: {
firstName :"dani2",
lastName :"din2"
email: "danidin5@4catonetworks.com",
passwordNeverExpires: true,
mfaEnabled: false,
managedRoles: [{ роль: { id: 2} }, {роль: {id:3}}]
}) {
adminID
}
}
}
Конфигурация API updateAdmin позволяет обновить информацию администратора (адрес электронной почты и ID администратора обновить нельзя).
- adminID (обязательно)
- firstName: Имя администратора
- lastName: Фамилия администратора
- passwordNeverExpires: Логическое значение (true/false). Если значение установлено на true, пароль администратора никогда не истекает
- mfaEnabled: Логическое значение (true/false). Если значение установлено на true, администратор должен использовать MFA-код для входа в Приложение Управления Cato
- managedRoles: массив
updateAdminRoleInput. Определяет одну или несколько ролей, назначенных администратору. Для реселлера это поле определяет роли, назначенные администратору для управляемых учетных записей. - resellerRoles: массив
updateAdminRoleInput(релевантно только для реселлеров). Определяет роли, назначенные администратору для учетной записи реселлера.
Запрос read-only API admins возвращает данные о всех администраторах учетной записи, включая: id, email, Имя, Фамилия, passwordNeverExpires, mfaEnabled и роли.
- id: ID Cato администратора
- firstName: Имя администратора
- lastName: Фамилия администратора
- email: Адрес электронной почты
- passwordNeverExpires: Логическое значение (true/false). Если значение установлено на true, пароль администратора никогда не истекает
- mfaEnabled: Логическое значение (true/false). Если значение установлено на true, администратор должен использовать MFA-код для входа в Приложение Управления Cato
- managedRoles: массив updateAdminRoleInput. Определяет одну или несколько ролей, назначенных администратору. Для реселлера это поле определяет роли, назначенные администратору для управляемых учетных записей.
- resellerRoles: массив updateAdminRoleInput (релевантно только для реселлеров). Определяет роли, назначенные администратору для учетной записи реселлера.
Запрос read-only API getAdmin возвращает информацию об одном администраторе учетной записи, такую как: Почта, Имя, Фамилия, passwordNeverExpires, mfaEnabled и роли
- firstName: Имя администратора
- lastName: Фамилия администратора
- email: Адрес электронной почты
- passwordNeverExpires: Логическое значение (true/false). Если установлено в true, пароль администратора никогда не истекает
- mfaEnabled: Логическое значение (true/false). Если установлено в true, администратор должен использовать MFA-код для входа в Приложение Управления Cato
- managedRoles: массив updateAdminRoleInput. Определяет одну или несколько ролей, назначенных администратору. Для реселлера это поле определяет роли, назначенные администратору для управляемых учетных записей.
- resellerRoles: массив updateAdminRoleInput (релевантно только для реселлеров). Определяет роли, назначенные администратору для учетной записи реселлера.
Запрос API read-only accountRoles возвращает все роли, определенные для учетной записи (пользовательские роли и предопределенные). Это требуется для клиентов, которые используют API addAdmin, потому что этот API показывает идентификаторы ролей (используется API addAdmin).
- accountId
-
accountType
- Обычные (для обычных или управляемых ролей учетных записей)
- Реселлер (для ролей учетной записи реселлера)
0 комментариев
Статья закрыта для комментариев.