# Users
{% hint style="warning" %}
**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.
{% endhint %}
User accounts representing human operators who access the system through the UI or API.
## Mutations
### myProfileUpdate
Updates the current user's profile (name only).
```graphql
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](#type-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](#type-user)! | The updated user. |
User (entity)
A human user account authenticated via an identity provider.
**Implements:** [Actor](https://www.navixy.com/docs/navixy-repository-api/core-api-reference/actors/..#type-actor), [Node](https://www.navixy.com/docs/navixy-repository-api/common#type-node), [Versioned](https://www.navixy.com/docs/navixy-repository-api/common#type-versioned), [Titled](https://www.navixy.com/docs/navixy-repository-api/common#type-titled)
| Field | Type | Description |
| -------------------- | ------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | `ID!` | A globally unique identifier. |
| `version` | `Int!` | The version number for optimistic locking. Incremented on each update. Can be provided in update/delete mutations to prevent lost updates. If omitted, the update proceeds without stale-read protection. |
| `title` | `String!` | The display name for the user. This is the user's full name for display purposes. |
| `name` | [PersonName](https://www.navixy.com/docs/navixy-repository-api/core-api-reference/actors/..#type-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. |
| `externalId` | `String` | An external system identifier for integration purposes. |
| `isActive` | `Boolean!` | Whether this user account is active. |
| `memberships` | [MemberConnection](https://www.navixy.com/docs/navixy-repository-api/organizations/members#type-memberconnection)! | The organization memberships for this user. |
***
### userCatalogItemCreate
Creates a new user catalog item.
```graphql
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. Auto-generated from title if omitted. |
| `title` | `String!` | The display name. |
| `order` | `Int` | The display order. Auto-calculated as last position if omitted. |
| `parentId` | `ID` | The parent item ID for hierarchical catalogs. |
| `meta` | [CatalogItemMetaInput](https://www.navixy.com/docs/navixy-repository-api/catalogs/catalog-items#type-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. |
**Output types:**
UserCatalogItemPayload
The result of a user catalog item mutation.
| Field | Type | Description |
| ------ | ----------------------------------------- | ----------------------------------------- |
| `item` | [UserCatalogItem](#type-usercatalogitem)! | The created or updated user catalog item. |
UserCatalogItem (entity)
A user-defined catalog item that supports hierarchical organization.
**Implements:** [CatalogItem](https://www.navixy.com/docs/navixy-repository-api/catalogs/catalog-items#type-catalogitem), [HierarchicalCatalogItem](https://www.navixy.com/docs/navixy-repository-api/catalogs/catalog-items#type-hierarchicalcatalogitem), [Node](https://www.navixy.com/docs/navixy-repository-api/common#type-node), [Versioned](https://www.navixy.com/docs/navixy-repository-api/common#type-versioned), [Titled](https://www.navixy.com/docs/navixy-repository-api/common#type-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](https://www.navixy.com/docs/navixy-repository-api/catalogs/catalog-items#type-catalog)! | The catalog this item belongs to. |
| `organization` | [Organization](https://www.navixy.com/docs/navixy-repository-api/organizations#type-organization) | The organization that owns this item. Null for system items. |
| `meta` | [CatalogItemMeta](https://www.navixy.com/docs/navixy-repository-api/catalogs/catalog-items#type-catalogitemmeta)! | Metadata about this item including description, origin, and display properties. |
| `parent` | [UserCatalogItem](#type-usercatalogitem) | The parent item in the hierarchy. Null for root items. |
| `children` | [UserCatalogItemConnection](#type-usercatalogitemconnection)! | The child items in the hierarchy. |
***
### userCatalogItemUpdate
Updates a user catalog item.
```graphql
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. If omitted, auto-increments without conflict check. |
| `title` | `String` | The new display name. |
| `order` | `Int` | The new display order. |
| `parentId` | `ID` | The new parent ID for hierarchical items. |
| `meta` | [CatalogItemMetaInput](https://www.navixy.com/docs/navixy-repository-api/catalogs/catalog-items#type-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. |
**Output types:**
UserCatalogItemPayload
The result of a user catalog item mutation.
| Field | Type | Description |
| ------ | ----------------------------------------- | ----------------------------------------- |
| `item` | [UserCatalogItem](#type-usercatalogitem)! | The created or updated user catalog item. |
UserCatalogItem (entity)
A user-defined catalog item that supports hierarchical organization.
**Implements:** [CatalogItem](https://www.navixy.com/docs/navixy-repository-api/catalogs/catalog-items#type-catalogitem), [HierarchicalCatalogItem](https://www.navixy.com/docs/navixy-repository-api/catalogs/catalog-items#type-hierarchicalcatalogitem), [Node](https://www.navixy.com/docs/navixy-repository-api/common#type-node), [Versioned](https://www.navixy.com/docs/navixy-repository-api/common#type-versioned), [Titled](https://www.navixy.com/docs/navixy-repository-api/common#type-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](https://www.navixy.com/docs/navixy-repository-api/catalogs/catalog-items#type-catalog)! | The catalog this item belongs to. |
| `organization` | [Organization](https://www.navixy.com/docs/navixy-repository-api/organizations#type-organization) | The organization that owns this item. Null for system items. |
| `meta` | [CatalogItemMeta](https://www.navixy.com/docs/navixy-repository-api/catalogs/catalog-items#type-catalogitemmeta)! | Metadata about this item including description, origin, and display properties. |
| `parent` | [UserCatalogItem](#type-usercatalogitem) | The parent item in the hierarchy. Null for root items. |
| `children` | [UserCatalogItemConnection](#type-usercatalogitemconnection)! | The child items in the hierarchy. |
***
### userCatalogItemDelete
Deletes a user catalog item.
```graphql
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. If omitted, auto-increments without conflict check. |
**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](https://www.navixy.com/docs/navixy-repository-api/catalogs/catalog-items#type-catalogitem), [HierarchicalCatalogItem](https://www.navixy.com/docs/navixy-repository-api/catalogs/catalog-items#type-hierarchicalcatalogitem), [Node](https://www.navixy.com/docs/navixy-repository-api/common#type-node), [Versioned](https://www.navixy.com/docs/navixy-repository-api/common#type-versioned), [Titled](https://www.navixy.com/docs/navixy-repository-api/common#type-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](https://www.navixy.com/docs/navixy-repository-api/catalogs/catalog-items#type-catalog)! | The catalog this item belongs to. |
| `organization` | [Organization](https://www.navixy.com/docs/navixy-repository-api/organizations#type-organization) | The organization that owns this item. Null for system items. |
| `meta` | [CatalogItemMeta](https://www.navixy.com/docs/navixy-repository-api/catalogs/catalog-items#type-catalogitemmeta)! | Metadata about this item including description, origin, and display properties. |
| `parent` | [UserCatalogItem](#type-usercatalogitem) | The parent item in the hierarchy. Null for root items. |
| `children` | [UserCatalogItemConnection](#type-usercatalogitemconnection)! | The child items in the hierarchy. |
***
### User
A human user account authenticated via an identity provider.
**Implements:** [Actor](https://www.navixy.com/docs/navixy-repository-api/core-api-reference/actors/..#type-actor), [Node](https://www.navixy.com/docs/navixy-repository-api/common#type-node), [Versioned](https://www.navixy.com/docs/navixy-repository-api/common#type-versioned), [Titled](https://www.navixy.com/docs/navixy-repository-api/common#type-titled)
| Field | Type | Description |
| -------------------- | ------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `id` | `ID!` | A globally unique identifier. |
| `version` | `Int!` | The version number for optimistic locking. Incremented on each update. Can be provided in update/delete mutations to prevent lost updates. If omitted, the update proceeds without stale-read protection. |
| `title` | `String!` | The display name for the user. This is the user's full name for display purposes. |
| `name` | [PersonName](https://www.navixy.com/docs/navixy-repository-api/core-api-reference/actors/..#type-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. |
| `externalId` | `String` | An external system identifier for integration purposes. |
| `isActive` | `Boolean!` | Whether this user account is active. |
| `memberships` | [MemberConnection](https://www.navixy.com/docs/navixy-repository-api/organizations/members#type-memberconnection)! | The organization memberships for this user. |
***
### UserPayload
The result of a user profile mutation.
| Field | Type | Description |
| ------ | ------------------- | ----------------- |
| `user` | [User](#type-user)! | The updated user. |
***
### UserCatalogItemPayload
The result of a user catalog item mutation.
| Field | Type | Description |
| ------ | ----------------------------------------- | ----------------------------------------- |
| `item` | [UserCatalogItem](#type-usercatalogitem)! | The created or updated user catalog item. |
***
## Inputs
### MyProfileUpdateInput
Input for updating the current user's profile.
| Field | Type | Description |
| ------ | ----------------------------------------- | ------------------------------- |
| `name` | [PersonNameInput](#type-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. Auto-generated from title if omitted. |
| `title` | `String!` | The display name. |
| `order` | `Int` | The display order. Auto-calculated as last position if omitted. |
| `parentId` | `ID` | The parent item ID for hierarchical catalogs. |
| `meta` | [CatalogItemMetaInput](https://www.navixy.com/docs/navixy-repository-api/catalogs/catalog-items#type-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. If omitted, auto-increments without conflict check. |
| `title` | `String` | The new display name. |
| `order` | `Int` | The new display order. |
| `parentId` | `ID` | The new parent ID for hierarchical items. |
| `meta` | [CatalogItemMetaInput](https://www.navixy.com/docs/navixy-repository-api/catalogs/catalog-items#type-catalogitemmetainput) | The display properties. |
***
## Pagination types
### UserCatalogItemConnection
A paginated list of UserCatalogItem items.
**Implements:** [Connection](https://www.navixy.com/docs/navixy-repository-api/common#type-connection)
| Field | Type | Description |
| ---------- | ------------------------------------------------------------------------------------ | ---------------------------------------------------------- |
| `edges` | \[[UserCatalogItemEdge](#type-usercatalogitemedge)!]! | A list of edges. |
| `nodes` | \[[UserCatalogItem](#type-usercatalogitem)!]! | A list of nodes in the connection (without edge metadata). |
| `pageInfo` | [PageInfo](https://www.navixy.com/docs/navixy-repository-api/common#type-pageinfo)! | Information about the current page. |
| `total` | [CountInfo](https://www.navixy.com/docs/navixy-repository-api/common#type-countinfo) | The total count of items matching the filter. |
***
### UserCatalogItemEdge
An edge in the UserCatalogItem connection.
**Implements:** [Edge](https://www.navixy.com/docs/navixy-repository-api/common#type-edge)
| Field | Type | Description |
| -------- | ----------------------------------------- | --------------------------------------------- |
| `cursor` | `String!` | An opaque cursor for this edge. |
| `node` | [UserCatalogItem](#type-usercatalogitem)! | The user catalog item at the end of the edge. |
***
### UserConnection
A paginated list of User items.
**Implements:** [Connection](https://www.navixy.com/docs/navixy-repository-api/common#type-connection)
| Field | Type | Description |
| ---------- | ------------------------------------------------------------------------------------ | ---------------------------------------------------------- |
| `edges` | \[[UserEdge](#type-useredge)!]! | A list of edges. |
| `nodes` | \[[User](#type-user)!]! | A list of nodes in the connection (without edge metadata). |
| `pageInfo` | [PageInfo](https://www.navixy.com/docs/navixy-repository-api/common#type-pageinfo)! | Information about the current page. |
| `total` | [CountInfo](https://www.navixy.com/docs/navixy-repository-api/common#type-countinfo) | The total count of items matching the filter. |
***
### UserEdge
An edge in the User connection.
**Implements:** [Edge](https://www.navixy.com/docs/navixy-repository-api/common#type-edge)
| Field | Type | Description |
| -------- | ------------------- | -------------------------------- |
| `cursor` | `String!` | An opaque cursor for this edge. |
| `node` | [User](#type-user)! | The user at the end of the edge. |
***