Użytkownicy aplikacji, uprawnienia i organizacje
Na tej stronie
Świadomie wybierz środowisko podglądowe lub produkcyjne. Encja organizacji to organizacja klienta; w obsługiwanych argumentach narzędzi tę granicę wskazuje jej slug.
Korzystanie z narzędzi
- Najpierw wywołaj odpowiednie narzędzie do odczytu lub sprawdzania stanu.
- Sprawdź cel operacji i wymagane argumenty.
- Wykonaj jedną zamierzoną operację. Jeśli wymaga ona wyraźnego potwierdzenia przez człowieka, najpierw je uzyskaj.
- Następnie sprawdź stan lub ponownie odczytaj zasób, którego dotyczyła operacja.
Poniższe dane wejściowe opisują publiczny kontrakt. Wiążąca jest aktualna lista narzędzi podłączonego serwera. Niektóre narzędzia wymagają określonego hosta, lokalizacji projektu, trybu wnioskowania lub planu. Identyfikatory to wartości zwrócone przez wcześniej wywołane narzędzia; nie wymyślaj ich.
app_users
Użytkownicy wygenerowanej aplikacji.
Odczytaj zwrócony zasób i zaplanuj następną czynność na podstawie jego aktualnych wartości.
| Argument | Wymagany | Typ lub dopuszczalne wartości |
|---|---|---|
projectId | Nie | ciąg znaków |
scope | Nie | ephemeral, production |
all | Nie | wartość logiczna |
Operacja: tylko odczyt.
Dostępne konfiguracje: stdio, projekt w chmurze, wnioskowanie w chmurze; stdio, projekt w chmurze, delegowane wnioskowanie; stdio, projekt lokalny, wnioskowanie w chmurze; stdio, projekt lokalny, delegowane wnioskowanie; hostowany HTTP.
Kontrakty narzędzi w formacie do odczytu maszynowego zawierają zagnieżdżone schematy argumentów.
manage_app_user
Zaproś użytkownika aplikacji, zaktualizuj jego dane lub go usuń.
Usunięcie lub wyłączenie użytkownika może odebrać mu dostęp. Przed potwierdzeniem zmian o skutkach destrukcyjnych sprawdź zakres i wybrany profil.
| Argument | Wymagany | Typ lub dopuszczalne wartości |
|---|---|---|
projectId | Nie | ciąg znaków |
scope | Nie | ephemeral, production |
action | Tak | invite, update, remove |
email | Nie | ciąg znaków; minimalna długość 3; maksymalna długość 254 |
name | Nie | ciąg znaków; minimalna długość 1; maksymalna długość 128 |
role | Nie | ciąg znaków; minimalna długość 1; maksymalna długość 32 |
disabled | Nie | wartość logiczna |
profileId | Nie | ciąg znaków; minimalna długość 1; maksymalna długość 256 |
confirm | Nie | wartość logiczna |
Operacja: może zmienić stan lub rozpocząć pracę; możliwe są skutki destrukcyjne.
Dostępne konfiguracje: stdio, projekt w chmurze, wnioskowanie w chmurze; stdio, projekt w chmurze, delegowane wnioskowanie; stdio, projekt lokalny, wnioskowanie w chmurze; stdio, projekt lokalny, delegowane wnioskowanie; hostowany HTTP.
Kontrakty narzędzi w formacie do odczytu maszynowego zawierają zagnieżdżone schematy argumentów.
app_permissions
Uprawnienia wygenerowanej aplikacji.
Odczytaj zwrócony zasób i zaplanuj następną czynność na podstawie jego aktualnych wartości.
| Argument | Wymagany | Typ lub dopuszczalne wartości |
|---|---|---|
projectId | Nie | ciąg znaków |
scope | Nie | ephemeral, production |
Operacja: tylko odczyt.
Dostępne konfiguracje: stdio, projekt w chmurze, wnioskowanie w chmurze; stdio, projekt w chmurze, delegowane wnioskowanie; stdio, projekt lokalny, wnioskowanie w chmurze; stdio, projekt lokalny, delegowane wnioskowanie; hostowany HTTP.
Kontrakty narzędzi w formacie do odczytu maszynowego zawierają zagnieżdżone schematy argumentów.
set_app_permission_default
Ustaw, komu domyślnie przysługuje uprawnienie.
Zmienia, kto domyślnie otrzymuje uprawnienie. Następnie przetestuj dostęp użytkownika, który ma uprawnienie, i takiego, który go nie ma.
| Argument | Wymagany | Typ lub dopuszczalne wartości |
|---|---|---|
projectId | Nie | ciąg znaków |
scope | Nie | ephemeral, production |
permission | Tak | ciąg znaków; minimalna długość 1; maksymalna długość 128 |
defaultClass | Nie | none, user, member, owner |
entityScoped | Nie | wartość logiczna |
Operacja: może zmienić stan lub rozpocząć pracę.
Dostępne konfiguracje: stdio, projekt w chmurze, wnioskowanie w chmurze; stdio, projekt w chmurze, delegowane wnioskowanie; stdio, projekt lokalny, wnioskowanie w chmurze; stdio, projekt lokalny, delegowane wnioskowanie; hostowany HTTP.
Kontrakty narzędzi w formacie do odczytu maszynowego zawierają zagnieżdżone schematy argumentów.
app_grants
Kto ma jakie uprawnienia w wygenerowanej aplikacji.
Odczytaj zwrócony zasób i zaplanuj następną czynność na podstawie jego aktualnych wartości.
| Argument | Wymagany | Typ lub dopuszczalne wartości |
|---|---|---|
projectId | Nie | ciąg znaków |
scope | Nie | ephemeral, production |
profileId | Nie | ciąg znaków; minimalna długość 1; maksymalna długość 256 |
group | Nie | ciąg znaków; minimalna długość 1; maksymalna długość 128 |
entitySlug | Nie | ciąg znaków; minimalna długość 1; maksymalna długość 63 |
Operacja: tylko odczyt.
Dostępne konfiguracje: stdio, projekt w chmurze, wnioskowanie w chmurze; stdio, projekt w chmurze, delegowane wnioskowanie; stdio, projekt lokalny, wnioskowanie w chmurze; stdio, projekt lokalny, delegowane wnioskowanie; hostowany HTTP.
Kontrakty narzędzi w formacie do odczytu maszynowego zawierają zagnieżdżone schematy argumentów.
manage_app_grant
Nadaj lub odbierz uprawnienie w wygenerowanej aplikacji.
Nadawaj i odbieraj tylko zamierzone uprawnienie i tylko zamierzonym odbiorcom. Granicę organizacji klienta wskazuj za pomocą entitySlug.
| Argument | Wymagany | Typ lub dopuszczalne wartości |
|---|---|---|
projectId | Nie | ciąg znaków |
scope | Nie | ephemeral, production |
action | Tak | assign, revoke |
permission | Tak | ciąg znaków; minimalna długość 1; maksymalna długość 128 |
profileId | Nie | ciąg znaków; minimalna długość 1; maksymalna długość 256 |
group | Nie | ciąg znaków; minimalna długość 1; maksymalna długość 128 |
entitySlug | Nie | ciąg znaków; minimalna długość 1; maksymalna długość 63 |
resources | Nie | tablica ciągów znaków |
mode | Nie | blanket, resources, all |
Operacja: może zmienić stan lub rozpocząć pracę; możliwe są skutki destrukcyjne.
Dostępne konfiguracje: stdio, projekt w chmurze, wnioskowanie w chmurze; stdio, projekt w chmurze, delegowane wnioskowanie; stdio, projekt lokalny, wnioskowanie w chmurze; stdio, projekt lokalny, delegowane wnioskowanie; hostowany HTTP.
Kontrakty narzędzi w formacie do odczytu maszynowego zawierają zagnieżdżone schematy argumentów.
app_organizations
Organizacje wygenerowanej aplikacji.
Odczytaj zwrócony zasób i zaplanuj następną czynność na podstawie jego aktualnych wartości.
| Argument | Wymagany | Typ lub dopuszczalne wartości |
|---|---|---|
projectId | Nie | ciąg znaków |
scope | Nie | ephemeral, production |
entitySlug | Nie | ciąg znaków; minimalna długość 1; maksymalna długość 63 |
Operacja: tylko odczyt.
Dostępne konfiguracje: stdio, projekt w chmurze, wnioskowanie w chmurze; stdio, projekt w chmurze, delegowane wnioskowanie; stdio, projekt lokalny, wnioskowanie w chmurze; stdio, projekt lokalny, delegowane wnioskowanie; hostowany HTTP.
Kontrakty narzędzi w formacie do odczytu maszynowego zawierają zagnieżdżone schematy argumentów.
manage_app_organization
Zmień nazwę organizacji lub zarządzaj jej członkami.
Zmienia nazwy organizacji klientów i zarządza ich członkami. Potwierdź, że wybrano właściwą encję organizacji i właściwego użytkownika.
| Argument | Wymagany | Typ lub dopuszczalne wartości |
|---|---|---|
projectId | Nie | ciąg znaków |
scope | Nie | ephemeral, production |
action | Tak | rename, add-member, update-member, remove-member |
entitySlug | Tak | ciąg znaków; minimalna długość 1; maksymalna długość 63 |
title | Nie | ciąg znaków; minimalna długość 1; maksymalna długość 256 |
email | Nie | ciąg znaków; minimalna długość 3; maksymalna długość 254 |
name | Nie | ciąg znaków; minimalna długość 1; maksymalna długość 128 |
owner | Nie | wartość logiczna |
profileId | Nie | ciąg znaków; minimalna długość 1; maksymalna długość 256 |
groups | Nie | tablica ciągów znaków |
Operacja: może zmienić stan lub rozpocząć pracę; możliwe są skutki destrukcyjne.
Dostępne konfiguracje: stdio, projekt w chmurze, wnioskowanie w chmurze; stdio, projekt w chmurze, delegowane wnioskowanie; stdio, projekt lokalny, wnioskowanie w chmurze; stdio, projekt lokalny, delegowane wnioskowanie; hostowany HTTP.
Kontrakty narzędzi w formacie do odczytu maszynowego zawierają zagnieżdżone schematy argumentów.
app_groups
Grupy organizacji w wygenerowanej aplikacji.
Odczytaj zwrócony zasób i zaplanuj następną czynność na podstawie jego aktualnych wartości.
| Argument | Wymagany | Typ lub dopuszczalne wartości |
|---|---|---|
projectId | Nie | ciąg znaków |
scope | Nie | ephemeral, production |
entitySlug | Tak | ciąg znaków; minimalna długość 1; maksymalna długość 63 |
group | Nie | ciąg znaków; minimalna długość 1; maksymalna długość 128 |
Operacja: tylko odczyt.
Dostępne konfiguracje: stdio, projekt w chmurze, wnioskowanie w chmurze; stdio, projekt w chmurze, delegowane wnioskowanie; stdio, projekt lokalny, wnioskowanie w chmurze; stdio, projekt lokalny, delegowane wnioskowanie; hostowany HTTP.
Kontrakty narzędzi w formacie do odczytu maszynowego zawierają zagnieżdżone schematy argumentów.
manage_app_group
Utwórz, zmień lub usuń grupę albo zarządzaj jej członkami.
Członkostwo w grupach i pakiety uprawnień wpływają na dostęp użytkowników. Zanim zmienisz lub usuniesz grupę, sprawdź, czy wybrano właściwą grupę i właściwy zakres.
| Argument | Wymagany | Typ lub dopuszczalne wartości |
|---|---|---|
projectId | Nie | ciąg znaków |
scope | Nie | ephemeral, production |
action | Tak | create, update, delete, add-members, remove-members |
entitySlug | Tak | ciąg znaków; minimalna długość 1; maksymalna długość 63 |
group | Tak | ciąg znaków; minimalna długość 1; maksymalna długość 128 |
title | Nie | ciąg znaków; minimalna długość 1; maksymalna długość 256 |
bundles | Nie | tablica obiektów |
profileIds | Nie | tablica ciągów znaków |
confirm | Nie | wartość logiczna |
Operacja: może zmienić stan lub rozpocząć pracę; możliwe są skutki destrukcyjne.
Dostępne konfiguracje: stdio, projekt w chmurze, wnioskowanie w chmurze; stdio, projekt w chmurze, delegowane wnioskowanie; stdio, projekt lokalny, wnioskowanie w chmurze; stdio, projekt lokalny, delegowane wnioskowanie; hostowany HTTP.
Kontrakty narzędzi w formacie do odczytu maszynowego zawierają zagnieżdżone schematy argumentów.