Карыстальнікі, дазволы і арганізацыі ў застасунку
На гэтай старонцы
Свядома выбірайце асяроддзе папярэдняга прагляду або вытворчай эксплуатацыі. Сутнасць арганізацыі адпавядае арганізацыі кліента. Яе 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 на хосце.
Машыначытальныя кантракты інструментаў уключаюць схемы ўкладзеных аргументаў.