Optional
attributesExtra attributes associated with the resource. This is particularly relevant if the policy is ABAC (Attribute-Based Access Control).
Optional
keyThe key of the resource instance, which is the customer-side ID of the resource. Can be used by relationship-based access control policies or by attribute-based access control policies. If no key is provided (i.e: undefined), the authorization query is: Can the user perform the action on any resource of this type? (i.e., all resources in this resource namespace)
Optional
tenantThe tenant under which the resource is defined. The permissions service is multi-tenant by default, so a resource must be associated with a tenant.
The resource type, represents a namespace of resources.
For example, all task
resources are objects under the task
namespace.
Generated using TypeDoc
Respresents a protected resource passed to the permit.check() function. The permit.check() function will check if the user is authorized to access the resource described by this interface, according to the specified check parameters.