GuidesAPI Reference
API Reference

Get external resources available in the realm to the caller.

Get the list of resources that have been made specifically available in the caller's realm via direct Plan, Policy, or ResourcePlan attachments and are accessible to the caller according to the caller's Access Filters.


This will specifically include:

  • Any resource that is accessible in the realm via a Plan attachment to the realm and is an exact match in a permission.
  • Any resource that is accessible in the realm via a Policy attachment to the realm and is an exact match in a permission.
  • Any resource that is accessible in the realm via a ResourcePlan attachment to the realm.


The returned list will ONLY include the above. In addition, it will be further filtered according to the following:

  • If the caller contains NO project scope, the returned list will ONLY include resources accessible to the caller for unscoped access according to the Access Filters associated with the caller.
  • If the caller contains a project scope, the returned list will ONLY include resources accessible to the caller for scoped access according to the Access Filters associated with the caller.
  • The returned list WILL NOT contain resources that are only available via wildcard permissions specified in an attached Plan or Policy on the realm.


Access Control:

  • The calling principal MAY include a project scope.
Query Params
string
required

Only include resources of the requested resource type.

string
required

Only include resources accessible with the requested action via the registered serviceId of the resource's resource type.

string

The cursor for pagination. Present only if there is an additional page of data to view.

integer
0 to 100
Defaults to 100

Number of records to return. Default is 100 records. Maximum is 100 records.

Responses

404

Realm not found

Language
Credentials
Bearer
JWT
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json