Queries

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.

roles

Lists roles for an organization.

roles(
    organizationId: ID!
    filter: CatalogItemFilter
    first: Int
    after: String
    last: Int
    before: String
    orderBy: CatalogItemOrder = { field: ORDER, direction: ASC }
  ): RoleConnection!

Arguments

Name	Type	Description
organizationId	ID!	The organization to retrieve roles for.
filter	CatalogItemFilter	Filtering options for the returned roles.
first	Int	The first n elements from the paginated list.
after	String	The elements that come after the specified cursor.
last	Int	The last n elements from the paginated list.
before	String	The elements that come before the specified cursor.
orderBy	CatalogItemOrder	The ordering options for the returned roles.

Input types:

CatalogItemFilter

Filtering options for catalog items.

Field	Type	Description
titleContains	String	Partial match on title (case-insensitive contains).
codes	[Code!]	Match any of these codes.

CatalogItemOrder

Ordering options for catalog items.

Field	Type	Description
field	CatalogItemOrderField!	The field to order by.
direction	OrderDirection!	The direction to order.

Output types:

RoleConnection

A paginated list of Role items.

Implements: Connection

Field	Type	Description
edges	[RoleEdge!]!	A list of edges.
nodes	[Role!]!	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.

PageInfo (entity)

Information about the current page in a paginated connection.

Field	Type	Description
hasNextPage	Boolean!	Whether more items exist after the current page.
hasPreviousPage	Boolean!	Whether more items exist before the current page.
startCursor	String	The cursor pointing to the first item in the current page.
endCursor	String	The cursor pointing to the last item in the current page.

---

actorRoles

Lists actor role assignments for an organization.

actorRoles(
    organizationId: ID!
    filter: ActorRoleFilter
    first: Int
    after: String
    last: Int
    before: String
    orderBy: ActorRoleOrder = { field: ASSIGNED_AT, direction: DESC }
  ): ActorRoleConnection!

Arguments

Name	Type	Description
organizationId	ID!	The organization to retrieve actor roles for.
filter	ActorRoleFilter	Filtering options for the returned actor roles.
first	Int	The first n elements from the paginated list.
after	String	The elements that come after the specified cursor.
last	Int	The last n elements from the paginated list.
before	String	The elements that come before the specified cursor.
orderBy	ActorRoleOrder	The ordering options for the returned actor roles.

Input types:

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!	The field to order by.
direction	OrderDirection!	The direction to order.

Output types:

ActorRoleConnection

A paginated list of ActorRole items.

Implements: Connection

Field	Type	Description
edges	[ActorRoleEdge!]!	A list of edges.
nodes	[ActorRole!]!	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.

PageInfo (entity)

Information about the current page in a paginated connection.

Field	Type	Description
hasNextPage	Boolean!	Whether more items exist after the current page.
hasPreviousPage	Boolean!	Whether more items exist before the current page.
startCursor	String	The cursor pointing to the first item in the current page.
endCursor	String	The cursor pointing to the last item in the current page.

---

rolePermissions

Lists role permissions for an organization.

rolePermissions(
    organizationId: ID!
    filter: RolePermissionFilter
    first: Int
    after: String
    last: Int
    before: String
    orderBy: RolePermissionOrder = { field: GRANTED_AT, direction: DESC }
  ): RolePermissionConnection!

Arguments

Name	Type	Description
organizationId	ID!	The organization to retrieve role permissions for.
filter	RolePermissionFilter	Filtering options for the returned role permissions.
first	Int	The first n elements from the paginated list.
after	String	The elements that come after the specified cursor.
last	Int	The last n elements from the paginated list.
before	String	The elements that come before the specified cursor.
orderBy	RolePermissionOrder	The ordering options for the returned role permissions.

Input types:

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!	The field to order by.
direction	OrderDirection!	The direction to order.

Output types:

RolePermissionConnection

A paginated list of RolePermission items.

Implements: Connection

Field	Type	Description
edges	[RolePermissionEdge!]!	A list of edges.
nodes	[RolePermission!]!	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.

PageInfo (entity)

Information about the current page in a paginated connection.

Field	Type	Description
hasNextPage	Boolean!	Whether more items exist after the current page.
hasPreviousPage	Boolean!	Whether more items exist before the current page.
startCursor	String	The cursor pointing to the first item in the current page.
endCursor	String	The cursor pointing to the last item in the current page.

---

userScopes

Lists user scope restrictions for an organization.

userScopes(
    organizationId: ID!
    filter: UserScopeFilter
    first: Int
    after: String
    last: Int
    before: String
    orderBy: UserScopeOrder = { field: ID, direction: ASC }
  ): UserScopeConnection!

Arguments

Name	Type	Description
organizationId	ID!	The organization to retrieve user scopes for.
filter	UserScopeFilter	Filtering options for the returned user scopes.
first	Int	The first n elements from the paginated list.
after	String	The elements that come after the specified cursor.
last	Int	The last n elements from the paginated list.
before	String	The elements that come before the specified cursor.
orderBy	UserScopeOrder	The ordering options for the returned user scopes.

Input types:

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!	The field to order by.
direction	OrderDirection!	The direction to order.

Output types:

UserScopeConnection

A paginated list of UserScope items.

Implements: Connection

Field	Type	Description
edges	[UserScopeEdge!]!	A list of edges.
nodes	[UserScope!]!	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.

PageInfo (entity)

Information about the current page in a paginated connection.

Field	Type	Description
hasNextPage	Boolean!	Whether more items exist after the current page.
hasPreviousPage	Boolean!	Whether more items exist before the current page.
startCursor	String	The cursor pointing to the first item in the current page.
endCursor	String	The cursor pointing to the last item in the current page.

---