Page

Get entities by role requirement page

post

Paginated endpoint returns a page of global entities that have ever used the provided requirement (such as a resource or non-fungible global ID) in their access rules (blueprint authentication templates, owner roles, or role assignments). This endpoint allows querying by a single requirement. By default it returns up to 100 entries are returned per response. This limit can be increased to a maximum of 1000 entries per page using the limit_per_page parameter. To retrieve subsequent pages, use the returned cursor and call the /extensions/entities-by-role-requirement/page endpoint.

To lookup multiple requirements, please call the /extensions/entities-by-role-requirement/lookup 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: {"limit_per_page":100,"resource_address":"<sample-requirement-resource-address>","non_fungible_id":"<sample-requirement-non-fungible-id>"}
Responses
200
List of entities that have ever used the queried requirement in their access rules.
application/json
Responseall of
post
POST /extensions/entities-by-role-requirement/page HTTP/1.1
Host: xrd-gateway.nownodes.io
Content-Type: application/json
Accept: */*
Content-Length: 138

{
  "limit_per_page": 100,
  "resource_address": "<sample-requirement-resource-address>",
  "non_fungible_id": "<sample-requirement-non-fungible-id>"
}
{
  "total_count": 1,
  "next_cursor": "text",
  "entities": [
    {
      "entity_address": "text",
      "first_seen_state_version": 1
    }
  ]
}
PreviousEntities by role requirementNextLookup