Method: projects.locations.notebooks.share

Partage un notebook avec d'autres comptes.

Requête HTTP

POST https://discoveryengine.googleapis.com/v1alpha/{name=projects/*/locations/*/notebooks/*}:share

L'URL utilise la syntaxe de transcodage gRPC.

Paramètres de chemin d'accès

Paramètres
name

string

Obligatoire. Nom complet de la ressource Notebook, par exemple projects/{project}/locations/{location}/notebooks/{notebookId}.

Corps de la requête

Le corps de la requête contient des données présentant la structure suivante :

Représentation JSON
{
  "accountAndRoles": [
    {
      object (AccountAndRole)
    }
  ],
  "notifyViaEmail": boolean
}
Champs
accountAndRoles[]

object (AccountAndRole)

Obligatoire. Liste des comptes et des rôles avec lesquels partager le notebook.

notifyViaEmail

boolean

Obligatoire. Indique si les utilisateurs partagés doivent être informés par e-mail.

Corps de la réponse

Si la requête aboutit, le corps de la réponse est vide.

Niveaux d'accès des autorisations

Nécessite l'un des champs d'application OAuth suivants :

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

Pour plus d'informations, consultez la Authentication Overview.

Autorisations IAM

Nécessite les autorisations IAM suivantes sur la ressource name :

  • discoveryengine.notebooks.getIamPolicy
  • discoveryengine.notebooks.setIamPolicy

Pour en savoir plus, consultez la documentation IAM.

AccountAndRole

Informations sur le compte et le rôle.

Représentation JSON
{
  "email": string,
  "role": enum (ProjectRole)
}
Champs
email

string

Obligatoire. Adresse e-mail associée au compte.

role

enum (ProjectRole)

Obligatoire. Le rôle dans le notebook.

ProjectRole

Rôle du projet.

Enums
PROJECT_ROLE_UNKNOWN Rôle inconnu.
PROJECT_ROLE_OWNER L'utilisateur est propriétaire du projet.
PROJECT_ROLE_WRITER L'utilisateur dispose des autorisations d'écriture sur le projet.
PROJECT_ROLE_READER L'utilisateur dispose des autorisations de lecteur sur le projet.
PROJECT_ROLE_NOT_SHARED L'utilisateur n'a pas accès au projet.