# Types {% 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 %} ## Objects ### Role A role that can be assigned to actors to grant permissions. **Implements:** [CatalogItem](/docs/navixy-repository-api/core-api-reference/catalogs/catalog-items.md#type-catalogitem), [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. | | `permissions` | [RolePermissionConnection](#type-rolepermissionconnection)! | The permissions assigned to this role. | *** ### PermissionScope A definition of a permission scope that can be granted to roles. **Implements:** [CatalogItem](/docs/navixy-repository-api/core-api-reference/catalogs/catalog-items.md#type-catalogitem), [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. | | `module` | [Module](/docs/navixy-repository-api/core-api-reference/catalogs/system.md#type-module)! | The module this permission scope belongs to. | | `entityType` | [EntityType](/docs/navixy-repository-api/core-api-reference/catalogs/system.md#type-entitytype)! | The entity type this permission applies to. | *** ### ActorRole An assignment of a role to an actor. **Implements:** [Node](/docs/navixy-repository-api/core-api-reference/common.md#type-node) | Field | Type | Description | | ------------ | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | | `id` | `ID!` | A globally unique identifier. This ID is opaque and should not be parsed by clients. | | `actor` | [Actor](/docs/navixy-repository-api/core-api-reference/actors.md#type-actor)! | The actor receiving the role. | | `role` | [Role](#type-role)! | The role being assigned. | | `assignedAt` | `DateTime!` | The date and time when the role was assigned. | | `assignedBy` | [Actor](/docs/navixy-repository-api/core-api-reference/actors.md#type-actor) | The actor who assigned the role. | | `expireDate` | `DateTime` | The date and time when the role expires. Null means the role is permanent. | *** ### RolePermission A permission granted to a role. **Implements:** [Node](/docs/navixy-repository-api/core-api-reference/common.md#type-node) | Field | Type | Description | | ----------------- | ----------------------------------------------------------------------------- | --------------------------------------------------------------------------------------- | | `id` | `ID!` | A globally unique identifier. This ID is opaque and should not be parsed by clients. | | `role` | [Role](#type-role)! | The role receiving the permission. | | `permissionScope` | [PermissionScope](#type-permissionscope)! | The permission scope being granted. | | `targetEntityId` | `ID` | The specific entity ID this permission applies to. Null means all entities of the type. | | `actions` | \[[ActionPermission](#type-actionpermission)!]! | The actions allowed by this permission. | | `grantedAt` | `DateTime!` | The date and time when the permission was granted. | | `grantedBy` | [Actor](/docs/navixy-repository-api/core-api-reference/actors.md#type-actor)! | The actor who granted the permission. | *** ### UserScope A whitelist filter that restricts an actor's access to specific entities. When present, effective permissions = role permissions ∩ user scope. **Implements:** [Node](/docs/navixy-repository-api/core-api-reference/common.md#type-node) | Field | Type | Description | | ----------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | | `id` | `ID!` | A globally unique identifier. This ID is opaque and should not be parsed by clients. | | `actor` | [Actor](/docs/navixy-repository-api/core-api-reference/actors.md#type-actor)! | The actor being restricted. | | `permissionScope` | [PermissionScope](#type-permissionscope)! | The permission scope being filtered. | | `targetEntityId` | `ID!` | The specific entity the actor can access. | | `actions` | \[[ActionPermission](#type-actionpermission)!]! | The actions allowed on this specific entity. | *** ### ActorRolePayload The result of a role assignment mutation. | Field | Type | Description | | ----------- | ----------------------------- | ---------------------------- | | `actorRole` | [ActorRole](#type-actorrole)! | The created role assignment. | *** ### RolePermissionPayload The result of a permission grant mutation. | Field | Type | Description | | ---------------- | --------------------------------------- | ----------------------- | | `rolePermission` | [RolePermission](#type-rolepermission)! | The created permission. | *** ### UserScopePayload The result of a user scope mutation. | Field | Type | Description | | ----------- | ----------------------------- | ----------------------------------- | | `userScope` | [UserScope](#type-userscope)! | The created user scope restriction. | *** ### RolePayload The result of a role mutation. | Field | Type | Description | | ------ | ------------------- | ---------------------------- | | `role` | [Role](#type-role)! | The created or updated role. | *** ## Inputs ### ActorRoleFilter Filtering options for actor roles. | Field | Type | Description | | ---------------- | --------- | ----------------------------------- | | `actorIds` | `[ID!]` | Filter by actors (OR within field). | | `roleIds` | `[ID!]` | Filter by roles (OR within field). | | `includeExpired` | `Boolean` | Include expired role assignments. | *** ### ActorRoleOrder Ordering options for actor roles. | Field | Type | Description | | ----------- | ----------------------------------------------------------------------------------------------- | ----------------------- | | `field` | [ActorRoleOrderField](#type-actorroleorderfield)! | The field to order by. | | `direction` | [OrderDirection](/docs/navixy-repository-api/core-api-reference/common.md#type-orderdirection)! | The direction to order. | *** ### RolePermissionFilter Filtering options for role permissions. | Field | Type | Description | | -------------------- | ------- | ---------------------------------------------- | | `roleIds` | `[ID!]` | Filter by roles (OR within field). | | `permissionScopeIds` | `[ID!]` | Filter by permission scopes (OR within field). | | `targetEntityIds` | `[ID!]` | Filter by target entities (OR within field). | *** ### RolePermissionOrder Ordering options for role permissions. | Field | Type | Description | | ----------- | ----------------------------------------------------------------------------------------------- | ----------------------- | | `field` | [RolePermissionOrderField](#type-rolepermissionorderfield)! | The field to order by. | | `direction` | [OrderDirection](/docs/navixy-repository-api/core-api-reference/common.md#type-orderdirection)! | The direction to order. | *** ### UserScopeFilter Filtering options for user scopes. | Field | Type | Description | | -------------------- | ------- | ---------------------------------------------- | | `actorIds` | `[ID!]` | Filter by actors (OR within field). | | `permissionScopeIds` | `[ID!]` | Filter by permission scopes (OR within field). | | `targetEntityIds` | `[ID!]` | Filter by target entities (OR within field). | *** ### UserScopeOrder Ordering options for user scopes. | Field | Type | Description | | ----------- | ----------------------------------------------------------------------------------------------- | ----------------------- | | `field` | [UserScopeOrderField](#type-userscopeorderfield)! | The field to order by. | | `direction` | [OrderDirection](/docs/navixy-repository-api/core-api-reference/common.md#type-orderdirection)! | The direction to order. | *** ### RoleAssignInput Input for assigning a role to an actor. | Field | Type | Description | | ------------ | ---------- | ------------------------------------------------------ | | `actorId` | `ID!` | The actor ID (user or integration). | | `roleId` | `ID!` | The role ID to assign. | | `expireDate` | `DateTime` | The expiration date. Null means the role is permanent. | *** ### RoleRevokeInput Input for revoking a role from an actor. | Field | Type | Description | | ------------- | ----- | --------------------------------------- | | `actorRoleId` | `ID!` | The actor role assignment ID to revoke. | *** ### PermissionGrantInput Input for granting a permission to a role. | Field | Type | Description | | ------------------- | ----------------------------------------------- | ------------------------------------------------------------ | | `roleId` | `ID!` | The role ID. | | `permissionScopeId` | `ID!` | The permission scope ID. | | `targetEntityId` | `ID` | The specific entity ID. Null means all entities of the type. | | `actions` | \[[ActionPermission](#type-actionpermission)!]! | The actions to allow. | *** ### PermissionRevokeInput Input for revoking a permission from a role. | Field | Type | Description | | -------------- | ----- | --------------------------------- | | `permissionId` | `ID!` | The role permission ID to revoke. | *** ### UserScopeSetInput Input for setting a user scope restriction. | Field | Type | Description | | ------------------- | ----------------------------------------------- | ------------------------------------------ | | `actorId` | `ID!` | The actor ID to restrict. | | `permissionScopeId` | `ID!` | The permission scope ID. | | `targetEntityId` | `ID!` | The specific entity ID to allow access to. | | `actions` | \[[ActionPermission](#type-actionpermission)!]! | The actions to allow. | *** ### UserScopeRemoveInput Input for removing a user scope restriction. | Field | Type | Description | | ------------- | ----- | ---------------------------- | | `userScopeId` | `ID!` | The user scope ID to remove. | *** ### RoleCreateInput Input for creating a role. | Field | Type | Description | | ---------------- | -------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------- | | `organizationId` | `ID!` | The organization that will own the item. | | `code` | `Code` | The machine-readable code. Auto-generated from title if omitted. | | `title` | `String!` | The display name. | | `order` | `Int` | The display order. Auto-calculated as last position if omitted. | | `meta` | [CatalogItemMetaInput](/docs/navixy-repository-api/core-api-reference/catalogs/catalog-items.md#type-catalogitemmetainput) | The display properties. | *** ### RoleUpdateInput Input for updating a role. | 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. | | `meta` | [CatalogItemMetaInput](/docs/navixy-repository-api/core-api-reference/catalogs/catalog-items.md#type-catalogitemmetainput) | The display properties. | *** ## Enums ### ActionPermission Permission actions that can be granted to actors for entity operations. | Value | Description | | -------- | ------------------------------------------- | | `READ` | Permission to view entities and their data. | | `CREATE` | Permission to create new entities. | | `UPDATE` | Permission to modify existing entities. | | `DELETE` | Permission to delete entities. | *** ### ActorRoleOrderField Fields available for ordering actor roles. | Value | Description | | ------------- | ------------------------- | | `ASSIGNED_AT` | Order by assignment date. | *** ### RolePermissionOrderField Fields available for ordering role permissions. | Value | Description | | ------------ | -------------------- | | `GRANTED_AT` | Order by grant date. | *** ### UserScopeOrderField Fields available for ordering user scopes. | Value | Description | | ----- | ------------ | | `ID` | Order by ID. | *** ## Pagination types ### RoleConnection A paginated list of Role items. **Implements:** [Connection](/docs/navixy-repository-api/core-api-reference/common.md#type-connection) | Field | Type | Description | | ---------- | ------------------------------------------------------------------------------------ | ---------------------------------------------------------- | | `edges` | \[[RoleEdge](#type-roleedge)!]! | A list of edges. | | `nodes` | \[[Role](#type-role)!]! | 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. | *** ### RoleEdge An edge in the Role 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` | [Role](#type-role)! | The role at the end of the edge. | *** ### ActorRoleConnection A paginated list of ActorRole items. **Implements:** [Connection](/docs/navixy-repository-api/core-api-reference/common.md#type-connection) | Field | Type | Description | | ---------- | ------------------------------------------------------------------------------------ | ---------------------------------------------------------- | | `edges` | \[[ActorRoleEdge](#type-actorroleedge)!]! | A list of edges. | | `nodes` | \[[ActorRole](#type-actorrole)!]! | 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. | *** ### ActorRoleEdge An edge in the ActorRole 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` | [ActorRole](#type-actorrole)! | The actor role at the end of the edge. | *** ### RolePermissionConnection A paginated list of RolePermission items. **Implements:** [Connection](/docs/navixy-repository-api/core-api-reference/common.md#type-connection) | Field | Type | Description | | ---------- | ------------------------------------------------------------------------------------ | ---------------------------------------------------------- | | `edges` | \[[RolePermissionEdge](#type-rolepermissionedge)!]! | A list of edges. | | `nodes` | \[[RolePermission](#type-rolepermission)!]! | 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. | *** ### RolePermissionEdge An edge in the RolePermission 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` | [RolePermission](#type-rolepermission)! | The role permission at the end of the edge. | *** ### UserScopeConnection A paginated list of UserScope items. **Implements:** [Connection](/docs/navixy-repository-api/core-api-reference/common.md#type-connection) | Field | Type | Description | | ---------- | ------------------------------------------------------------------------------------ | ---------------------------------------------------------- | | `edges` | \[[UserScopeEdge](#type-userscopeedge)!]! | A list of edges. | | `nodes` | \[[UserScope](#type-userscope)!]! | 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. | *** ### UserScopeEdge An edge in the UserScope 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` | [UserScope](#type-userscope)! | The user scope at the end of the edge. | *** --- # Agent Instructions: 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: ``` GET https://navixy.com/docs/navixy-repository-api/core-api-reference/access-control/types.md?ask= ``` The question should be specific, self-contained, and written in natural language. 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.