Користувачі, дозволи та організації застосунку
На цій сторінці
Свідомо обирайте середовище попереднього перегляду або виробниче середовище. Сутність організації відповідає організації клієнта; її 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 на хостингу.
Машиночитані контракти інструментів містять вкладені схеми аргументів.