Workspace-Ressource freigeben

Weist einem Benutzer, einer Gruppe oder einem Workspace-API-Schlüssel für Dienstkonten eine Rolle ('admin', 'editor', 'commenter' oder 'viewer') für eine Workspace-Ressource zu. Dadurch wird jede bestehende Rolle des Ziels für die Ressource überschrieben. Um einen Benutzer oder ein Dienstkonto anzugeben, übergeben Sie nur die E-Mail-Adresse des Benutzers; der Benutzer muss sich in Ihrem Workspace befinden. Um eine Gruppe anzugeben, übergeben Sie nur die Gruppen-ID. Um einen Workspace-API-Schlüssel für Dienstkonten anzugeben, übergeben Sie die API-Schlüssel-ID; die Ressource wird mit dem Dienstkonto geteilt, das diesem Schlüssel zugeordnet ist. Sie benötigen Administratorzugriff auf die Ressource, um sie zu teilen.

Pfadparameter

resource_idstringErforderlich
Die ID der Zielressource.

Header

xi-api-keystringOptional

Anfrage

This endpoint expects an object.
roleenumErforderlich

Rolle, die dem Ziel zugewiesen wird: ‘admin’, ‘editor’, ‘commenter’ oder ‘viewer’.

Erlaubte Werte:
resource_typeenumErforderlich
Ressourcentyp der Zielressource.
user_emailstring or nullOptional

Die E-Mail-Adresse des Benutzers oder Dienstkontos.

group_idstring or nullOptional

Die ID der Zielgruppe. Verwenden Sie „default“, um die Basisrolle der Ressource festzulegen. Jedes Workspace-Mitglied erhält diese Rolle, sofern es nicht durch eine direkte Benutzerberechtigung, Gruppenmitgliedschaft oder einen Workspace-API-Schlüssel (Service Account) eine höhere Rolle hat.

workspace_api_key_idstring or nullOptional

Die ID des API-Schlüssels für den Ziel-Workspace (Service Account). Dies ist nicht die API-Schlüsselzeichenfolge selbst, die Sie zur Authentifizierung im Header übergeben, sondern die Schlüssel-ID, die Workspace-Administratoren unter Entwickler → Service Accounts finden.

Antwort

Erfolgreiche Antwort

Fehler

422
Unprocessable Entity Error