Users

Navixy Repository API is a work in progress. This documentation is published for preview purposes only and doesn't reflect a stable release. Structure, field names, and behaviors are subject to change.

User accounts representing human operators who access the system through the UI or API.

Mutations

myProfileUpdate

Updates the current user's profile (name only).

myProfileUpdate(
    input: MyProfileUpdateInput!
  ): UserPayload

Arguments

Name	Type	Description
input	MyProfileUpdateInput!	The input fields for updating the profile.

Input types:

MyProfileUpdateInput

Input for updating the current user's profile.

Field	Type	Description
name	PersonNameInput!	The structured name components.

PersonNameInput

Input for structured person name components.

Field	Type	Description
givenNames	String!	The given name(s).
familyNames	String!	The family name(s).
middleName	String	The middle name or patronymic.

Output types:

UserPayload

The result of a user profile mutation.

Field	Type	Description
user	User!	The updated user.

User (entity)

A human user account authenticated via an identity provider.

Implements: Actor, Node, Versioned, Titled

Field	Type	Description
id	ID!	A globally unique identifier.
version	Int!	The version number for optimistic locking. Incremented on each update. Must be provided in update/delete mutations to prevent lost updates.
title	String!	The display name for the user. This is the user's full name for display purposes.
name	PersonName!	The structured name components from the identity provider.
identityProvider	String!	The identity provider name (keycloak, auth0, okta, etc.).
identityProviderId	String!	The user's unique ID in the identity provider.
email	EmailAddress!	The user's primary email address.
locale	Locale	The user's preferred locale.
externalId	String	An external system identifier for integration purposes.
isActive	Boolean!	Whether this user account is active.
memberships	MemberConnection!	The organization memberships for this user.

---

userCatalogItemCreate

Creates a new user catalog item.

userCatalogItemCreate(
    input: UserCatalogItemCreateInput!
  ): UserCatalogItemPayload

Arguments

Name	Type	Description
input	UserCatalogItemCreateInput!	The input fields for creating the item.

Input types:

UserCatalogItemCreateInput

Input for creating a user catalog item.

Field	Type	Description
organizationId	ID!	The organization that will own the item.
catalogId	ID!	The catalog to add the item to.
code	Code!	The machine-readable code, unique within the catalog and organization.
title	String!	The display name.
order	Int	The display order.
parentId	ID	The parent item ID for hierarchical catalogs.
meta	CatalogItemMetaInput	The display properties.

CatalogItemMetaInput

Display properties for catalog items.

Field	Type	Description
description	String	The description.
hidden	Boolean	Whether the item is hidden from regular UI lists.
textColor	HexColorCode	The text color for UI display.
backgroundColor	HexColorCode	The background color for UI display.
icon	String	A relative URL to the icon.

Output types:

UserCatalogItemPayload

The result of a user catalog item mutation.

Field	Type	Description
item	UserCatalogItem!	The created or updated user catalog item.

UserCatalogItem (entity)

A user-defined catalog item that supports hierarchical organization.

Implements: CatalogItem, HierarchicalCatalogItem, Node, Versioned, Titled

Field	Type	Description
id	ID!	A globally unique identifier.
version	Int!	The version number for optimistic locking.
title	String!	The human-readable display name. Can be localized.
code	Code!	A machine-readable code, unique within the catalog scope.
order	Int!	The display order within the same level or category.
catalog	Catalog!	The catalog this item belongs to.
organization	Organization	The organization that owns this item. Null for system items.
meta	CatalogItemMeta!	Metadata about this item including description, origin, and display properties.
parent	UserCatalogItem	The parent item in the hierarchy. Null for root items.
children	UserCatalogItemConnection!	The child items in the hierarchy.

---

userCatalogItemUpdate

Updates a user catalog item.

userCatalogItemUpdate(
    input: UserCatalogItemUpdateInput!
  ): UserCatalogItemPayload

Arguments

Name	Type	Description
input	UserCatalogItemUpdateInput!	The input fields for updating the item.

Input types:

UserCatalogItemUpdateInput

Input for updating a user catalog item.

Field	Type	Description
id	ID!	The item ID to update.
version	Int!	The current version for optimistic locking.
title	String	The new display name.
order	Int	The new display order.
parentId	ID	The new parent ID for hierarchical items.
meta	CatalogItemMetaInput	The display properties.

CatalogItemMetaInput

Display properties for catalog items.

Field	Type	Description
description	String	The description.
hidden	Boolean	Whether the item is hidden from regular UI lists.
textColor	HexColorCode	The text color for UI display.
backgroundColor	HexColorCode	The background color for UI display.
icon	String	A relative URL to the icon.

Output types:

UserCatalogItemPayload

The result of a user catalog item mutation.

Field	Type	Description
item	UserCatalogItem!	The created or updated user catalog item.

UserCatalogItem (entity)

A user-defined catalog item that supports hierarchical organization.

Implements: CatalogItem, HierarchicalCatalogItem, Node, Versioned, Titled

Field	Type	Description
id	ID!	A globally unique identifier.
version	Int!	The version number for optimistic locking.
title	String!	The human-readable display name. Can be localized.
code	Code!	A machine-readable code, unique within the catalog scope.
order	Int!	The display order within the same level or category.
catalog	Catalog!	The catalog this item belongs to.
organization	Organization	The organization that owns this item. Null for system items.
meta	CatalogItemMeta!	Metadata about this item including description, origin, and display properties.
parent	UserCatalogItem	The parent item in the hierarchy. Null for root items.
children	UserCatalogItemConnection!	The child items in the hierarchy.

---

userCatalogItemDelete

Deletes a user catalog item.

userCatalogItemDelete(
    input: CatalogItemDeleteInput!
  ): DeletePayload

Arguments

Name	Type	Description
input	CatalogItemDeleteInput!	The input fields for deleting the item.

Input types:

CatalogItemDeleteInput

Input for deleting a catalog item.

Field	Type	Description
id	ID!	The catalog item ID to delete.
version	Int!	The current version for optimistic locking.

Output types:

DeletePayload

The result of a delete mutation.

Field	Type	Description
deletedId	ID!	The ID of the deleted entity.

---

Objects

UserCatalogItem

A user-defined catalog item that supports hierarchical organization.

Implements: CatalogItem, HierarchicalCatalogItem, Node, Versioned, Titled

Field	Type	Description
id	ID!	A globally unique identifier.
version	Int!	The version number for optimistic locking.
title	String!	The human-readable display name. Can be localized.
code	Code!	A machine-readable code, unique within the catalog scope.
order	Int!	The display order within the same level or category.
catalog	Catalog!	The catalog this item belongs to.
organization	Organization	The organization that owns this item. Null for system items.
meta	CatalogItemMeta!	Metadata about this item including description, origin, and display properties.
parent	UserCatalogItem	The parent item in the hierarchy. Null for root items.
children	UserCatalogItemConnection!	The child items in the hierarchy.

---

User

A human user account authenticated via an identity provider.

Implements: Actor, Node, Versioned, Titled

Field	Type	Description
id	ID!	A globally unique identifier.
version	Int!	The version number for optimistic locking. Incremented on each update. Must be provided in update/delete mutations to prevent lost updates.
title	String!	The display name for the user. This is the user's full name for display purposes.
name	PersonName!	The structured name components from the identity provider.
identityProvider	String!	The identity provider name (keycloak, auth0, okta, etc.).
identityProviderId	String!	The user's unique ID in the identity provider.
email	EmailAddress!	The user's primary email address.
locale	Locale	The user's preferred locale.
externalId	String	An external system identifier for integration purposes.
isActive	Boolean!	Whether this user account is active.
memberships	MemberConnection!	The organization memberships for this user.

---

UserPayload

The result of a user profile mutation.

Field	Type	Description
user	User!	The updated user.

---

UserCatalogItemPayload

The result of a user catalog item mutation.

Field	Type	Description
item	UserCatalogItem!	The created or updated user catalog item.

---

Inputs

MyProfileUpdateInput

Input for updating the current user's profile.

Field	Type	Description
name	PersonNameInput!	The structured name components.

---

PersonNameInput

Input for structured person name components.

Field	Type	Description
givenNames	String!	The given name(s).
familyNames	String!	The family name(s).
middleName	String	The middle name or patronymic.

---

UserCatalogItemCreateInput

Input for creating a user catalog item.

Field	Type	Description
organizationId	ID!	The organization that will own the item.
catalogId	ID!	The catalog to add the item to.
code	Code!	The machine-readable code, unique within the catalog and organization.
title	String!	The display name.
order	Int	The display order.
parentId	ID	The parent item ID for hierarchical catalogs.
meta	CatalogItemMetaInput	The display properties.

---

UserCatalogItemUpdateInput

Input for updating a user catalog item.

Field	Type	Description
id	ID!	The item ID to update.
version	Int!	The current version for optimistic locking.
title	String	The new display name.
order	Int	The new display order.
parentId	ID	The new parent ID for hierarchical items.
meta	CatalogItemMetaInput	The display properties.

---

Pagination types

UserCatalogItemConnection

A paginated list of UserCatalogItem items.

Implements: Connection

Field	Type	Description
edges	[UserCatalogItemEdge!]!	A list of edges.
nodes	[UserCatalogItem!]!	A list of nodes in the connection (without edge metadata).
pageInfo	PageInfo!	Information about the current page.
total	CountInfo	The total count of items matching the filter.

---

UserCatalogItemEdge

An edge in the UserCatalogItem connection.

Implements: Edge

Field	Type	Description
cursor	String!	An opaque cursor for this edge.
node	UserCatalogItem!	The user catalog item at the end of the edge.

---

UserConnection

A paginated list of User items.

Implements: Connection

Field	Type	Description
edges	[UserEdge!]!	A list of edges.
nodes	[User!]!	A list of nodes in the connection (without edge metadata).
pageInfo	PageInfo!	Information about the current page.
total	CountInfo	The total count of items matching the filter.

---

UserEdge

An edge in the User connection.

Implements: Edge

Field	Type	Description
cursor	String!	An opaque cursor for this edge.
node	User!	The user at the end of the edge.

---