API des invitations

{{< details >}}

• Édition : Gratuite, GitLab Premium, GitLab Ultimate
• Offre : GitLab.com, GitLab Self-Managed, GitLab Dedicated

{{< /details >}}

Utilisez cette API pour gérer les invitations et ajouter des utilisateurs à un groupe ou à un projet.

Ajouter un membre à un groupe ou à un projet {#add-a-member-to-a-group-or-project}

Ajoute un nouveau membre. Vous pouvez spécifier un ID utilisateur ou inviter un utilisateur par e-mail.

Prérequis :

• Pour les groupes, vous devez avoir le rôle Propriétaire pour le groupe.
• Pour les projets :
  • Vous devez avoir le rôle Maintainer ou Owner pour le projet.
  • Le verrouillage de l'appartenance au groupe doit être désactivé.
• Pour les instances GitLab Self-Managed :
  • Si les nouveaux comptes utilisateurs ne sont pas autorisés, un administrateur doit ajouter l'utilisateur.
  • Si les invitations d'utilisateurs ne sont pas autorisées, un administrateur doit ajouter l'utilisateur.
  • Si l'approbation de l'administrateur pour les promotions de rôle est activée, un administrateur doit approuver l'invitation.

POST /groups/:id/invitations
POST /projects/:id/invitations

curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/:id/invitations" \
  --data "[email protected]&user_id=1&access_level=30"
curl --request POST \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/:id/invitations" \
  --data "[email protected]&user_id=1&access_level=30"

Exemples de réponses :

Lorsque tous les e-mails ont été envoyés avec succès :

{  "status":  "success"  }

Lorsque des erreurs se sont produites lors de l'envoi de l'e-mail :

{
  "status": "error",
  "message": {
               "[email protected]": "Invite email has already been taken",
               "[email protected]": "User already exists in source",
               "test_username": "Access level is not included in the list"
             }
}

Pour activer Manage non-billable promotions, vous devez d'abord activer le paramètre d'application enable_member_promotion_management.

Exemple de réponse :

{
  "queued_users": {
    "username_1": "Request queued for administrator approval."
  },
  "status": "success"
}

Lister toutes les invitations en attente pour un groupe ou un projet {#list-all-pending-invitations-for-a-group-or-project}

Liste toutes les invitations en attente visibles par l'utilisateur authentifié. Renvoie les invitations aux membres directs uniquement, et non via les groupes d'ancêtres hérités.

Cette fonction utilise les paramètres de pagination page et per_page pour restreindre la liste des membres.

GET /groups/:id/invitations
GET /projects/:id/invitations

curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/:id/[email protected]"
curl --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/:id/[email protected]"

Exemple de réponse :

 [
   {
     "id": 1,
     "invite_email": "[email protected]",
     "created_at": "2020-10-22T14:13:35Z",
     "access_level": 30,
     "expires_at": "2020-11-22T14:13:35Z",
     "user_name": "Raymond Smith",
     "created_by_name": "Administrator"
   },
]

Mettre à jour une invitation à un groupe ou à un projet {#update-an-invitation-to-a-group-or-project}

Met à jour une invitation en attente à un groupe ou à un projet.

PUT /groups/:id/invitations/:email
PUT /projects/:id/invitations/:email

curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/55/invitations/[email protected]?access_level=40"
curl --request PUT \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/55/invitations/[email protected]?access_level=40"

Exemple de réponse :

{
  "expires_at": "2012-10-22T14:13:35Z",
  "access_level": 40,
}

Supprimer une invitation à un groupe ou à un projet {#delete-an-invitation-to-a-group-or-project}

Supprime une invitation en attente à l'adresse e-mail spécifiée.

DELETE /groups/:id/invitations/:email
DELETE /projects/:id/invitations/:email

curl --request DELETE \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/groups/55/invitations/[email protected]"
curl --request DELETE \
  --header "PRIVATE-TOKEN: <your_access_token>" \
  --url "https://gitlab.example.com/api/v4/projects/55/invitations/[email protected]"

• Retourne 204 et aucun contenu en cas de succès.
• Retourne 403 forbidden si non autorisé à supprimer l'invitation.
• Retourne 404 not found si autorisé et qu'aucune invitation n'est trouvée pour cette adresse e-mail.
• Retourne 409 si la requête était valide mais que l'invitation n'a pas pu être supprimée.