Udostępnij zasób obszaru roboczego

Nadaje rolę („admin”, „editor”, „commenter” lub „viewer”) w zasobie obszaru roboczego użytkownikowi, grupie lub kluczowi API obszaru roboczego (konta usługowego). Zastępuje to każdą istniejącą rolę tego podmiotu w zasobie. Aby wskazać użytkownika lub konto usługowe, podaj tylko e-mail użytkownika; użytkownik musi należeć do twojego obszaru roboczego. Aby wskazać grupę, podaj tylko ID grupy. Aby wskazać klucz API obszaru roboczego (konta usługowego), podaj ID klucza API; zasób zostanie udostępniony kontu usługowemu powiązanemu z tym kluczem. Aby udostępnić zasób, musisz mieć do niego dostęp administratora.

Parametry ścieżki

resource_idstringWymagany
ID zasobu docelowego.

Nagłówki

xi-api-keystringOpcjonalny

Żądanie

This endpoint expects an object.
roleenumWymagany

Rola do nadania odbiorcy: „admin”, „editor”, „commenter” lub „viewer”.

Dozwolone wartości:
resource_typeenumWymagany
Typ zasobu docelowego.
user_emailstring or nullOpcjonalny

E-mail użytkownika lub konta usługi.

group_idstring or nullOpcjonalny

ID grupy docelowej. Użyj „default”, aby ustawić podstawową rolę zasobu — każdy członek workspace otrzyma tę rolę, chyba że ma wyższą dzięki bezpośredniemu uprawnieniu użytkownika, członkostwu w grupie lub kluczowi API workspace (konta usługi).

workspace_api_key_idstring or nullOpcjonalny

ID docelowego klucza API workspace (konta usługi). Nie jest to sam ciąg klucza API przekazywany w nagłówku do uwierzytelniania — to ID klucza, które administratorzy workspace znajdą w sekcji Developers → Service Accounts.

Odpowiedź

Pomyślna odpowiedź

Błędy

422
Unprocessable Entity Error