Пользователи приложения, права доступа и организации
На этой странице
Осознанно выбирайте среду: предварительный просмотр или продакшен. Сущность организации представляет организацию клиента. В аргументах инструментов, которые поддерживают slug, он обозначает границы этой организации.
Как пользоваться этими инструментами
- Сначала вызовите соответствующий инструмент чтения или проверки статуса.
- Проверьте целевой объект и обязательные аргументы.
- Выполните одно запланированное действие. Если требуется явное подтверждение человека, сначала получите его.
- После этого проверьте статус или повторно прочитайте затронутый ресурс.
Входные параметры ниже описывают публичный контракт. Ориентируйтесь на текущий список инструментов подключённого сервера. Некоторым инструментам нужен определённый хост, целевой объект, режим инференса или план. Идентификаторы — это значения, возвращённые предыдущими инструментами; не придумывайте их.
app_users
Пользователи сгенерированного приложения.
Прочитайте возвращённый ресурс. Планируя следующее действие, используйте его текущие значения.
| Аргумент | Обязательный | Тип или допустимые значения |
|---|
| projectId | Нет | строка |
| scope | Нет | ephemeral, production |
| all | Нет | логическое значение |
Операция: только чтение.
Доступные конфигурации: stdio, облачный проект, облачный инференс; stdio, облачный проект, делегированный инференс; stdio, локальный проект, облачный инференс; stdio, локальный проект, делегированный инференс; размещённый HTTP-сервер.
Машиночитаемые контракты инструментов содержат вложенные схемы аргументов.
manage_app_user
Пригласить пользователя приложения, изменить его данные или удалить его.
Если удалить или отключить пользователя, он может потерять доступ. Прежде чем подтверждать действия с разрушительными последствиями, проверьте область действия и выбранный профиль.
| Аргумент | Обязательный | Тип или допустимые значения |
|---|
| projectId | Нет | строка |
| scope | Нет | ephemeral, production |
| action | Да | invite, update, remove |
| email | Нет | строка; минимальная длина 3; максимальная длина 254 |
| name | Нет | строка; минимальная длина 1; максимальная длина 128 |
| role | Нет | строка; минимальная длина 1; максимальная длина 32 |
| disabled | Нет | логическое значение |
| profileId | Нет | строка; минимальная длина 1; максимальная длина 256 |
| confirm | Нет | логическое значение |
Операция: может изменить состояние или запустить работу; возможны разрушительные последствия.
Доступные конфигурации: stdio, облачный проект, облачный инференс; stdio, облачный проект, делегированный инференс; stdio, локальный проект, облачный инференс; stdio, локальный проект, делегированный инференс; размещённый HTTP-сервер.
Машиночитаемые контракты инструментов содержат вложенные схемы аргументов.
app_permissions
Права доступа в сгенерированном приложении.
Прочитайте возвращённый ресурс. Планируя следующее действие, используйте его текущие значения.
| Аргумент | Обязательный | Тип или допустимые значения |
|---|
| projectId | Нет | строка |
| scope | Нет | ephemeral, production |
Операция: только чтение.
Доступные конфигурации: stdio, облачный проект, облачный инференс; stdio, облачный проект, делегированный инференс; stdio, локальный проект, облачный инференс; stdio, локальный проект, делегированный инференс; размещённый HTTP-сервер.
Машиночитаемые контракты инструментов содержат вложенные схемы аргументов.
set_app_permission_default
Задать, кому право доступа предоставляется по умолчанию.
Меняет то, кому право доступа предоставляется по умолчанию. Затем проверьте доступ у двух пользователей: у одного он должен быть разрешён, у другого — запрещён.
| Аргумент | Обязательный | Тип или допустимые значения |
|---|
| projectId | Нет | строка |
| scope | Нет | ephemeral, production |
| permission | Да | строка; минимальная длина 1; максимальная длина 128 |
| defaultClass | Нет | none, user, member, owner |
| entityScoped | Нет | логическое значение |
Операция: может изменить состояние или запустить работу.
Доступные конфигурации: stdio, облачный проект, облачный инференс; stdio, облачный проект, делегированный инференс; stdio, локальный проект, облачный инференс; stdio, локальный проект, делегированный инференс; размещённый HTTP-сервер.
Машиночитаемые контракты инструментов содержат вложенные схемы аргументов.
app_grants
Кому и какие права доступа предоставлены в сгенерированном приложении.
Прочитайте возвращённый ресурс. Планируя следующее действие, используйте его текущие значения.
| Аргумент | Обязательный | Тип или допустимые значения |
|---|
| projectId | Нет | строка |
| scope | Нет | ephemeral, production |
| profileId | Нет | строка; минимальная длина 1; максимальная длина 256 |
| group | Нет | строка; минимальная длина 1; максимальная длина 128 |
| entitySlug | Нет | строка; минимальная длина 1; максимальная длина 63 |
Операция: только чтение.
Доступные конфигурации: stdio, облачный проект, облачный инференс; stdio, облачный проект, делегированный инференс; stdio, локальный проект, облачный инференс; stdio, локальный проект, делегированный инференс; размещённый HTTP-сервер.
Машиночитаемые контракты инструментов содержат вложенные схемы аргументов.
manage_app_grant
Предоставить или отозвать право доступа в сгенерированном приложении.
Предоставляйте только нужное право доступа и только нужным получателям. Отзывайте его только у тех, у кого планировали. Используйте entitySlug, чтобы ограничить действие организацией клиента.
| Аргумент | Обязательный | Тип или допустимые значения |
|---|
| projectId | Нет | строка |
| scope | Нет | ephemeral, production |
| action | Да | assign, revoke |
| permission | Да | строка; минимальная длина 1; максимальная длина 128 |
| profileId | Нет | строка; минимальная длина 1; максимальная длина 256 |
| group | Нет | строка; минимальная длина 1; максимальная длина 128 |
| entitySlug | Нет | строка; минимальная длина 1; максимальная длина 63 |
| resources | Нет | массив строк |
| mode | Нет | blanket, resources, all |
Операция: может изменить состояние или запустить работу; возможны разрушительные последствия.
Доступные конфигурации: stdio, облачный проект, облачный инференс; stdio, облачный проект, делегированный инференс; stdio, локальный проект, облачный инференс; stdio, локальный проект, делегированный инференс; размещённый HTTP-сервер.
Машиночитаемые контракты инструментов содержат вложенные схемы аргументов.
app_organizations
Организации в сгенерированном приложении.
Прочитайте возвращённый ресурс. Планируя следующее действие, используйте его текущие значения.
| Аргумент | Обязательный | Тип или допустимые значения |
|---|
| projectId | Нет | строка |
| scope | Нет | ephemeral, production |
| entitySlug | Нет | строка; минимальная длина 1; максимальная длина 63 |
Операция: только чтение.
Доступные конфигурации: stdio, облачный проект, облачный инференс; stdio, облачный проект, делегированный инференс; stdio, локальный проект, облачный инференс; stdio, локальный проект, делегированный инференс; размещённый HTTP-сервер.
Машиночитаемые контракты инструментов содержат вложенные схемы аргументов.
manage_app_organization
Переименовать организацию или управлять её участниками.
Меняет названия организаций клиентов и состав участников. Подтвердите, что выбраны нужная сущность организации и нужный пользователь.
| Аргумент | Обязательный | Тип или допустимые значения |
|---|
| projectId | Нет | строка |
| scope | Нет | ephemeral, production |
| action | Да | rename, add-member, update-member, remove-member |
| entitySlug | Да | строка; минимальная длина 1; максимальная длина 63 |
| title | Нет | строка; минимальная длина 1; максимальная длина 256 |
| email | Нет | строка; минимальная длина 3; максимальная длина 254 |
| name | Нет | строка; минимальная длина 1; максимальная длина 128 |
| owner | Нет | логическое значение |
| profileId | Нет | строка; минимальная длина 1; максимальная длина 256 |
| groups | Нет | массив строк |
Операция: может изменить состояние или запустить работу; возможны разрушительные последствия.
Доступные конфигурации: stdio, облачный проект, облачный инференс; stdio, облачный проект, делегированный инференс; stdio, локальный проект, облачный инференс; stdio, локальный проект, делегированный инференс; размещённый HTTP-сервер.
Машиночитаемые контракты инструментов содержат вложенные схемы аргументов.
app_groups
Группы организации в сгенерированном приложении.
Прочитайте возвращённый ресурс. Планируя следующее действие, используйте его текущие значения.
| Аргумент | Обязательный | Тип или допустимые значения |
|---|
| projectId | Нет | строка |
| scope | Нет | ephemeral, production |
| entitySlug | Да | строка; минимальная длина 1; максимальная длина 63 |
| group | Нет | строка; минимальная длина 1; максимальная длина 128 |
Операция: только чтение.
Доступные конфигурации: stdio, облачный проект, облачный инференс; stdio, облачный проект, делегированный инференс; stdio, локальный проект, облачный инференс; stdio, локальный проект, делегированный инференс; размещённый HTTP-сервер.
Машиночитаемые контракты инструментов содержат вложенные схемы аргументов.
manage_app_group
Создать, изменить или удалить группу либо управлять её участниками.
Участие в группах и наборы прав влияют на доступ пользователей. Прежде чем изменить или удалить группу, проверьте, что выбраны нужная группа и область действия.
| Аргумент | Обязательный | Тип или допустимые значения |
|---|
| projectId | Нет | строка |
| scope | Нет | ephemeral, production |
| action | Да | create, update, delete, add-members, remove-members |
| entitySlug | Да | строка; минимальная длина 1; максимальная длина 63 |
| group | Да | строка; минимальная длина 1; максимальная длина 128 |
| title | Нет | строка; минимальная длина 1; максимальная длина 256 |
| bundles | Нет | массив объектов |
| profileIds | Нет | массив строк |
| confirm | Нет | логическое значение |
Операция: может изменить состояние или запустить работу; возможны разрушительные последствия.
Доступные конфигурации: stdio, облачный проект, облачный инференс; stdio, облачный проект, делегированный инференс; stdio, локальный проект, облачный инференс; stdio, локальный проект, делегированный инференс; размещённый HTTP-сервер.
Машиночитаемые контракты инструментов содержат вложенные схемы аргументов.