Package com.inductiveautomation.ignition.common.role

Interface Role

All Known Implementing Classes:
BasicRole
public interface Role
A role is a permission that can be assigned to a user. Roles are used to manage access to resources within the system.

  • Method Summary

    Modifier and Type
    Method
    Description
    String
    getId()
    An opaque identifier that can be used to identify this role.
    String
    getName()
    The name of the role.
    String
    getNotes()
    The notes associated with the role.
    String
    getProfileName()
    The name of the user management profile this role was retrieved from.

  • Method Details

    • getId

      String getId()
      An opaque identifier that can be used to identify this role. Only valid (unique) within the context of the originating user profile

    • getProfileName

      String getProfileName()
      The name of the user management profile this role was retrieved from.

    • getName

      String getName()
      The name of the role.
      Returns:
      The name of the role.

    • getNotes

      String getNotes()
      The notes associated with the role.
      Returns:
      The notes associated with the role.