People & Organization
Last updated
Queries
employee query
Retrieve employee data from the Viio GraphQL API.
employee(id: ID!): Employee
Returns: Employee
Arguments for employee
| Name | Description |
|---|---|
id (ID!) |
employees query
Retrieve employees data from the Viio GraphQL API.
employees(first: Int, after: String, last: Int, before: String, where: EmployeeFilterInput, order: [EmployeeSortInput!]): EmployeesConnection
Returns: EmployeesConnection
Arguments for employees
| Name | Description |
|---|---|
where (EmployeeFilterInput) | |
order ([EmployeeSortInput!]) | |
first (Int) | Returns the first n elements from the list. |
after (String) | Returns elements after the specified cursor. |
last (Int) | Returns the last n elements from the list. |
before (String) | Returns elements before the specified cursor. |
departmentsSearch query
Retrieve departmentsSearch data from the Viio GraphQL API.
departmentsSearch(skip: Int, take: Int, search: String!): DepartmentsSearchCollectionSegment
Returns: DepartmentsSearchCollectionSegment
Arguments for departmentsSearch
| Name | Description |
|---|---|
skip (Int) | |
take (Int) | |
search (String!) |
departmentsHierarchy query
Retrieve departmentsHierarchy data from the Viio GraphQL API.
departmentsHierarchy(skip: Int, take: Int, rootPath: [String!]): DepartmentsHierarchyCollectionSegment
Returns: DepartmentsHierarchyCollectionSegment
Arguments for departmentsHierarchy
| Name | Description |
|---|---|
skip (Int) | |
take (Int) | |
rootPath ([String!]) |
departmentExclusions query
Retrieve departmentExclusions data from the Viio GraphQL API.
departmentExclusions(skip: Int, take: Int): DepartmentExclusionsCollectionSegment
Returns: DepartmentExclusionsCollectionSegment
Arguments for departmentExclusions
| Name | Description |
|---|---|
skip (Int) | |
take (Int) |
organizationCountries query
Retrieve organizationCountries data from the Viio GraphQL API.
organizationCountries(where: OrganizationAttributeFilterInput, first: Int, after: String, last: Int, before: String): OrganizationAttributeConnection
Returns: OrganizationAttributeConnection
Arguments for organizationCountries
| Name | Description |
|---|---|
where (OrganizationAttributeFilterInput) | |
first (Int) | Returns the first n elements from the list. |
after (String) | Returns elements after the specified cursor. |
last (Int) | Returns the last n elements from the list. |
before (String) | Returns elements before the specified cursor. |
organizationDivisions query
Retrieve organizationDivisions data from the Viio GraphQL API.
organizationDivisions(where: OrganizationAttributeFilterInput, first: Int, after: String, last: Int, before: String): OrganizationAttributeConnection
Returns: OrganizationAttributeConnection
Arguments for organizationDivisions
| Name | Description |
|---|---|
where (OrganizationAttributeFilterInput) | |
first (Int) | Returns the first n elements from the list. |
after (String) | Returns elements after the specified cursor. |
last (Int) | Returns the last n elements from the list. |
before (String) | Returns elements before the specified cursor. |
organizationCostCenters query
Retrieve organizationCostCenters data from the Viio GraphQL API.
organizationCostCenters(where: OrganizationAttributeFilterInput, first: Int, after: String, last: Int, before: String): OrganizationAttributeConnection
Returns: OrganizationAttributeConnection
Arguments for organizationCostCenters
| Name | Description |
|---|---|
where (OrganizationAttributeFilterInput) | |
first (Int) | Returns the first n elements from the list. |
after (String) | Returns elements after the specified cursor. |
last (Int) | Returns the last n elements from the list. |
before (String) | Returns elements before the specified cursor. |
organizationUserTypes query
Retrieve organizationUserTypes data from the Viio GraphQL API.
organizationUserTypes(where: OrganizationAttributeFilterInput, first: Int, after: String, last: Int, before: String): OrganizationAttributeConnection
Returns: OrganizationAttributeConnection
Arguments for organizationUserTypes
| Name | Description |
|---|---|
where (OrganizationAttributeFilterInput) | |
first (Int) | Returns the first n elements from the list. |
after (String) | Returns elements after the specified cursor. |
last (Int) | Returns the last n elements from the list. |
before (String) | Returns elements before the specified cursor. |
Mutations
updateEmployeesAnalysisStatus mutation
Run the updateEmployeesAnalysisStatus mutation through the Viio GraphQL API.
updateEmployeesAnalysisStatus(input: UpdateEmployeesAnalysisStatusInput!, where: EmployeeFilterInput): UpdateEmployeesAnalysisStatusPayload!
Returns: UpdateEmployeesAnalysisStatusPayload!
Arguments for updateEmployeesAnalysisStatus
| Name | Description |
|---|---|
input (UpdateEmployeesAnalysisStatusInput!) | |
where (EmployeeFilterInput) |
updateGroupsAnalysisStatus mutation
Run the updateGroupsAnalysisStatus mutation through the Viio GraphQL API.
updateGroupsAnalysisStatus(input: UpdateGroupsAnalysisStatusInput!, where: GroupFilterInput): UpdateGroupsAnalysisStatusPayload!
Returns: UpdateGroupsAnalysisStatusPayload!
Arguments for updateGroupsAnalysisStatus
| Name | Description |
|---|---|
input (UpdateGroupsAnalysisStatusInput!) | |
where (GroupFilterInput) |
includeDepartmentPathToAnalysis mutation
Run the includeDepartmentPathToAnalysis mutation through the Viio GraphQL API.
includeDepartmentPathToAnalysis(input: IncludeDepartmentPathToAnalysisInput!): IncludeDepartmentPathToAnalysisPayload!
Returns: IncludeDepartmentPathToAnalysisPayload!
Arguments for includeDepartmentPathToAnalysis
| Name | Description |
|---|---|
input (IncludeDepartmentPathToAnalysisInput!) |
excludeDepartmentPathFromAnalysis mutation
Run the excludeDepartmentPathFromAnalysis mutation through the Viio GraphQL API.
excludeDepartmentPathFromAnalysis(input: ExcludeDepartmentPathFromAnalysisInput!): ExcludeDepartmentPathFromAnalysisPayload!
Returns: ExcludeDepartmentPathFromAnalysisPayload!
Arguments for excludeDepartmentPathFromAnalysis
| Name | Description |
|---|---|
input (ExcludeDepartmentPathFromAnalysisInput!) |
Objects
AncestorAlreadyExcludedError object
Fields returned by the AncestorAlreadyExcludedError object type.
| Name | Description |
|---|---|
ancestorPath ([String!]!) | |
message (String!) |
BrowserExtensionInstallation object
Fields returned by the BrowserExtensionInstallation object type.
| Name | Description |
|---|---|
installed (Boolean!) | |
installationDate (DateTime) | |
firstUsed (DateTime) | |
lastUsed (DateTime) |
CollectionSegmentInfo object
Information about the offset pagination.
| Name | Description |
|---|---|
hasNextPage (Boolean!) | Indicates whether more items exist following the set defined by the clients arguments. |
hasPreviousPage (Boolean!) | Indicates whether more items exist prior the set defined by the clients arguments. |
DepartmentExclusionNode object
Fields returned by the DepartmentExclusionNode object type.
| Name | Description |
|---|---|
path ([String!]!) | |
name (String!) |
DepartmentExclusionsCollectionSegment object
A segment of a collection.
| Name | Description |
|---|---|
pageInfo (CollectionSegmentInfo!) | Information to aid in pagination. |
items ([DepartmentExclusionNode!]) | A flattened list of the items. |
DepartmentNode object
Fields returned by the DepartmentNode object type.
| Name | Description |
|---|---|
path ([String!]!) | |
name (String!) | |
employeesCount (Int!) | |
childrenCount (Int!) | |
hasChildren (Boolean!) | |
analysisStatus (DepartmentAnalysisStatus!) | |
children ([DepartmentNode!]!) |
DepartmentSearchResult object
Fields returned by the DepartmentSearchResult object type.
| Name | Description |
|---|---|
path ([String!]!) | |
name (String!) | |
employeesCount (Int!) | |
analysisStatus (DepartmentAnalysisStatus!) |
DepartmentsHierarchyCollectionSegment object
A segment of a collection.
| Name | Description |
|---|---|
pageInfo (CollectionSegmentInfo!) | Information to aid in pagination. |
items ([DepartmentNode!]) | A flattened list of the items. |
totalCount (Int!) |
DepartmentsSearchCollectionSegment object
A segment of a collection.
| Name | Description |
|---|---|
pageInfo (CollectionSegmentInfo!) | Information to aid in pagination. |
items ([DepartmentSearchResult!]) | A flattened list of the items. |
DesktopAgentInstallation object
Fields returned by the DesktopAgentInstallation object type.
| Name | Description |
|---|---|
operatingSystem (DesktopAgentOperatingSystem) | |
installed (Boolean!) | |
installationDate (DateTime) | |
firstUsed (DateTime) | |
lastUsed (DateTime) |
DirectReportsConnection object
A connection to a list of items.
| Name | Description |
|---|---|
pageInfo (PageInfo!) | Information to aid in pagination. |
edges ([DirectReportsEdge!]) | A list of edges. |
nodes ([Employee!]) | A flattened list of the nodes. |
totalCount (Int!) | Identifies the total count of items in the connection. |
DirectReportsEdge object
An edge in a connection.
| Name | Description |
|---|---|
cursor (String!) | A cursor for use in pagination. |
node (Employee!) | The item at the end of the edge. |
Employee object
Fields returned by the Employee object type.
| Name | Description |
|---|---|
id (ID!) | |
userType (String) | |
status (EmployeeStatus!) | |
name (String!) | |
firstName (String) | |
lastName (String) | |
avatar (String) | |
email (String) | |
emailAliases ([String!]!) | |
jobTitle (String) | |
sourceId (String!) | |
source (String!) | |
orgUnit (String!) | |
excludeFromFetch (Boolean!) | |
creationTime (DateTime) | |
deletionTime (DateTime) | UTC timestamp for when the employee was detected as deleted from the connected directory source. This may be the deletion time reported by the source, or the time Viio detected the deletion during sync — so treat it as when the deletion became known, not necessarily the exact moment it occurred. Null while the employee is still present. |
installations (EmployeeInstallations!) | |
groupIds ([ID!]!) | |
country (String) | |
division (String) | |
costCenter (String) | |
departmentPath ([String!]!) | |
managerId (ID) | |
directReports (DirectReportsConnection) | |
groups ([Group!]!) | |
manager (Employee) | |
licenses (LicensesConnection) | |
products (ProductUsersConnection) | |
applicationsUsage (ApplicationsUsageConnection) |
EmployeeInstallations object
Fields returned by the EmployeeInstallations object type.
| Name | Description |
|---|---|
browserExtension (BrowserExtensionInstallation!) | |
desktopAgent (DesktopAgentInstallation!) |
EmployeesConnection object
A connection to a list of items.
| Name | Description |
|---|---|
pageInfo (PageInfo!) | Information to aid in pagination. |
edges ([EmployeesEdge!]) | A list of edges. |
nodes ([Employee!]) | A flattened list of the nodes. |
totalCount (Int!) | Identifies the total count of items in the connection. |
EmployeesEdge object
An edge in a connection.
| Name | Description |
|---|---|
cursor (String!) | A cursor for use in pagination. |
node (Employee!) | The item at the end of the edge. |
ExcludeDepartmentPathFromAnalysisPayload object
Fields returned by the ExcludeDepartmentPathFromAnalysisPayload object type.
| Name | Description |
|---|---|
updatedCount (Int) | |
errors ([ExcludeDepartmentPathFromAnalysisError!]) |
FailedToExecuteUpdateAnalysisStatusError object
Fields returned by the FailedToExecuteUpdateAnalysisStatusError object type.
| Name | Description |
|---|---|
message (String!) |
Group object
Fields returned by the Group object type.
| Name | Description |
|---|---|
id (ID!) | |
name (String!) | |
description (String) | |
groupIds ([ID!]!) | |
excludeFromFetch (Boolean!) | |
groups ([Group!]!) | |
nestedGroups ([Group!]!) | |
employees (EmployeesConnection) |
IncludeDepartmentPathToAnalysisPayload object
Fields returned by the IncludeDepartmentPathToAnalysisPayload object type.
| Name | Description |
|---|---|
updatedCount (Int) | |
errors ([IncludeDepartmentPathToAnalysisError!]) |
OrganizationAttributeConnection object
A connection to a list of items.
| Name | Description |
|---|---|
pageInfo (PageInfo!) | Information to aid in pagination. |
edges ([OrganizationAttributeEdge!]) | A list of edges. |
nodes ([String!]) | A flattened list of the nodes. |
totalCount (Int!) | Identifies the total count of items in the connection. |
OrganizationAttributeEdge object
An edge in a connection.
| Name | Description |
|---|---|
cursor (String!) | A cursor for use in pagination. |
node (String!) | The item at the end of the edge. |
UpdateEmployeesAnalysisStatusPayload object
Fields returned by the UpdateEmployeesAnalysisStatusPayload object type.
| Name | Description |
|---|---|
updatedCount (Int) | |
errors ([UpdateAnalysisStatusError!]) |
UpdateGroupsAnalysisStatusPayload object
Fields returned by the UpdateGroupsAnalysisStatusPayload object type.
| Name | Description |
|---|---|
updatedCount (Int) | |
errors ([UpdateAnalysisStatusError!]) |
Input Types
BrowserExtensionInstallationFilterInput input
Input fields accepted by BrowserExtensionInstallationFilterInput.
| Name | Description |
|---|---|
and ([BrowserExtensionInstallationFilterInput!]) | |
or ([BrowserExtensionInstallationFilterInput!]) | |
installed (BooleanOperationFilterInput) | |
installationDate (DateTimeOperationFilterInput) | |
firstUsed (DateTimeOperationFilterInput) | |
lastUsed (DateTimeOperationFilterInput) |
BrowserExtensionInstallationSortInput input
Input fields accepted by BrowserExtensionInstallationSortInput.
| Name | Description |
|---|---|
installed (SortEnumType) | |
installationDate (SortEnumType) | |
firstUsed (SortEnumType) | |
lastUsed (SortEnumType) |
DesktopAgentInstallationFilterInput input
Input fields accepted by DesktopAgentInstallationFilterInput.
| Name | Description |
|---|---|
and ([DesktopAgentInstallationFilterInput!]) | |
or ([DesktopAgentInstallationFilterInput!]) | |
operatingSystem (NullableOfDesktopAgentOperatingSystemOperationFilterInput) | |
installed (BooleanOperationFilterInput) | |
installationDate (DateTimeOperationFilterInput) | |
firstUsed (DateTimeOperationFilterInput) | |
lastUsed (DateTimeOperationFilterInput) |
DesktopAgentInstallationSortInput input
Input fields accepted by DesktopAgentInstallationSortInput.
| Name | Description |
|---|---|
operatingSystem (SortEnumType) | |
installed (SortEnumType) | |
installationDate (SortEnumType) | |
firstUsed (SortEnumType) | |
lastUsed (SortEnumType) |
EmployeeFilterInput input
Input fields accepted by EmployeeFilterInput.
| Name | Description |
|---|---|
and ([EmployeeFilterInput!]) | |
or ([EmployeeFilterInput!]) | |
id (ComparableIdTypeOperationFilterInput) | |
managerId (ComparableIdTypeOperationFilterInput) | |
userType (StringOperationFilterInput) | |
status (EmployeeStatusOperationFilterInput) | |
name (StringOperationFilterInput) | |
sourceId (StringOperationFilterInput) | |
source (StringOperationFilterInput) | |
orgUnit (StringOperationFilterInput) | |
excludeFromFetch (BooleanOperationFilterInput) | |
creationTime (DateTimeOperationFilterInput) | |
deletionTime (DateTimeOperationFilterInput) | |
installations (EmployeeInstallationsFilterInput) | |
groupIds (ListComparableIdTypeOperationFilterInput) | |
country (StringOperationFilterInput) | |
division (StringOperationFilterInput) | |
costCenter (StringOperationFilterInput) | |
departmentPath (StringListFilterInput) |
EmployeeInstallationsFilterInput input
Input fields accepted by EmployeeInstallationsFilterInput.
| Name | Description |
|---|---|
and ([EmployeeInstallationsFilterInput!]) | |
or ([EmployeeInstallationsFilterInput!]) | |
browserExtension (BrowserExtensionInstallationFilterInput) | |
desktopAgent (DesktopAgentInstallationFilterInput) |
EmployeeInstallationsSortInput input
Input fields accepted by EmployeeInstallationsSortInput.
| Name | Description |
|---|---|
browserExtension (BrowserExtensionInstallationSortInput) | |
desktopAgent (DesktopAgentInstallationSortInput) |
EmployeeSortInput input
Input fields accepted by EmployeeSortInput.
| Name | Description |
|---|---|
id (SortEnumType) | |
userType (SortEnumType) | |
status (SortEnumType) | |
name (SortEnumType) | |
sourceId (SortEnumType) | |
source (SortEnumType) | |
orgUnit (SortEnumType) | |
excludeFromFetch (SortEnumType) | |
creationTime (SortEnumType) | |
deletionTime (SortEnumType) | |
installations (EmployeeInstallationsSortInput) |
EmployeeStatusOperationFilterInput input
Input fields accepted by EmployeeStatusOperationFilterInput.
| Name | Description |
|---|---|
eq (EmployeeStatus) | |
neq (EmployeeStatus) | |
in ([EmployeeStatus!]) | |
nin ([EmployeeStatus!]) |
ExcludeDepartmentPathFromAnalysisInput input
Input fields accepted by ExcludeDepartmentPathFromAnalysisInput.
| Name | Description |
|---|---|
departmentPath ([String!]!) |
GroupFilterInput input
Input fields accepted by GroupFilterInput.
| Name | Description |
|---|---|
and ([GroupFilterInput!]) | |
or ([GroupFilterInput!]) | |
id (ComparableIdTypeOperationFilterInput) | |
name (StringOperationFilterInput) | |
description (StringOperationFilterInput) | |
groupIds (ListComparableIdTypeOperationFilterInput) | |
excludeFromFetch (BooleanOperationFilterInput) |
IncludeDepartmentPathToAnalysisInput input
Input fields accepted by IncludeDepartmentPathToAnalysisInput.
| Name | Description |
|---|---|
departmentPath ([String!]!) |
ListComparableIdTypeOperationFilterInput input
Input fields accepted by ListComparableIdTypeOperationFilterInput.
| Name | Description |
|---|---|
all (ComparableIdTypeOperationFilterInput) | |
none (ComparableIdTypeOperationFilterInput) | |
some (ComparableIdTypeOperationFilterInput) | |
any (Boolean) |
NullableOfDesktopAgentOperatingSystemOperationFilterInput input
Input fields accepted by NullableOfDesktopAgentOperatingSystemOperationFilterInput.
| Name | Description |
|---|---|
eq (DesktopAgentOperatingSystem) | |
neq (DesktopAgentOperatingSystem) | |
in ([DesktopAgentOperatingSystem]) | |
nin ([DesktopAgentOperatingSystem]) |
OrganizationAttributeFilterInput input
Input fields accepted by OrganizationAttributeFilterInput.
| Name | Description |
|---|---|
contains (String) |
UpdateEmployeesAnalysisStatusInput input
Input fields accepted by UpdateEmployeesAnalysisStatusInput.
| Name | Description |
|---|---|
analysisStatus (AnalysisStatus!) |
UpdateGroupsAnalysisStatusInput input
Input fields accepted by UpdateGroupsAnalysisStatusInput.
| Name | Description |
|---|---|
analysisStatus (AnalysisStatus!) |
Unions
ExcludeDepartmentPathFromAnalysisError union
Possible object types returned by the ExcludeDepartmentPathFromAnalysisError union.
Possible types: AncestorAlreadyExcludedError
IncludeDepartmentPathToAnalysisError union
Possible object types returned by the IncludeDepartmentPathToAnalysisError union.
Possible types: AncestorAlreadyExcludedError
UpdateAnalysisStatusError union
Possible object types returned by the UpdateAnalysisStatusError union.
Possible types: FailedToExecuteUpdateAnalysisStatusError
Enums
AnalysisStatus enum
Accepted values for the AnalysisStatus enum.
| Value | Description |
|---|---|
INCLUDE | |
EXCLUDE |
DepartmentAnalysisStatus enum
Accepted values for the DepartmentAnalysisStatus enum.
| Value | Description |
|---|---|
INCLUDE | |
EXCLUDE | |
PARTIALLY_EXCLUDED |
DesktopAgentOperatingSystem enum
Accepted values for the DesktopAgentOperatingSystem enum.
| Value | Description |
|---|---|
WINDOWS | |
MAC_OS |
EmployeeStatus enum
Accepted values for the EmployeeStatus enum.
| Value | Description |
|---|---|
ACTIVE | |
SUSPENDED | |
DELETED | |
INVALID |