ContextQMD
Back to Gitlabhq

Assign GitLab Duo seats by using GraphQL

doc/api/graphql/assign_gitlab_duo_seats.md

18.11.21.9 KB
Original Source

{{< details >}}

  • Tier: Premium, Ultimate
  • Offering: GitLab.com, GitLab Self-Managed, GitLab Dedicated

{{< /details >}}

{{< history >}}

{{< /history >}}

Use this API to assign GitLab Duo seats to users.

Prerequisites

  • You must have the Owner role for the group you want to assign seats to.
  • You must have a personal access token with the api scope.

Get the add-on purchase ID

To start, retrieve the purchase ID for the GitLab Duo add-on. For GitLab.com:

graphql
query {
 addOnPurchases (namespaceId: "gid://gitlab/Group/YOUR_NAMESPACE_ID")
 {
  name
  purchasedQuantity
  assignedQuantity
  id
 }
}

For GitLab Self-Managed and GitLab Dedicated:

graphql
query {
 addOnPurchases
 {
  name
  purchasedQuantity
  assignedQuantity
  id
 }
}

Assign a GitLab Duo seat to specific users

Then assign seats to specific users:

graphql
mutation {
  userAddOnAssignmentBulkCreate(input: {
    addOnPurchaseId: "gid://gitlab/GitlabSubscriptions::AddOnPurchase/YOUR_ADDON_PURCHASE_ID",
    userIds: [
      "gid://gitlab/User/USER_ID_1",
      "gid://gitlab/User/USER_ID_2",
      "gid://gitlab/User/USER_ID_3"
    ]
  }) {
    addOnPurchase {
      id
      name
      assignedQuantity
      purchasedQuantity
    }
    users {
      nodes {
        id
        username
        }
      }
    errors
  }
}

Use GraphQL

You can use GraphQL to assign seats to users.

  1. Copy the add-on purchase ID code excerpt.
  2. Open GraphQL.
  3. In the left window, enter the query for getting an add-on purchase ID.
  4. Select Play.
  5. Repeat to assign a GitLab Duo seat to specific users.