All Known Implementing Classes:
RoleReference.ApiKeyRoleReference, RoleReference.BwcApiKeyRoleReference, RoleReference.CrossClusterAccessRoleReference, RoleReference.CrossClusterApiKeyRoleReference, RoleReference.FixedRoleReference, RoleReference.NamedRoleReference, RoleReference.ServiceAccountRoleReference

public interface RoleReference
RoleReference is a handle to the actual role definitions (role descriptors). It has different sub-types depending on how the role descriptors should be resolved.
  • Method Details

    • id

      RoleKey id()
      Unique ID of the instance. Instances that have equal ID means they are equivalent in terms of authorization. It is currently used as cache key for role caching purpose. Callers can use this value to determine whether it should skip resolving the role descriptors and subsequently building the role.
    • resolve

      void resolve(RoleReferenceResolver resolver, ActionListener<RolesRetrievalResult> listener)
      Resolve concrete role descriptors for the roleReference.