> For the complete documentation index, see [llms.txt](https://navixy.com/docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://navixy.com/docs/navixy-repository-api/core-api-reference/actors/users.md).

# 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:**

<details>

<summary>MyProfileUpdateInput</summary>

Input for updating the current user's profile.

| Field  | Type                                      | Description                     |
| ------ | ----------------------------------------- | ------------------------------- |
| `name` | [PersonNameInput](#type-personnameinput)! | The structured name components. |

</details>

<details>

<summary>PersonNameInput</summary>

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. |

</details>

**Output types:**

<details>

<summary>UserPayload</summary>

The result of a user profile mutation.

| Field  | Type                | Description       |
| ------ | ------------------- | ----------------- |
| `user` | [User](#type-user)! | The updated user. |

</details>

<details>

<summary>User (entity)</summary>

A human user account authenticated via an identity provider.

**Implements:** [Actor](/docs/navixy-repository-api/core-api-reference/actors.md#type-actor), [Node](/docs/navixy-repository-api/core-api-reference/common.md#type-node), [Versioned](/docs/navixy-repository-api/core-api-reference/common.md#type-versioned), [Titled](/docs/navixy-repository-api/core-api-reference/common.md#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](/docs/navixy-repository-api/core-api-reference/actors.md#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](/docs/navixy-repository-api/core-api-reference/organizations/members.md#type-memberconnection)! | The organization memberships for this user.                                                                                                                                                               |

</details>

***

### 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:**

<details>

<summary>UserCatalogItemCreateInput</summary>

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](/docs/navixy-repository-api/core-api-reference/catalogs/catalog-items.md#type-catalogitemmetainput) | The display properties.                                                                                      |

</details>

<details>

<summary>CatalogItemMetaInput</summary>

Display properties for catalog items.

| Field         | Type      | Description                                       |
| ------------- | --------- | ------------------------------------------------- |
| `description` | `String`  | The description.                                  |
| `hidden`      | `Boolean` | Whether the item is hidden from regular UI lists. |

</details>

**Output types:**

<details>

<summary>UserCatalogItemPayload</summary>

The result of a user catalog item mutation.

| Field  | Type                                      | Description                               |
| ------ | ----------------------------------------- | ----------------------------------------- |
| `item` | [UserCatalogItem](#type-usercatalogitem)! | The created or updated user catalog item. |

</details>

<details>

<summary>UserCatalogItem (entity)</summary>

A user-defined catalog item that supports hierarchical organization.

**Implements:** [CatalogItem](/docs/navixy-repository-api/core-api-reference/catalogs/catalog-items.md#type-catalogitem), [HierarchicalCatalogItem](/docs/navixy-repository-api/core-api-reference/catalogs/catalog-items.md#type-hierarchicalcatalogitem), [Node](/docs/navixy-repository-api/core-api-reference/common.md#type-node), [Versioned](/docs/navixy-repository-api/core-api-reference/common.md#type-versioned), [Titled](/docs/navixy-repository-api/core-api-reference/common.md#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](/docs/navixy-repository-api/core-api-reference/catalogs/catalog-items.md#type-catalog)!                 | The catalog this item belongs to.                                               |
| `organization` | [Organization](/docs/navixy-repository-api/core-api-reference/organizations.md#type-organization)                 | The organization that owns this item. Null for system items.                    |
| `meta`         | [CatalogItemMeta](/docs/navixy-repository-api/core-api-reference/catalogs/catalog-items.md#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.                                               |

</details>

***

### 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:**

<details>

<summary>UserCatalogItemUpdateInput</summary>

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](/docs/navixy-repository-api/core-api-reference/catalogs/catalog-items.md#type-catalogitemmetainput) | The display properties.                                                                         |

</details>

<details>

<summary>CatalogItemMetaInput</summary>

Display properties for catalog items.

| Field         | Type      | Description                                       |
| ------------- | --------- | ------------------------------------------------- |
| `description` | `String`  | The description.                                  |
| `hidden`      | `Boolean` | Whether the item is hidden from regular UI lists. |

</details>

**Output types:**

<details>

<summary>UserCatalogItemPayload</summary>

The result of a user catalog item mutation.

| Field  | Type                                      | Description                               |
| ------ | ----------------------------------------- | ----------------------------------------- |
| `item` | [UserCatalogItem](#type-usercatalogitem)! | The created or updated user catalog item. |

</details>

<details>

<summary>UserCatalogItem (entity)</summary>

A user-defined catalog item that supports hierarchical organization.

**Implements:** [CatalogItem](/docs/navixy-repository-api/core-api-reference/catalogs/catalog-items.md#type-catalogitem), [HierarchicalCatalogItem](/docs/navixy-repository-api/core-api-reference/catalogs/catalog-items.md#type-hierarchicalcatalogitem), [Node](/docs/navixy-repository-api/core-api-reference/common.md#type-node), [Versioned](/docs/navixy-repository-api/core-api-reference/common.md#type-versioned), [Titled](/docs/navixy-repository-api/core-api-reference/common.md#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](/docs/navixy-repository-api/core-api-reference/catalogs/catalog-items.md#type-catalog)!                 | The catalog this item belongs to.                                               |
| `organization` | [Organization](/docs/navixy-repository-api/core-api-reference/organizations.md#type-organization)                 | The organization that owns this item. Null for system items.                    |
| `meta`         | [CatalogItemMeta](/docs/navixy-repository-api/core-api-reference/catalogs/catalog-items.md#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.                                               |

</details>

***

### 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:**

<details>

<summary>CatalogItemDeleteInput</summary>

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. |

</details>

**Output types:**

<details>

<summary>DeletePayload</summary>

The result of a delete mutation.

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

</details>

***

## Objects

### UserCatalogItem

A user-defined catalog item that supports hierarchical organization.

**Implements:** [CatalogItem](/docs/navixy-repository-api/core-api-reference/catalogs/catalog-items.md#type-catalogitem), [HierarchicalCatalogItem](/docs/navixy-repository-api/core-api-reference/catalogs/catalog-items.md#type-hierarchicalcatalogitem), [Node](/docs/navixy-repository-api/core-api-reference/common.md#type-node), [Versioned](/docs/navixy-repository-api/core-api-reference/common.md#type-versioned), [Titled](/docs/navixy-repository-api/core-api-reference/common.md#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](/docs/navixy-repository-api/core-api-reference/catalogs/catalog-items.md#type-catalog)!                 | The catalog this item belongs to.                                               |
| `organization` | [Organization](/docs/navixy-repository-api/core-api-reference/organizations.md#type-organization)                 | The organization that owns this item. Null for system items.                    |
| `meta`         | [CatalogItemMeta](/docs/navixy-repository-api/core-api-reference/catalogs/catalog-items.md#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](/docs/navixy-repository-api/core-api-reference/actors.md#type-actor), [Node](/docs/navixy-repository-api/core-api-reference/common.md#type-node), [Versioned](/docs/navixy-repository-api/core-api-reference/common.md#type-versioned), [Titled](/docs/navixy-repository-api/core-api-reference/common.md#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](/docs/navixy-repository-api/core-api-reference/actors.md#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](/docs/navixy-repository-api/core-api-reference/organizations/members.md#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](/docs/navixy-repository-api/core-api-reference/catalogs/catalog-items.md#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](/docs/navixy-repository-api/core-api-reference/catalogs/catalog-items.md#type-catalogitemmetainput) | The display properties.                                                                         |

***

## Pagination types

### UserCatalogItemConnection

A paginated list of UserCatalogItem items.

**Implements:** [Connection](/docs/navixy-repository-api/core-api-reference/common.md#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](/docs/navixy-repository-api/core-api-reference/common.md#type-pageinfo)!  | Information about the current page.                        |
| `total`    | [CountInfo](/docs/navixy-repository-api/core-api-reference/common.md#type-countinfo) | The total count of items matching the filter.              |

***

### UserCatalogItemEdge

An edge in the UserCatalogItem connection.

**Implements:** [Edge](/docs/navixy-repository-api/core-api-reference/common.md#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](/docs/navixy-repository-api/core-api-reference/common.md#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](/docs/navixy-repository-api/core-api-reference/common.md#type-pageinfo)!  | Information about the current page.                        |
| `total`    | [CountInfo](/docs/navixy-repository-api/core-api-reference/common.md#type-countinfo) | The total count of items matching the filter.              |

***

### UserEdge

An edge in the User connection.

**Implements:** [Edge](/docs/navixy-repository-api/core-api-reference/common.md#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. |

***


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://navixy.com/docs/navixy-repository-api/core-api-reference/actors/users.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.