Skip to content

allUsersOnAccountConnection

No description available.

Arguments

Argument Type Description
first Int Returns the first n elements from the list.
after String Returns the elements in the list that occur after the specified cursor.
last Int Returns the last n elements from the list.
before String Returns the elements in the list that occur before the specified cursor.
sortOrder SortOrder Sorts the order of results.
sortBy UserFieldEnum
emailFilter String
roleIdsFilter [UUID!]
lockoutStateFilter LockoutStateFilter Filter users based on lockout status.
hiddenStateFilter HiddenStateFilter Filter users based on hidden status.
shouldGetLocalUsersOnly (required) Boolean! Get local users only.
userDomainsFilter [UserDomainEnum!] Filter users based on their authentication domain.

Returns

UserConnection!

Sample

query AllUsersOnAccountConnection($shouldGetLocalUsersOnly: Boolean!) {
  allUsersOnAccountConnection(
    shouldGetLocalUsersOnly: $shouldGetLocalUsersOnly
    first: 10
  ) {
    nodes {
      domain
      domainName
      email
      groups
      id
      isAccountOwner
      isEmailEnabled
      isHidden
      lastLogin
      status
      unreadCount
      username
    }
    pageInfo {
      hasNextPage
      endCursor
    }
  }
}

{
  "shouldGetLocalUsersOnly": true
}

{
  "data": {
    "allUsersOnAccountConnection": {
      "nodes": [
        [
          {
            "domain": "CLIENT",
            "domainName": "example-string",
            "email": "example-string",
            "groups": [
              "example-string"
            ],
            "id": "example-string",
            "isAccountOwner": true
          }
        ]
      ],
      "pageInfo": {
        "endCursor": "example-string",
        "hasNextPage": true,
        "hasPreviousPage": true,
        "startCursor": "example-string"
      }
    }
  }
}