Class ScopeClause

java.lang.Object
ai.vectros.types.ScopeClause

public final class ScopeClause extends Object
  • Method Details

    • getAllowedActions

      public List<String> getAllowedActions()
      Returns:
      Verbs this clause grants. Custom verbs are allowed, but a standard catalog is defined: '*' (wildcard), 'read', 'write', 'delete', 'admin:keys', 'admin:profiles', 'logs:r', 'create_own_scoped_key'. Entries may also use the compact 'resource:cruds[:qualifier]' form, e.g. 'documents:cru' or 'records:rs:patient'. The 's' letter in that form grants sensitive-field REVEAL (PHI un-masking) for the given record-type — fail-safe: absent 's', sensitive fields are masked at the response boundary.
    • getDataScope

      public Optional<Map<String,Map<String,Object>>> getDataScope()
      Returns:
      Attribute filters narrowing data this clause applies to. Empty object = applies to ALL data within the tenant. Specific values narrow; include null in an allowed-value list (e.g. {"orgId": ["orgX", null]}) to ALSO grant access to tenant-level records that have no value set for that attribute. Any scopable attribute name is valid as a key.
    • equals

      public boolean equals(Object other)
      Overrides:
      equals in class Object
    • getAdditionalProperties

      public Map<String,Object> getAdditionalProperties()
    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object
    • toString

      public String toString()
      Overrides:
      toString in class Object
    • builder

      public static ScopeClause.Builder builder()