invitations

This query allows administrators to understand how users were added to their enterprise. In Shibumi, users are commonly added by inviting them to a work item. When a user is invited, they receive an email that allows them to create a new Shibumi account, and view the work item they were invited to. This query allows access to invitation information, both for users who signed up, and for users who are still pending.

Viewing of invitation information is a user-management function, and this query is therefore restricted to Shibumi enterprise administrators. Other users will receive an error when attempting to run this query.

It is important to keep in mind that not all users are added to an enterprise via an invitation. For example, when a new user signs in through SSO, they are automatically granted access to the enterprise, despite the fact that they never received an explicit invitation. For that reason, there will likely be users in the enterprise that do not appear in this report.

Results are sorted by invitation time, with the most recent invitations returned first.

Query

invitations (Connection to Invitation)
Look up invitations that were sent out and by whom. This query has a maximum page size of 100 items.

Example

{
  invitations(first: 100) {
    nodes {
      invitedAt
      invitedUser {
        name
        lastName
        firstName
      }
      invitingUser {
        name
        lastName
        firstName
      }
    }
  }
}

{
  "data": {
    "invitations": {
      "nodes": [
        {
          "invitedAt": "2019-08-09T16:24:04.848Z",
          "invitedUser": {
            "firstName": "John",
            "lastName": "Watson",
            "name": "John Watson"
          },
          "invitingUser": {
            "firstName": "Sherlock",
            "lastName": "Holmes",
            "name": "Sherlock Holmes"
          }
        },
        {
          "invitedAt": "2019-08-09T16:24:04.848Z",
          "invitedUser": {
            "firstName": "John",
            "lastName": "Watson",
            "name": "John Watson"
          },
          "invitingUser": {
            "firstName": "Sherlock",
            "lastName": "Holmes",
            "name": "Sherlock Holmes"
          }
        },
      ]
    }
  }
}