Partager une ressource du Workspace

Attribue un rôle, parmi 'admin', 'editor', 'commenter' ou 'viewer', sur une ressource du Workspace à un utilisateur, un groupe ou une clé API de Workspace associée à un compte de service. Cela remplace tout rôle existant de la cible sur la ressource. Pour cibler un utilisateur ou un compte de service, transmettez uniquement l’email de l’utilisateur, qui doit appartenir à votre Workspace. Pour cibler un groupe, transmettez uniquement l’ID du groupe. Pour cibler une clé API de Workspace associée à un compte de service, transmettez l’ID de la clé API ; la ressource sera partagée avec le compte de service associé à cette clé. Vous devez disposer d’un accès administrateur à la ressource pour la partager.

Paramètres de chemin

resource_idstringRequis

L’ID de la ressource cible.

En-têtes

xi-api-keystringOptionnel

Requête

This endpoint expects an object.
roleenumRequis

Rôle à attribuer à la cible : « admin », « editor », « commenter » ou « viewer ».

Valeurs autorisées:
resource_typeenumRequis
Type de la ressource cible.
user_emailstring or nullOptionnel

L’email de l’utilisateur ou du compte de service.

group_idstring or nullOptionnel

L’ID du groupe cible. Utilisez « default » pour définir le rôle de base de la ressource. Chaque membre du Workspace reçoit ce rôle, sauf s’il dispose d’un rôle supérieur via une attribution directe à l’utilisateur, son appartenance à un groupe ou une clé API de Workspace (compte de service).

workspace_api_key_idstring or nullOptionnel

L’ID de la clé API du Workspace cible (compte de service). Il ne s’agit pas de la chaîne de la clé API elle-même, transmise dans l’en-tête pour l’authentification, mais de l’ID de la clé, que les administrateurs du Workspace peuvent trouver sous Développeurs → Comptes de service.

Réponse

Réponse réussie

Erreurs

422
Unprocessable Entity Error