COconductorone
App Entitlement

Search Graph

Changed on

SearchGraph performs a server-side BFS traversal and returns a bounded, filtered subgraph. Exactly one of user_id, app_id, or resource_id must be set.

post/api/v1/search/graph

Request

  • Base URL
    https://example.conductor.one
  • URL
    https://example.conductor.one/api/v1/search/graph
  • Auth
    HTTP bearer and OAuth 2
    Client credentials
    Token URL: /auth/v1/token

Request body

appIdstring

The appId field.

appIdsstring[] nullable

Filters — all optional, applied at every traversal hop

entitlementIdsstring[] nullable

The entitlementIds field.

entitlementNameQuerystring

The entitlementNameQuery field.

maxDepthinteger

Traversal controls

maxFanOutinteger

Legacy per-parent fan-out limit. Superseded by max_nodes and server-computed per-parent budgets, but still honored for callers that set it.

maxNodesinteger

Overall node budget for the returned subgraph. 0 uses the server default.

pageSizeinteger

Legacy traversal page size. Superseded by max_nodes, but still honored for callers that set it.

pageTokenstring

Legacy pagination token. Superseded by max_nodes-based traversal, but still honored for callers that set it.

resourceIdstring

The resourceId field.

resourceIdsstring[] nullable

The resourceIds field.

resourceNameQuerystring

The resourceNameQuery field.

resourceTypeIdsstring[] nullable

The resourceTypeIds field.

userIdstring

Root entity — exactly one must be set

Response

SearchGraph response. Contains a subgraph of nodes and edges.

hasMoreboolean

The hasMore field.

nodeCeilingHitboolean

True if the server-side node budget stopped the traversal before it finished walking the graph. Distinct from has_more, which can also be set by a request timeout or scan limit.

pageTokenstring

The pageToken field.

pathsReturnedinteger

The pathsReturned field.

truncatedNodeIdsstring[] nullable

The truncatedNodeIds field.

Changes

  • f2cf3228f366Revision changes
    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • breaking

      the request property became not nullable

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status

  • f6e337c979e4Revision changes
    • info

      endpoint added