Lookup

Get entities by role requirement lookup

post

This endpoint is intended to query for entities that have ever used a given requirement (resource or non-fungible global ID) in their access rules (blueprint authentication templates, owner roles, or role assignments). This endpoint allows querying by multiple requirements. A maximum of 50 requirements can be queried. A maximum of 20 entities per requirement will be returned. To retrieve subsequent pages, use the returned cursor and call the /extensions/entities-by-role-requirement/page endpoint.

Behaviour:

• Entities are returned in ascending order by the state version in which the requirement was first observed on the ledger.
• It may include entities that no longer use the requirement as part of an access rule.
• If no entities are found, an empty list will be returned.

Body

all ofOptionalExample: {"requirements":[{"resource_address":"<sample-requirement-resource-address>","non_fungible_id":"<sample-requirement-non-fungible-id>"}]}

Responses

application/json

objectOptional

application/json

post

HTTPcURLJavaScriptPython

POST /extensions/entities-by-role-requirement/lookup HTTP/1.1
Host: xrd-gateway.nownodes.io
Content-Type: application/json
Accept: */*
Content-Length: 136

{
  "requirements": [
    {
      "resource_address": "<sample-requirement-resource-address>",
      "non_fungible_id": "<sample-requirement-non-fungible-id>"
    }
  ]
}

{
  "items": [
    {
      "total_count": 1,
      "next_cursor": "text",
      "requirement": {
        "resource_address": "text",
        "non_fungible_id": "text"
      },
      "entities": [
        {
          "entity_address": "text",
          "first_seen_state_version": 1
        }
      ]
    }
  ]
}