Skip to main content
POST
SearchGraph

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Authorization
string
header
required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Body

application/json

SearchGraph request. Builds a filtered access graph starting from a root entity. Exactly one of user_id, app_id, or resource_id must be set. Server validates this constraint and returns InvalidArgument if violated.

appId
string

The appId field.

appIds
string[] | null

Filters — all optional, applied at every traversal hop

entitlementIds
string[] | null

The entitlementIds field.

entitlementNameQuery
string

The entitlementNameQuery field.

maxDepth
integer<int32>

Traversal controls

maxFanOut
integer<int32>

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

maxNodes
integer<int32>

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

pageSize
integer<int32>

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

pageToken
string

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

resourceId
string

The resourceId field.

resourceIds
string[] | null

The resourceIds field.

resourceNameQuery
string

The resourceNameQuery field.

resourceTypeIds
string[] | null

The resourceTypeIds field.

userId
string

Root entity — exactly one must be set

Response

200 - application/json

SearchGraph response. Contains a subgraph of nodes and edges.

SearchGraph response. Contains a subgraph of nodes and edges.

edges
Graph Edge · object[] | null

The edges field.

hasMore
boolean

The hasMore field.

nodeCeilingHit
boolean

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.

nodes
Graph Node · object[] | null

The nodes field.

pageToken
string

The pageToken field.

pathsReturned
integer<int32>

The pathsReturned field.

truncatedNodeIds
string[] | null

The truncatedNodeIds field.